Package utility

Class Constants

java.lang.Object
utility.Constants
public final class Constants extends Object
A utility class that holds constant values used throughout the project.

This class provides a centralized location for defining constants, ensuring consistency and reducing the risk of hardcoding values in multiple places. The constants include symbols, sequence types, and other project-specific values. All fields are declared as static final to indicate that they are constants and cannot be modified.

  • Field Details

    • EMPTY

      public static final String EMPTY
      Empty string constant.
      See Also:

    • COLON

      public static final String COLON
      Colon string constant.
      See Also:

    • SEMICOLON

      public static final String SEMICOLON
      Semicolon string constant.
      See Also:

    • COMMA

      public static final String COMMA
      Comma string constant.
      See Also:

    • TAB

      public static final String TAB
      Tabulator string constant.
      See Also:

    • DOT

      public static final String DOT
      Dot string constant.
      See Also:

    • EQUAL

      public static final String EQUAL
      Equals sign string constant.
      See Also:

    • SIGN

      public static final String SIGN
      Number sign string constant.
      See Also:

    • PIPE

      public static final String PIPE
      Pipe string constant.
      See Also:

    • anyNucleotide

      public static final String anyNucleotide
      Represents the nucleotide used to denote any base in a sequence.

      This constant is used in scenarios where a specific nucleotide cannot be determined and is represented by the character 'N'.

      See Also:

    • stopCodon

      public static final String stopCodon
      Represents the stop codon in a sequence.

      This constant is used to denote the stop codon, which is represented by the character '*'. The stop codon signals the termination of translation in a nucleotide sequence.

      See Also:

    • lowCoverageCallPrefix

      public static final String lowCoverageCallPrefix
      Prefix used to indicate low coverage variant calls.

      This constant is used to mark variant calls with insufficient read depth, represented by the prefix 'x'.

      See Also:

    • lowFrequencyCallPrefix

      public static final String lowFrequencyCallPrefix
      Prefix used to indicate low frequency variant calls.

      This constant is used to mark variant calls with low allele frequency, represented by the prefix 'f'.

      See Also:

    • gapString

      public static final String gapString
      String representation of a gap in a sequence.
      See Also:

    • gapChar

      public static final char gapChar
      Character representation of a gap in a sequence.
      See Also:

    • synonymous

      public static final String synonymous
      Represents the term used for synonymous Feature.Alleles that are not actually stored.
      See Also:

    • $Contig_length

      public static final String $Contig_length
      Key used to represent the length of a contig.
      See Also:

    • $Attributable_samplesOccurrence

      public static final String $Attributable_samplesOccurrence
      Key used to represent the occurrence of samples in classes that extend Attributable.
      See Also:

    • $Feature_children

      public static final String $Feature_children
      Key used to represent the children of a feature.
      See Also:

    • $SequenceType_effects

      public static final String $SequenceType_effects
      Key used to represent the effects of a SequenceType.

      This constant is used as a key in

      • Feature.Allele data structures to store or retrieve the effects associated with a specific allele, i.e., all distinct snpeff_effect values of VariantInformation instances associated with the object.
      • Feature.Proteoform data structures to store or retrieve the effects derived in the constructor of the class.
      See Also:

    • $SequenceType_sequenceLengthVariation

      public static final String $SequenceType_sequenceLengthVariation
      Key used to represent the net shift in sequence length of a sequence type.

      This constant is used as a key in data structures to store or retrieve the net shift value associated with a specific sequence type. The net shift typically represents the cumulative effect of insertions and deletions on the sequence length.

      See Also:

    • $Allele_proteoform

      public static final String $Allele_proteoform
      Key used to represent the proteoform of an allele.
      See Also:

    • lineSeparator

      public static final String lineSeparator
      The system-dependent line separator string.

    • baseSymbols

      public static final String baseSymbols
      The base symbols of the IUPAC nucleotide and amino acid code.
      See Also:

    • snpEffAttributeKeyPrefix

      public static final String snpEffAttributeKeyPrefix
      Prefix for SnpEff attribute keys.
      See Also:

    • snpEffKeys

      public static final ArrayList<String> snpEffKeys
      SnpEff annotation field names.

  • Constructor Details

    • Constants

      public Constants()