org.biopax.paxtools.model.level3

Interface RelationshipXref

All Superinterfaces:

BioPAXElement, Cloneable, Level3Element, Serializable, UtilityClass, Xref

All Known Implementing Classes:

RelationshipXrefImpl

public interface RelationshipXref
extends Xref

Definition: An xref that defines a reference to an entity in an external resource that does not have the same biological identity as the referring entity. Usage: There is currently no controlled vocabulary of relationship types for BioPAX, although one will be created in the future if a need develops. Examples: A link between a gene G in a BioPAX data collection, and the protein product P of that gene in an external database. This is not a unification xref because G and P are different biological entities (one is a gene and one is a protein). Another example is a relationship xref for a protein that refers to the Gene Ontology biological process, e.g. 'immune response,' that the protein is involved in.

Field Summary

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

UNKNOWN_DOUBLE, UNKNOWN_FLOAT, UNKNOWN_INT

Method Summary

Modifier and Type	Method and Description
RelationshipTypeVocabulary	getRelationshipType() Definition:A controlled vocabulary term that defines the type of relationship that this xref defines.
void	setRelationshipType(RelationshipTypeVocabulary relationshipType) Definition:A controlled vocabulary term that defines the type of relationship that this xref defines.

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

getDb, getDbVersion, getId, getIdVersion, getXrefOf, setDb, setDbVersion, setId, setIdVersion

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

addComment, getComment, removeComment

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

equivalenceCode, getAnnotations, getModelInterface, getRDFId, isEquivalent

Method Detail

getRelationshipType

RelationshipTypeVocabulary getRelationshipType()

Definition:A controlled vocabulary term that defines the type of relationship that this xref defines. Usage: There is currently no controlled vocabulary of relationship types for BioPAX, although one will be created in the future as the usage of this property increases.

Returns:

The type of relationship

setRelationshipType

void setRelationshipType(RelationshipTypeVocabulary relationshipType)

Definition:A controlled vocabulary term that defines the type of relationship that this xref defines. Usage: There is currently no controlled vocabulary of relationship types for BioPAX, although one will be created in the future as the usage of this property increases.

Parameters:

relationshipType - The type of relationship that this xref defines