public final class SequenceAnnotationQualifier extends Object
SequenceAnnotation.
In the sequence viewer, this information is shown in the box that pops up when the mouse hovers
over the annotation.
Instances of this class are immutable and may therefore freely be shared without making defensive copies.| Modifier and Type | Field and Description |
|---|---|
static String |
COLOR
Qualifier name used to override the color of an individual annotation.
|
static String |
DIFFERENTIAL_EXPRESSION_ABSOLUTE_CONFIDENCE_QUALIFIER
Qualifier name for differential expression absolute confidence
|
static String |
DIFFERENTIAL_EXPRESSION_CONFIDENCE_QUALIFIER
Qualifier name for differential expression confidence
|
static String |
DIFFERENTIAL_EXPRESSION_LOG2_RATIO_QUALIFIER
Qualifier name for differential expression expression log base 2 ratio
|
static String |
DIFFERENTIAL_EXPRESSION_P_VALUE
Qualifier name for differential expression p-value
|
static String |
DIFFERENTIAL_EXPRESSION_RATIO_QUALIFIER
Qualifier name for differential expression expression ratio
|
static String |
EDITING_HISTORY_ORIGINAL_BASES
Record the bases that were originally in the location covered by an annotation
of type
SequenceAnnotation.TYPE_EDITING_HISTORY_DELETION,
SequenceAnnotation.TYPE_EDITING_HISTORY_INSERTION or
SequenceAnnotation.TYPE_EDITING_HISTORY_REPLACEMENT. |
static String |
EXPRESSION_FPKM
Qualifier name for expression FPKM (fragments per kilobase million)
|
static String |
EXPRESSION_RAW_FRAGMENT_COUNT
Qualifier name for expression raw fragment count
|
static String |
EXPRESSION_RAW_READ_COUNT
Qualifier name for expression raw read count
|
static String |
EXPRESSION_RAW_TRANSCRIPT_COUNT
Qualifier name for expression raw transcript count
|
static String |
EXPRESSION_RPKM
Qualifier name for expression RPKM (reads per kilobase million)
|
static String |
EXPRESSION_TPM
Qualifier name for expression TPM (transcripts per million)
|
static String |
EXTRACTED_REGION_INTERVALS_NAME
Name to use for a SequenceAnnotationQualifier to specify that the SequenceAnnotation represents an extraction (annotations of type
SequenceAnnotation.TYPE_EXTRACTED_REGION
The value of the qualifier is parsable using SequenceAnnotationInterval.SequenceAnnotationInterval(String). |
static String |
EXTRACTED_REGION_ORIGINAL_CIRCULAR_SEQUENCE_LENGTH
Name to use for a SequenceAnnotationQualifier to specify that the SequenceAnnotation represents an extraction (annotations of type
SequenceAnnotation.TYPE_EXTRACTED_REGION from a circular sequence,
in which case, this qualifier contains the length of the original circular sequence. |
static String |
GENETIC_CODE_NAME
Name to use for SequenceAnnotationQualifiers that specify a genetic code
|
static String |
HIDDEN_PREFIX
Qualifiers that have a name that begins with this prefix will be hidden from the user interface
|
static String |
HIDDEN_QUALIFIER_FOR_ACTIVELY_LINKED_PARENTS
The name of a qualifier that can be added to annotations on documents which are actively linked to their descendants (see
OperationRecordDocument.hasAnyActiveLinks()). |
static String |
NCBI_CODON_START
Qualifier name used by NCBI for the frame of a CDS (may be 1, 2 or 3).
|
static String |
NCBI_TRANSL_TABLE
Qualifier name used by NCBI for the translation table number of a CDS
|
static String |
RECOGNITION_PATTERN
Name to use for SequenceAnnotationQualifiers that specify the recognition pattern of a restriction enzyme.
|
static String |
REFERENCED_DOCUMENT_LABEL_PREFIX
If a qualifier starts with either
WEAK_REFERENCED_DOCUMENT_PREFIX or STRONG_REFERENCED_DOCUMENT_PREFIX then in may optionally contain a label to display to the user assoicated with the link by appending
this suffix after the URN of the document followed by the text to display to the user. |
static String |
STRONG_REFERENCED_DOCUMENT_PREFIX
If a qualifier value starts with this prefix, and the remainder of the qualifier value is a
URN.toString() of a document, then it is assumed to be a strong reference to that document. |
static String |
TRANSLATED_REGION_INTERVALS_NAME
Name to use for a SequenceAnnotationQualifier to specify that the SequenceAnnotation represents a translation.
|
static String |
VARIANT_AMINO_ACIDS
Qualifier used to represent how a
SequenceAnnotation.TYPE_POLYMORPHISM has changed from its original value. |
static String |
VARIANT_CHANGE
Qualifier used to represent how a
SequenceAnnotation.TYPE_POLYMORPHISM has changed from its original value. |
static String |
VARIANT_CHANGE_ARROW
Used to represent the separating arrow between the original and variant sequence for a
VARIANT_CHANGE qualifier. |
static String |
VARIANT_ID
Qualifier used to represent the database ID of a variant (for example the value may be a dbSNP ID of the form rs1234).
|
static String |
VARIANT_NUCLEOTIDES
Qualifier used to represent how a
SequenceAnnotation.TYPE_POLYMORPHISM has changed from its original value. |
static String |
VARIANT_REFERENCE_NUCLEOTIDES
Qualifier used to represent what the reference sequence was over the interval covered by the annotation
|
static String |
WEAK_REFERENCED_DOCUMENT_PREFIX
If a qualifier value starts with this prefix, and the remainder of the qualifier value is a
URN.toString() of a document, then it is assumed to be a weak reference to that document. |
| Constructor and Description |
|---|
SequenceAnnotationQualifier(SequenceAnnotationQualifier qualifier)
creates a copy of the given SequenceAnnotationQualifier.
|
SequenceAnnotationQualifier(String name,
String value)
create a new SequenceAnnotationQualifier
|
SequenceAnnotationQualifier(String name,
URN urn,
boolean strong,
String label)
create a new SequenceAnnotationQualifier which contains a reference to another document.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
String |
getDisplayedValue(boolean allowHtml)
Returns the value with html tags stripped or angle brackets escaped depending on whether html is allowed.
|
String |
getName()
Get the name of this qualifier.
|
String |
getValue()
Get the value of this qualifier.
|
int |
hashCode() |
boolean |
isHidden()
Returns true if this qualifier is hidden from the user interface.
|
boolean |
isValueHtml()
Scans through the string to check if there appears to be valid angle brackets in it (an equal number, in the
right order).
|
String |
toString()
Returns a human readable string with information about this qualifier;
the exact format of the string is not guaranteed and should not be relied
on, because it may change at any time.
|
public static final String GENETIC_CODE_NAME
public static final String EXTRACTED_REGION_INTERVALS_NAME
SequenceAnnotation.TYPE_EXTRACTED_REGION
The value of the qualifier is parsable using SequenceAnnotationInterval.SequenceAnnotationInterval(String).public static final String EXTRACTED_REGION_ORIGINAL_CIRCULAR_SEQUENCE_LENGTH
SequenceAnnotation.TYPE_EXTRACTED_REGION from a circular sequence,
in which case, this qualifier contains the length of the original circular sequence.public static final String TRANSLATED_REGION_INTERVALS_NAME
public static final String RECOGNITION_PATTERN
public static final String EDITING_HISTORY_ORIGINAL_BASES
SequenceAnnotation.TYPE_EDITING_HISTORY_DELETION,
SequenceAnnotation.TYPE_EDITING_HISTORY_INSERTION or
SequenceAnnotation.TYPE_EDITING_HISTORY_REPLACEMENT. .public static final String NCBI_TRANSL_TABLE
public static final String NCBI_CODON_START
SequenceAnnotation.getCodonStart(),
Constant Field Valuespublic static final String VARIANT_ID
getDisplayedValue(boolean) may hyperlink to the appropriate databasepublic static final String VARIANT_CHANGE
SequenceAnnotation.TYPE_POLYMORPHISM has changed from its original value. public static final String VARIANT_CHANGE_ARROW
VARIANT_CHANGE qualifier.public static final String VARIANT_NUCLEOTIDES
SequenceAnnotation.TYPE_POLYMORPHISM has changed from its original value.public static final String VARIANT_AMINO_ACIDS
SequenceAnnotation.TYPE_POLYMORPHISM has changed from its original value.public static final String VARIANT_REFERENCE_NUCLEOTIDES
public static final String COLOR
public static final String HIDDEN_PREFIX
public static final String HIDDEN_QUALIFIER_FOR_ACTIVELY_LINKED_PARENTS
OperationRecordDocument.hasAnyActiveLinks()).
When a document containing an annotation with this qualifier is regenerated because its parent has changed, then despite all other data on the document being discarded, if this annotation (or an annotation unambiguously
identified as the same annotation) still exists on the new version of the document, then this qualifier will be copied to that new annotation.
Qualifiers of this type will be hidden from the user interface. They are intended for programatic use only.SequenceAnnotation.HIDDEN_TYPE_FOR_ACTIVELY_LINKED_PARENTS,
Constant Field Valuespublic static final String WEAK_REFERENCED_DOCUMENT_PREFIX
URN.toString() of a document, then it is assumed to be a weak reference to that document.
a weak reference means that if the referenced document is deleted, the link will remain, referring to a document that no longer exists.
To specify the name of the link as displayed to the user, use REFERENCED_DOCUMENT_LABEL_PREFIXSTRONG_REFERENCED_DOCUMENT_PREFIX,
REFERENCED_DOCUMENT_LABEL_PREFIX,
Constant Field Valuespublic static final String STRONG_REFERENCED_DOCUMENT_PREFIX
URN.toString() of a document, then it is assumed to be a strong reference to that document.
a strong reference means that if the referenced document is deleted, the document will not really be deleted but be kept in a hidden area of the database and will always be available as long as
the referencing document still exists. Similarly, exporting a document (in Geneious format) with a strong refernece will export the referenced document with it.
To specify the name of the link as displayed to the user, use REFERENCED_DOCUMENT_LABEL_PREFIXWEAK_REFERENCED_DOCUMENT_PREFIX,
REFERENCED_DOCUMENT_LABEL_PREFIX,
Constant Field Valuespublic static final String REFERENCED_DOCUMENT_LABEL_PREFIX
WEAK_REFERENCED_DOCUMENT_PREFIX or STRONG_REFERENCED_DOCUMENT_PREFIX then in may optionally contain a label to display to the user assoicated with the link by appending
this suffix after the URN of the document followed by the text to display to the user. For example STRONG_REFERENCED_DOCUMENT_PREFIX+urn.toString()+ REFERENCED_DOCUMENT_LABEL_PREFIX+"Forward Primer"STRONG_REFERENCED_DOCUMENT_PREFIX,
WEAK_REFERENCED_DOCUMENT_PREFIX,
Constant Field Valuespublic static final String DIFFERENTIAL_EXPRESSION_P_VALUE
public static final String DIFFERENTIAL_EXPRESSION_ABSOLUTE_CONFIDENCE_QUALIFIER
public static final String DIFFERENTIAL_EXPRESSION_CONFIDENCE_QUALIFIER
public static final String DIFFERENTIAL_EXPRESSION_RATIO_QUALIFIER
public static final String DIFFERENTIAL_EXPRESSION_LOG2_RATIO_QUALIFIER
public static final String EXPRESSION_RPKM
public static final String EXPRESSION_FPKM
public static final String EXPRESSION_TPM
public static final String EXPRESSION_RAW_READ_COUNT
public static final String EXPRESSION_RAW_FRAGMENT_COUNT
public static final String EXPRESSION_RAW_TRANSCRIPT_COUNT
public SequenceAnnotationQualifier(String name, String value)
name - the name of the qualifier; must not be null, but may be ""value - the value of the qualifier; must not be null, but may be ""IllegalArgumentException - if name or value is nullpublic SequenceAnnotationQualifier(SequenceAnnotationQualifier qualifier)
qualifier - the qualifier to copypublic SequenceAnnotationQualifier(String name, URN urn, boolean strong, String label)
name - the name of the qualifier; must not be null, but may be ""urn - the URN of the document this qualifier links to; must not be nullstrong - whether this is a strong link rather than a weak link. See WEAK_REFERENCED_DOCUMENT_PREFIX and STRONG_REFERENCED_DOCUMENT_PREFIXlabel - the label for the link. May be null. See REFERENCED_DOCUMENT_LABEL_PREFIXIllegalArgumentException - if name or urn is nullWEAK_REFERENCED_DOCUMENT_PREFIX,
STRONG_REFERENCED_DOCUMENT_PREFIX,
REFERENCED_DOCUMENT_LABEL_PREFIXpublic String toString()
public String getName()
public String getValue()
public boolean isHidden()
HIDDEN_PREFIXHIDDEN_PREFIXpublic String getDisplayedValue(boolean allowHtml)
getValue() starts with STRONG_REFERENCED_DOCUMENT_PREFIX or WEAK_REFERENCED_DOCUMENT_PREFIX.
If allowHtml is true and the qualifier is called db_xref then its value may also be hyperlinked to the appropriate database websiteallowHtml - true to allow the value to be formatted as html.isValueHtml()public boolean isValueHtml()
getDisplayedValue(boolean)