org.sbolstandard.core2

Class Measure

java.lang.Object

org.sbolstandard.core2.Identified

org.sbolstandard.core2.Measure

public class Measure
extends Identified

Represents an Measure object in the SBOL data model.

Version:

2.3

Author:

Chris Myers

Method Summary

Modifier and Type	Method and Description
boolean	addType(URI typeURI) Adds the given type URI to this measure's set of type URIs.
void	clearTypes() Removes all entries of this measure's set of type URIs.
boolean	containsType(URI typeURI) Checks if the given type URI is included in this measure's set of type URIs.
boolean	equals(Object obj)
Double	getNumericalValue() Returns the numerical value.
Set<URI>	getTypes() Returns the set of type URIs owned by this measure.
TopLevel	getUnit() Returns the unit referenced by this measure.
URI	getUnitIdentity() Returns the unit identity referenced by this measure.
URI	getUnitURI() Returns the unit URI.
int	hashCode()
boolean	removeType(URI typeURI) Removes the given type URI from the set of types.
void	setNumericalValue(Double hasNumericalValue)
void	setTypes(Set<URI> types) Clears the existing set of types first, and then adds the given set of the types to this measure.
void	setUnit(URI hasUnit)
String	toString()

Methods inherited from class org.sbolstandard.core2.Identified

addWasDerivedFrom, addWasGeneratedBy, clearAnnotations, clearWasDerivedFroms, clearWasGeneratedBys, containsWasDerivedFrom, containsWasGeneratedBy, createAnnotation, createAnnotation, createAnnotation, createAnnotation, createAnnotation, createAnnotation, getAnnotation, getAnnotations, getDescription, getDisplayId, getIdentity, getName, getPersistentIdentity, getVersion, getWasDerivedFrom, getWasDerivedFroms, getWasGeneratedBys, hasAnnotations, isSetDescription, isSetDisplayId, isSetName, isSetPersistentIdentity, isSetVersion, isSetWasDerivedFrom, removeAnnotation, removeWasDerivedFrom, removeWasGeneratedBy, setDescription, setName, setWasDerivedFrom, setWasDerivedFroms, setWasGeneratedBys, unsetDescription, unsetName, unsetWasDerivedFrom

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Identified

equals

public boolean equals(Object obj)

Overrides:

equals in class Identified

getNumericalValue

public Double getNumericalValue()

Returns the numerical value.

Returns:

the numerical value

setNumericalValue

public void setNumericalValue(Double hasNumericalValue)
                       throws SBOLValidationException

Parameters:

hasNumericalValue - the numerical value to set

Throws:

SBOLValidationException - if the following SBOL validation rule was violated: 13502.

getUnitURI

public URI getUnitURI()

Returns the unit URI.

Returns:

the unit URI

getUnitIdentity

public URI getUnitIdentity()

Returns the unit identity referenced by this measure.

Returns:

null if the associated SBOLDocument instance is null or no matching unity identity referenced by this measure exists; or the matching unit otherwise.

getUnit

public TopLevel getUnit()

Returns the unit referenced by this measure.

Returns:

null if the associated SBOLDocument instance is null or no matching unit referenced by this measure exists; or the matching unit otherwise.

setUnit

public void setUnit(URI hasUnit)
             throws SBOLValidationException

Parameters:

hasUnit - the unit to set

Throws:

SBOLValidationException - if the following SBOL validation rule was violated: 13503.

addType

public boolean addType(URI typeURI)

Adds the given type URI to this measure's set of type URIs.

Parameters:

typeURI - the type URI to be added

Returns:

true if this set did not already contain the specified type, false otherwise.

removeType

public boolean removeType(URI typeURI)

Removes the given type URI from the set of types.

Parameters:

typeURI - the given type URI to be removed

Returns:

true if the matching type reference was removed successfully, false otherwise.

getTypes

public Set<URI> getTypes()

Returns the set of type URIs owned by this measure.

Returns:

the set of type URIs owned by this measure.

setTypes

public void setTypes(Set<URI> types)

Clears the existing set of types first, and then adds the given set of the types to this measure.

Parameters:

types - the set of types to set to

containsType

public boolean containsType(URI typeURI)

Checks if the given type URI is included in this measure's set of type URIs.

Parameters:

typeURI - the type URI to be checked

Returns:

true if this set contains the given type URI, false otherwise.

clearTypes

public void clearTypes()

Removes all entries of this measure's set of type URIs. The set will be empty after this call returns.

toString

public String toString()

Overrides:

toString in class Identified