Interface SimilarityPairFeature
- All Superinterfaces:
Annotatable,Changeable,Feature,FeatureHolder,StrandedFeature
- All Known Implementing Classes:
SimpleSimilarityPairFeature
SimilarityPairFeature describes a pairwise
similarity between two nucleotide sequences (as it extends
StrandedFeature). It is analagous to, and based on,
the BioPerl Bio::SeqFeature::SimilarityPair.
It is different from HomologyFeature in that it
expresses a relationship between only two sequence regions (rather
than >= 2), with one clearly defined as the query sequence and the
other as the subject (database hit). These are identified by
constant labels in the
Alignment. HomologyFeature identifies the
related sequence regions by means of an Homology
instance which contains an Alignment which uses the
HomologyFeatures themselves as labels.
In cases where there is no alignment available, for example when
MSPCrunch output or GFF have been used, the
EmptyPairwiseAlignment in the EMPTY_PAIRWISE field may
be used. This may also be useful if an implementation elides the
alignment data for some reason.
- Since:
- 1.2
- Author:
- Keith James
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classEmptyPairwiseAlignmentempty pairwise alignment which has labels to empty symbol lists.static classTemplatefor construction ofSimilarityPairFeatures.Nested classes/interfaces inherited from interface org.biojava.bio.Annotatable
Annotatable.AnnotationForwarderNested classes/interfaces inherited from interface org.biojava.bio.seq.Feature
Feature.ByLocationComparatorNested classes/interfaces inherited from interface org.biojava.bio.seq.FeatureHolder
FeatureHolder.EmptyFeatureHolderNested classes/interfaces inherited from interface org.biojava.bio.seq.StrandedFeature
StrandedFeature.Strand -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final AlignmentConstantEMPTY_PAIRWISEis an empty alignment for situations where there is no available alignment data or the implementation does not want to create one.static final StringConstantQUERY_LABELis the alignment label used for all query sequences.static final ChangeTypeThe sibling of this feature has altered.static final StringConstantSUBJECT_LABELis the alignment label used for all subject sequences.Fields inherited from interface org.biojava.bio.Annotatable
ANNOTATIONFields inherited from interface org.biojava.bio.seq.Feature
byLocationOrder, LOCATION, PROPERTY_DATA_KEY, SOURCE, SOURCETERM, TYPE, TYPETERMFields inherited from interface org.biojava.bio.seq.FeatureHolder
EMPTY_FEATURE_HOLDER, FEATURES, SCHEMAFields inherited from interface org.biojava.bio.seq.StrandedFeature
NEGATIVE, POSITIVE, STRAND, UNKNOWN -
Method Summary
Modifier and TypeMethodDescriptiongetAlignmentreturns theAlignmentof two similar features.doublegetScore()getScorereturns the alignment score.getSiblingreturns the siblingFeature, query for subject and vice versa.voidsetSibling(SimilarityPairFeature sibling) setSiblingsets the sibling feature of the pair.Methods inherited from interface org.biojava.bio.Annotatable
getAnnotationMethods inherited from interface org.biojava.utils.Changeable
addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListenerMethods inherited from interface org.biojava.bio.seq.Feature
features, getLocation, getParent, getSequence, getSource, getSourceTerm, getType, getTypeTerm, makeTemplate, setLocation, setSource, setSourceTerm, setType, setTypeTermMethods inherited from interface org.biojava.bio.seq.FeatureHolder
containsFeature, countFeatures, createFeature, filter, filter, getSchema, removeFeatureMethods inherited from interface org.biojava.bio.seq.StrandedFeature
getStrand, getSymbols, setStrand
-
Field Details
-
SIBLING
The sibling of this feature has altered. -
QUERY_LABEL
ConstantQUERY_LABELis the alignment label used for all query sequences.- See Also:
-
SUBJECT_LABEL
ConstantSUBJECT_LABELis the alignment label used for all subject sequences.- See Also:
-
EMPTY_PAIRWISE
ConstantEMPTY_PAIRWISEis an empty alignment for situations where there is no available alignment data or the implementation does not want to create one.
-
-
Method Details
-
getSibling
getSiblingreturns the siblingFeature, query for subject and vice versa.- Returns:
- a
Feature.
-
setSibling
setSiblingsets the sibling feature of the pair. This is used to set the reciprocalSimilarityPairFeatureas both cannot be set using theTemplate.- Throws:
ChangeVetoException
-
getAlignment
getAlignmentreturns theAlignmentof two similar features.- Returns:
- an
Alignmentvalue.
-
getScore
double getScore()getScorereturns the alignment score.- Returns:
- a
double.
-