org.sbolstandard.core2

Class Measured

java.lang.Object

org.sbolstandard.core2.Identified

org.sbolstandard.core2.Measured

Direct Known Subclasses:

ComponentInstance, Interaction, Module, Participation

public abstract class Measured
extends Identified

Represents a Measured object in the SBOL data model.

Version:

2.1

Author:

Zhen Zhang, Nicholas Roehner, Chris Myers

Method Summary

Modifier and Type	Method and Description
void	clearMeasures() Removes all entries of this measured object list of measures.
Measure	createMeasure(String displayId, Double numericalValue, URI unit) Creates a child measure for this measured object with the given arguments, and then adds to this measured object's list of measures.
boolean	equals(Object obj)
Measure	getMeasure(String displayId) Returns the measure matching the given display ID from this measured object's list of measures.
Measure	getMeasure(URI measureURI) Returns the measure matching the given measure URI from this measured object's list of measures.
Set<Measure>	getMeasures() Returns the set of measures owned by this measured object.
int	hashCode()
boolean	removeMeasure(Measure measure) Removes the given measure from this measured object's list of measures.
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

createMeasure

public Measure createMeasure(String displayId,
                             Double numericalValue,
                             URI unit)
                      throws SBOLValidationException

Creates a child measure for this measured object with the given arguments, and then adds to this measured object's list of measures.

This method first creates a compliant URI for the measure to be created. It starts with this measured object's persistent identity URI, followed by the given display ID, and ends with this measured object's version.

Parameters:

displayId - The displayId identifier for this

numericalValue - the numerical value for this measure

unit - the unit of this measure

Returns:

the created measure

Throws:

SBOLValidationException - if any of the following SBOL validation rules was violated: 10201, 10202, 10204, 10206, 13501, 13502, 13503, 13504, 13505,

removeMeasure

public boolean removeMeasure(Measure measure)

Removes the given measure from this measured object's list of measures.

Parameters:

measure - the given measure to be removed

Returns:

true if the matching measure was removed successfully, false otherwise

getMeasure

public Measure getMeasure(String displayId)

Returns the measure matching the given display ID from this measured object's list of measures.

This method first creates a compliant URI for the measure to be retrieved. It starts with this measured object's persistent identity, followed by the given display ID, and ends with this measured object's version.

Parameters:

displayId - the display ID of the measure to be retrieved

Returns:

the matching measure if present, or null otherwise

getMeasure

public Measure getMeasure(URI measureURI)

Returns the measure matching the given measure URI from this measured object's list of measures.

Parameters:

measureURI - the identity URI for the measure to be retrieved

Returns:

the matching measure if present, or null otherwise

getMeasures

public Set<Measure> getMeasures()

Returns the set of measures owned by this measured object.

Returns:

the set of the set of measures owned by this measured object

clearMeasures

public void clearMeasures()

Removes all entries of this measured object list of measures. The list will be empty after this call returns.

This method calls removeMeasure(Measure) to iteratively remove each measure owned by this object.

toString

public String toString()

Overrides:

toString in class Identified