org.biopax.paxtools.impl.level3
Class ChemicalStructureImpl

java.lang.Object
  org.biopax.paxtools.impl.BioPAXElementImpl
      org.biopax.paxtools.impl.level3.L3ElementImpl
          org.biopax.paxtools.impl.level3.ChemicalStructureImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, BioPAXElement, ChemicalStructure, Level3Element, UtilityClass

@Entity
@Indexed
public class ChemicalStructureImpl
extends L3ElementImpl
implements ChemicalStructure

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.biopax.paxtools.model.BioPAXElement

BioPAXElement.Key

Field Summary

Fields inherited from class org.biopax.paxtools.impl.BioPAXElementImpl

SEARCH_FIELD_AVAILABILITY, SEARCH_FIELD_COMMENT, SEARCH_FIELD_EC_NUMBER, SEARCH_FIELD_KEYWORD, SEARCH_FIELD_NAME, SEARCH_FIELD_SEQUENCE, SEARCH_FIELD_TERM, SEARCH_FIELD_XREF_DB, SEARCH_FIELD_XREF_ID, SEARCH_INDEX_NAME

Fields inherited from interface org.biopax.paxtools.model.BioPAXElement

UNKNOWN_DOUBLE, UNKNOWN_FLOAT, UNKNOWN_INT

Constructor Summary

ChemicalStructureImpl()

Method Summary

int	equivalenceCode() If two elements are equivalent, then their equivalence code should be the same.
java.lang.Class<? extends ChemicalStructure>	getModelInterface() This method returns the actual model interface that a class implements.
java.lang.String	getStructureData() This property holds a string defining chemical structure,in one of the three formats: CML, SMILES or InChI.
StructureFormatType	getStructureFormat() This property specifies which format is used to define chemical structure.
protected boolean	semanticallyEquivalent(BioPAXElement element)
void	setStructureData(java.lang.String structureData) This property holds a string of data defining chemical structure,in one of the three formats: CML, SMILES or InChI.
void	setStructureFormat(StructureFormatType structureFormat) This property specifies which format is used to define chemical structure.

Methods inherited from class org.biopax.paxtools.impl.level3.L3ElementImpl

addComment, getComment, removeComment, setComment

Methods inherited from class org.biopax.paxtools.impl.BioPAXElementImpl

getAnnotations, getProxyId, getRDFId, getVersion, isEquivalent, setProxyId, setRDFId, setVersion, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.biopax.paxtools.model.level3.Level3Element

addComment, getComment, removeComment

Methods inherited from interface org.biopax.paxtools.model.BioPAXElement

getAnnotations, getRDFId, isEquivalent

Constructor Detail

ChemicalStructureImpl

public ChemicalStructureImpl()

Method Detail

getModelInterface

public java.lang.Class<? extends ChemicalStructure> getModelInterface()

Description copied from interface: BioPAXElement

This method returns the actual model interface that a class implements.

Specified by:

getModelInterface in interface BioPAXElement

Returns:

an interface from org.biopax.paxtools.model package corresponding to a BioPAX class.

semanticallyEquivalent

protected boolean semanticallyEquivalent(BioPAXElement element)

Overrides:

semanticallyEquivalent in class BioPAXElementImpl

equivalenceCode

public int equivalenceCode()

Description copied from interface: BioPAXElement

If two elements are equivalent, then their equivalence code should be the same.

Specified by:

equivalenceCode in interface BioPAXElement

Overrides:

equivalenceCode in class BioPAXElementImpl

Returns:

an integer that is same across all equivalent entities.

getStructureData

public java.lang.String getStructureData()

Description copied from interface: ChemicalStructure

This property holds a string defining chemical structure,in one of the three formats: CML, SMILES or InChI. If, for example,the CML format is used, then the value of this property is a string containing the XML encoding of the CML data.

Specified by:

getStructureData in interface ChemicalStructure

Returns:

a string defining chemical structure

setStructureData

public void setStructureData(java.lang.String structureData)

Description copied from interface: ChemicalStructure

This property holds a string of data defining chemical structure,in one of the three formats: CML, SMILES or InChI. If, for example,the CML format is used, then the value of this property is a string containing the XML encoding of the CML data.

Specified by:

setStructureData in interface ChemicalStructure

Parameters:

structureData - a string defining chemical structure

getStructureFormat

@Field(name="keyword",
       index=TOKENIZED)
public StructureFormatType getStructureFormat()

Description copied from interface: ChemicalStructure

This property specifies which format is used to define chemical structure.

Specified by:

getStructureFormat in interface ChemicalStructure

Returns:

format used to define chemical structure

setStructureFormat

public void setStructureFormat(StructureFormatType structureFormat)

Description copied from interface: ChemicalStructure

This property specifies which format is used to define chemical structure.

Specified by:

setStructureFormat in interface ChemicalStructure

Parameters:

structureFormat - format used to define chemical structure