Package org.forester.phylogeny.data
Class SequenceRelation
- java.lang.Object
-
- org.forester.phylogeny.data.SequenceRelation
-
- All Implemented Interfaces:
PhylogenyData
public class SequenceRelation extends java.lang.Object implements PhylogenyData
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSequenceRelation.SEQUENCE_RELATION_TYPE
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringSEQUENCE_RELATION_TYPE_ONE_TO_ONE_ORTHOLOGYstatic java.lang.StringSEQUENCE_RELATION_TYPE_ORTHOLOGYstatic java.lang.StringSEQUENCE_RELATION_TYPE_OTHERstatic java.lang.StringSEQUENCE_RELATION_TYPE_PARALOGYstatic java.lang.StringSEQUENCE_RELATION_TYPE_SUPER_ORTHOLOGYstatic java.lang.StringSEQUENCE_RELATION_TYPE_ULTRA_PARALOGYstatic java.lang.StringSEQUENCE_RELATION_TYPE_UNKNOWNstatic java.lang.StringSEQUENCE_RELATION_TYPE_XENOLOGYstatic java.util.Map<SequenceRelation.SEQUENCE_RELATION_TYPE,java.lang.String>typesToNames
-
Constructor Summary
Constructors Constructor Description SequenceRelation()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringBufferasSimpleText()java.lang.StringBufferasText()PhylogenyDatacopy()Creates a new PhylogenyData object with identical values as this PhylogenyData.ConfidencegetConfidence()java.lang.DoublegetDistance()static java.lang.StringgetPrintableNameByType(SequenceRelation.SEQUENCE_RELATION_TYPE type)SequencegetRef0()SequencegetRef1()SequenceRelation.SEQUENCE_RELATION_TYPEgetType()booleanisEqual(PhylogenyData data)Compares this PhylogenyData to PhylogenyData data.voidsetConfidence(Confidence confidence)voidsetDistance(java.lang.Double distance)voidsetRef0(Sequence ref0)voidsetRef1(Sequence ref1)voidsetType(SequenceRelation.SEQUENCE_RELATION_TYPE type)java.lang.StringBuffertoNHX()voidtoPhyloXML(java.io.Writer writer, int level, java.lang.String indentation)Writes a phyloXML representation of this phylogeny data.
-
-
-
Field Detail
-
typesToNames
public static final java.util.Map<SequenceRelation.SEQUENCE_RELATION_TYPE,java.lang.String> typesToNames
-
SEQUENCE_RELATION_TYPE_ORTHOLOGY
public static final java.lang.String SEQUENCE_RELATION_TYPE_ORTHOLOGY
- See Also:
- Constant Field Values
-
SEQUENCE_RELATION_TYPE_ONE_TO_ONE_ORTHOLOGY
public static final java.lang.String SEQUENCE_RELATION_TYPE_ONE_TO_ONE_ORTHOLOGY
- See Also:
- Constant Field Values
-
SEQUENCE_RELATION_TYPE_SUPER_ORTHOLOGY
public static final java.lang.String SEQUENCE_RELATION_TYPE_SUPER_ORTHOLOGY
- See Also:
- Constant Field Values
-
SEQUENCE_RELATION_TYPE_PARALOGY
public static final java.lang.String SEQUENCE_RELATION_TYPE_PARALOGY
- See Also:
- Constant Field Values
-
SEQUENCE_RELATION_TYPE_ULTRA_PARALOGY
public static final java.lang.String SEQUENCE_RELATION_TYPE_ULTRA_PARALOGY
- See Also:
- Constant Field Values
-
SEQUENCE_RELATION_TYPE_XENOLOGY
public static final java.lang.String SEQUENCE_RELATION_TYPE_XENOLOGY
- See Also:
- Constant Field Values
-
SEQUENCE_RELATION_TYPE_UNKNOWN
public static final java.lang.String SEQUENCE_RELATION_TYPE_UNKNOWN
- See Also:
- Constant Field Values
-
SEQUENCE_RELATION_TYPE_OTHER
public static final java.lang.String SEQUENCE_RELATION_TYPE_OTHER
- See Also:
- Constant Field Values
-
-
Method Detail
-
asSimpleText
public java.lang.StringBuffer asSimpleText()
- Specified by:
asSimpleTextin interfacePhylogenyData
-
asText
public java.lang.StringBuffer asText()
- Specified by:
asTextin interfacePhylogenyData
-
copy
public PhylogenyData copy()
Description copied from interface:PhylogenyDataCreates a new PhylogenyData object with identical values as this PhylogenyData. This ~should~ return a deep copy, but not there yet.- Specified by:
copyin interfacePhylogenyData- Returns:
- a ~deep~ copy of this PhylogenyData
-
getConfidence
public Confidence getConfidence()
-
getDistance
public java.lang.Double getDistance()
-
getRef0
public Sequence getRef0()
-
getRef1
public Sequence getRef1()
-
getType
public SequenceRelation.SEQUENCE_RELATION_TYPE getType()
-
isEqual
public boolean isEqual(PhylogenyData data)
Description copied from interface:PhylogenyDataCompares this PhylogenyData to PhylogenyData data. In general, this should return true if and only if all fiels are exactly identical.- Specified by:
isEqualin interfacePhylogenyData- Returns:
- in general, true if and only if all fiels are exactly identical, false otherwise
-
setConfidence
public void setConfidence(Confidence confidence)
-
setDistance
public void setDistance(java.lang.Double distance)
-
setRef0
public void setRef0(Sequence ref0)
-
setRef1
public void setRef1(Sequence ref1)
-
setType
public void setType(SequenceRelation.SEQUENCE_RELATION_TYPE type)
-
toNHX
public java.lang.StringBuffer toNHX()
- Specified by:
toNHXin interfacePhylogenyData
-
toPhyloXML
public void toPhyloXML(java.io.Writer writer, int level, java.lang.String indentation) throws java.io.IOExceptionDescription copied from interface:PhylogenyDataWrites a phyloXML representation of this phylogeny data.- Specified by:
toPhyloXMLin interfacePhylogenyData- Throws:
java.io.IOException
-
getPrintableNameByType
public static java.lang.String getPrintableNameByType(SequenceRelation.SEQUENCE_RELATION_TYPE type)
-
-