org.sbml.jsbml

Enum CVTerm.Qualifier

java.lang.Object

java.lang.Enum<CVTerm.Qualifier>

org.sbml.jsbml.CVTerm.Qualifier

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CVTerm.Qualifier>

Enclosing class:

CVTerm

public static enum CVTerm.Qualifier
extends java.lang.Enum<CVTerm.Qualifier>

This enum list all the possible MIRIAM qualifiers.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BQB_ENCODES Represents the MIRIAM biological qualifier 'encodes': the biological entity represented by the model element encodes, directly or transitively, the subject of the referenced resource (biological entity B).
BQB_HAS_PART Represents the MIRIAM biological qualifier 'hasPart': the biological entity represented by the model element includes the subject of the referenced resource (biological entity B), either physically or logically.
BQB_HAS_PROPERTY Represents the MIRIAM biological qualifier 'hasProperty': the subject of the referenced resource (biological entity B) is a property of the biological entity represented by the model element.
BQB_HAS_TAXON Represents the MIRIAM biological qualifier 'hasTaxon': the biological entity represented by the model element is taxonomically restricted, where the restriction is the subject of the referenced resource (biological entity B).
BQB_HAS_VERSION Represents the MIRIAM biological qualifier 'hasVersion': the subject of the referenced resource (biological entity B) is a version or an instance of the biological entity represented by the model element.
BQB_IS Represents the MIRIAM biological qualifier 'is': the biological entity represented by the model element has identity with the subject of the referenced resource (biological entity B).
BQB_IS_DESCRIBED_BY Represents the MIRIAM biological qualifier 'isDescribedBy': the biological entity represented by the model element is described by the subject of the referenced resource (biological entity B).
BQB_IS_ENCODED_BY Represents the MIRIAM biological qualifier 'isEncodedBy': the biological entity represented by the model element is encoded, directly or transitively, by the subject of the referenced resource (biological entity B).
BQB_IS_HOMOLOG_TO Represents the MIRIAM biological qualifier 'isHomologTo': the biological entity represented by the model element is homologous to the subject of the referenced resource (biological entity B).
BQB_IS_PART_OF Represents the MIRIAM biological qualifier 'isPartOf': the biological entity represented by the model element is a physical or logical part of the subject of the referenced resource (biological entity B).
BQB_IS_PROPERTY_OF Represents the MIRIAM biological qualifier 'isPropertyOf': the biological entity represented by the model element is a property of the referenced resource (biological entity B).
BQB_IS_RELATED_TO Represents the MIRIAM biological qualifier 'isRelatedTo': the biological entity represented by the model element is somehow associated, directly or transitively, with the subject of the referenced resource (biological entity B).
BQB_IS_VERSION_OF Represents the MIRIAM biological qualifier 'isVersionOf': the biological entity represented by the model element is a version or an instance of the subject of the referenced resource (biological entity B).
BQB_OCCURS_IN Represents the MIRIAM biological qualifier 'occursIn': the biological entity represented by the model element is physically limited to a location, which is the subject of the referenced resource (biological entity B).
BQB_UNKNOWN Represents an unknown MIRIAM biological qualifier, equivalent to BQB_IS_RELATED_TO.
BQM_HAS_INSTANCE Represents the MIRIAM model qualifier 'hasInstance': the modelling object represented by the model element has for instance (is a class of) the subject of the referenced resource (modelling object B).
BQM_IS Represents the MIRIAM model qualifier 'is': the modeling object represented by the model element is identical with the subject of the referenced resource (modeling object B).
BQM_IS_DERIVED_FROM Represents the MIRIAM model qualifier 'isDerivedFrom': the modeling object represented by the model element is derived from the modeling object represented by the referenced resource (modeling object B).
BQM_IS_DESCRIBED_BY Represents the MIRIAM model qualifier 'isDescribedBy': the modeling object represented by the model element is described by the subject of the referenced resource (modeling object B).
BQM_IS_INSTANCE_OF Represents the MIRIAM model qualifier 'isInstanceOf': the modelling object represented by the model element is an instance of the subject of the referenced resource (modelling object B).
BQM_UNKNOWN Represents an unknown MIRIAM model qualifier.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	nameEquivalent The name equivalent.

Method Summary

