RbDe rbde-349 (20120127151154)

edu.mssm.crover.representation
Interface BiologicalAnnotation

All Superinterfaces:
Serializable
All Known Implementing Classes:
Annotation, Color_Annotation, Disulfide_Annotation, Domain_Annotation, Domain2D_Annotation, Extended_ColorAnnotation, ExtendedSS_Annotation, ResidueAnnotation, SecondaryStructure_Annotation, SequenceOrigin_Annotation, ShapeAnnotation, Spacer_Annotation, TM_Annotation, TmDomain_Annotation, URL_Annotation

public interface BiologicalAnnotation
extends Serializable

Represents a single annotation. Single annotations are intended to be inserted in a BiologicalAnnotations.

Author:
Fabien Campagne
See Also:
BiologicalAnnotations

Method Summary
 boolean describesResidue(int position)
          Returns whether the position is described by this annotation.
 String getInfo()
          Returns a concise string of text that describes the nature of this annotation.
 BiologicalOrigin getOrigin()
          Obtain the origin of this annotation.
 void setOrigin(BiologicalOrigin x)
          Sets the origin of this annotation.
 

Method Detail

getOrigin

BiologicalOrigin getOrigin()
Obtain the origin of this annotation.

Returns:
the origin of this annotation

setOrigin

void setOrigin(BiologicalOrigin x)
Sets the origin of this annotation.

Parameters:
x - the origin that is to be referenced by this annotation.

getInfo

String getInfo()
Returns a concise string of text that describes the nature of this annotation. This text is constant over several instances of the same class.

Returns:
a string description of the annotation.

describesResidue

boolean describesResidue(int position)
Returns whether the position is described by this annotation.

Parameters:
position - The position to test
Returns:
true when the annotation is pertinent for this residue, false otherwise.

RbDe rbde-349 (20120127151154)

Copyright © 2003-2012 Institute for Computational Biomedicine, All Rights Reserved.