Modifier and Type	Method and Description
static CVTerm.Qualifier	getBiologicalQualifierFor(java.lang.String elementNameEquivalent)
java.lang.String	getElementNameEquivalent() Returns a name corresponding to this Qualifier Object.
static CVTerm.Qualifier	getModelQualifierFor(java.lang.String elementNameEquivalent)
private static CVTerm.Qualifier	getQualifierFor(java.lang.String elementNameEquivalent, java.lang.String prefix, CVTerm.Qualifier unknownQualifier)
boolean	isBiologicalQualifier() Returns true if this qualifier is a biological qualifier.
boolean	isModelQualifier() Returns true if this qualifier is a model qualifier.
static CVTerm.Qualifier	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CVTerm.Qualifier[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BQB_ENCODES

public static final CVTerm.Qualifier BQB_ENCODES

Represents the MIRIAM biological qualifier 'encodes': the biological entity represented by the model element encodes, directly or transitively, the subject of the referenced resource (biological entity B). This relation may be used to express, for example, that a specific DNA sequence encodes a particular protein.

BQB_HAS_PART

public static final CVTerm.Qualifier BQB_HAS_PART

Represents the MIRIAM biological qualifier 'hasPart': the biological entity represented by the model element includes the subject of the referenced resource (biological entity B), either physically or logically. This relation might be used to link a complex to the description of its components.

BQB_HAS_PROPERTY

public static final CVTerm.Qualifier BQB_HAS_PROPERTY

Represents the MIRIAM biological qualifier 'hasProperty': the subject of the referenced resource (biological entity B) is a property of the biological entity represented by the model element. This relation might be used when a biological entity exhibits a certain enzymatic activity or exerts a specific function.

BQB_HAS_TAXON

public static final CVTerm.Qualifier BQB_HAS_TAXON

Represents the MIRIAM biological qualifier 'hasTaxon': the biological entity represented by the model element is taxonomically restricted, where the restriction is the subject of the referenced resource (biological entity B). This relation may be used to ascribe a species restriction to a biochemical reaction.

BQB_HAS_VERSION

public static final CVTerm.Qualifier BQB_HAS_VERSION

Represents the MIRIAM biological qualifier 'hasVersion': the subject of the referenced resource (biological entity B) is a version or an instance of the biological entity represented by the model element. This relation may be used to represent an isoform or modified form of a biological entity.

BQB_IS

public static final CVTerm.Qualifier BQB_IS

Represents the MIRIAM biological qualifier 'is': the biological entity represented by the model element has identity with the subject of the referenced resource (biological entity B). This relation might be used to link a reaction to its exact counterpart in a database, for instance.

BQB_IS_DESCRIBED_BY

public static final CVTerm.Qualifier BQB_IS_DESCRIBED_BY

Represents the MIRIAM biological qualifier 'isDescribedBy': the biological entity represented by the model element is described by the subject of the referenced resource (biological entity B). This relation should be used, for instance, to link a species or a parameter to the literature that describes the concentration of that species or the value of that parameter.

BQB_IS_ENCODED_BY

public static final CVTerm.Qualifier BQB_IS_ENCODED_BY

Represents the MIRIAM biological qualifier 'isEncodedBy': the biological entity represented by the model element is encoded, directly or transitively, by the subject of the referenced resource (biological entity B). This relation may be used to express, for example, that a protein is encoded by a specific DNA sequence.

BQB_IS_HOMOLOG_TO

public static final CVTerm.Qualifier BQB_IS_HOMOLOG_TO

Represents the MIRIAM biological qualifier 'isHomologTo': the biological entity represented by the model element is homologous to the subject of the referenced resource (biological entity B). This relation can be used to represent biological entities that share a common ancestor.

BQB_IS_PART_OF

public static final CVTerm.Qualifier BQB_IS_PART_OF

Represents the MIRIAM biological qualifier 'isPartOf': the biological entity represented by the model element is a physical or logical part of the subject of the referenced resource (biological entity B). This relation may be used to link a model component to a description of the complex in which it is a part.

BQB_IS_PROPERTY_OF

public static final CVTerm.Qualifier BQB_IS_PROPERTY_OF

Represents the MIRIAM biological qualifier 'isPropertyOf': the biological entity represented by the model element is a property of the referenced resource (biological entity B).

BQB_IS_VERSION_OF

public static final CVTerm.Qualifier BQB_IS_VERSION_OF

Represents the MIRIAM biological qualifier 'isVersionOf': the biological entity represented by the model element is a version or an instance of the subject of the referenced resource (biological entity B). This relation may be used to represent, for example, the 'superclass' or 'parent' form of a particular biological entity.

BQB_OCCURS_IN

public static final CVTerm.Qualifier BQB_OCCURS_IN

Represents the MIRIAM biological qualifier 'occursIn': the biological entity represented by the model element is physically limited to a location, which is the subject of the referenced resource (biological entity B). This relation may be used to ascribe a compartmental location, within which a reaction takes place.

BQB_IS_RELATED_TO

public static final CVTerm.Qualifier BQB_IS_RELATED_TO

Represents the MIRIAM biological qualifier 'isRelatedTo': the biological entity represented by the model element is somehow associated, directly or transitively, with the subject of the referenced resource (biological entity B). This qualifier may be used as a generic way to express any biological relationship.

Only use this qualifier if you are not able to find a more precise qualifier.

BQB_UNKNOWN

public static final CVTerm.Qualifier BQB_UNKNOWN

Represents an unknown MIRIAM biological qualifier, equivalent to BQB_IS_RELATED_TO.

BQM_HAS_INSTANCE

public static final CVTerm.Qualifier BQM_HAS_INSTANCE

Represents the MIRIAM model qualifier 'hasInstance': the modelling object represented by the model element has for instance (is a class of) the subject of the referenced resource (modelling object B). For instance, this qualifier might be used to link a generic model with its specific forms.

BQM_IS

public static final CVTerm.Qualifier BQM_IS

Represents the MIRIAM model qualifier 'is': the modeling object represented by the model element is identical with the subject of the referenced resource (modeling object B). For instance, this qualifier might be used to link an encoded model to a database of models.

BQM_IS_DERIVED_FROM

public static final CVTerm.Qualifier BQM_IS_DERIVED_FROM

Represents the MIRIAM model qualifier 'isDerivedFrom': the modeling object represented by the model element is derived from the modeling object represented by the referenced resource (modeling object B). This relation may be used, for instance, to express a refinement or adaptation in usage for a previously described modeling component.

BQM_IS_DESCRIBED_BY

public static final CVTerm.Qualifier BQM_IS_DESCRIBED_BY

Represents the MIRIAM model qualifier 'isDescribedBy': the modeling object represented by the model element is described by the subject of the referenced resource (modeling object B). This relation might be used to link a model or a kinetic law to the literature that describes it.

BQM_IS_INSTANCE_OF

public static final CVTerm.Qualifier BQM_IS_INSTANCE_OF

Represents the MIRIAM model qualifier 'isInstanceOf': the modelling object represented by the model element is an instance of the subject of the referenced resource (modelling object B). For instance, this qualifier might be used to link a specific model with its generic form.

BQM_UNKNOWN

public static final CVTerm.Qualifier BQM_UNKNOWN

Represents an unknown MIRIAM model qualifier.

Field Detail

nameEquivalent

private java.lang.String nameEquivalent

The name equivalent.

Method Detail

values

public static CVTerm.Qualifier[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CVTerm.Qualifier c : CVTerm.Qualifier.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CVTerm.Qualifier valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getBiologicalQualifierFor

public static CVTerm.Qualifier getBiologicalQualifierFor(java.lang.String elementNameEquivalent)

Parameters:

elementNameEquivalent -

Returns:

getModelQualifierFor

public static CVTerm.Qualifier getModelQualifierFor(java.lang.String elementNameEquivalent)

Parameters:

elementNameEquivalent -

Returns:

getQualifierFor

private static CVTerm.Qualifier getQualifierFor(java.lang.String elementNameEquivalent,
                                                java.lang.String prefix,
                                                CVTerm.Qualifier unknownQualifier)

Parameters:

elementNameEquivalent -

prefix -

unknownQualifier -

Returns:

getElementNameEquivalent

public java.lang.String getElementNameEquivalent()

Returns a name corresponding to this Qualifier Object.

Returns:

a name corresponding to this Qualifier Object.

isBiologicalQualifier

public boolean isBiologicalQualifier()

Returns true if this qualifier is a biological qualifier.

Returns:

true if this qualifier is a biological qualifier, false otherwise.

isModelQualifier

public boolean isModelQualifier()

Returns true if this qualifier is a model qualifier.

Returns:

true if this qualifier is a model qualifier, false otherwise.