org.sbolstandard.core2

Class Experiment

java.lang.Object

org.sbolstandard.core2.Identified

org.sbolstandard.core2.TopLevel

org.sbolstandard.core2.Experiment

public class Experiment
extends TopLevel

Represents an Collection object in the SBOL data model.

Version:

2.1

Author:

Zhen Zhang, Nicholas Roehner, Chris Myers

Field Summary

Fields inherited from class org.sbolstandard.core2.TopLevel

ACTIVITY, AGENT, ANNOTATION, ATTACHMENT, COLLECTION, COMBINATORIAL_DERIVATION, COMPONENT_DEFINITION, EXPERIMENT, EXPERIMENTAL_DATA, GENERIC_TOP_LEVEL, IMPLEMENTATION, MODEL, MODULE_DEFINITION, PLAN, SEQUENCE

Method Summary

Modifier and Type	Method and Description
boolean	addExperimentalData(URI experimentalDataURI) Adds the given experimentalData URI to this Experiment's set of reference experimentalData URIs.
void	clearExperimentalData() Removes all entries of this Experiment's set of reference experimentalData URIs.
boolean	containsExperimentalData(URI experimentalDataURI) Checks if the given URI is included in this Experiment instance's set of experimentalData URIs.
boolean	equals(Object obj)
Set<ExperimentalData>	getExperimentalData() Returns the set of objects referenced by this Experiment's experimentalData.
Set<URI>	getExperimentalDataIdentities() Returns the set of experimentalData identities referenced by this Experiment instance.
Set<URI>	getExperimentalDataURIs() Returns the set of experimentalData URIs referenced by this Experiment instance.
int	hashCode()
boolean	removeExperimentalData(URI experimentalDataURI) Removes the given experimentalData from this Experiment's set of experimentalData.
void	setExperimentalData(Set<URI> experimentalData) Clears the existing set of experimentalData of this Experiment instance first, then adds the given set of the experimentalData references to it.
String	toString()

Methods inherited from class org.sbolstandard.core2.TopLevel

addAttachment, addAttachment, addAttachment, clearAttachments, containsAttachment, getAttachments, getAttachmentURIs, removeAttachment, setAttachments

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

addExperimentalData

public boolean addExperimentalData(URI experimentalDataURI)
                            throws SBOLValidationException

Adds the given experimentalData URI to this Experiment's set of reference experimentalData URIs.

Parameters:

experimentalDataURI - References to a ExperimentalData instance

Returns:

true if the matching experimentalData reference has been added successfully, false otherwise.

Throws:

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

removeExperimentalData

public boolean removeExperimentalData(URI experimentalDataURI)

Removes the given experimentalData from this Experiment's set of experimentalData.

Parameters:

experimentalDataURI - the experimentalData identity URI to be removed from this Experiment's experimentalData

Returns:

true if the matching experimentalData is removed successfully, false otherwise.

setExperimentalData

public void setExperimentalData(Set<URI> experimentalData)
                         throws SBOLValidationException

Clears the existing set of experimentalData of this Experiment instance first, then adds the given set of the experimentalData references to it.

Parameters:

experimentalData - a set of identity URIs of zero or more TopLevel instances to be added

Throws:

SBOLValidationException - see SBOL validation rule violation at addExperimentalData(URI)

getExperimentalDataURIs

public Set<URI> getExperimentalDataURIs()

Returns the set of experimentalData URIs referenced by this Experiment instance.

Returns:

the set of experimentalData URIs referenced by this Experiment instance.

getExperimentalDataIdentities

public Set<URI> getExperimentalDataIdentities()

Returns the set of experimentalData identities referenced by this Experiment instance.

Returns:

the set of experimentalData identities referenced by this Experiment instance.

getExperimentalData

public Set<ExperimentalData> getExperimentalData()

Returns the set of objects referenced by this Experiment's experimentalData.

Returns:

the set of objects referenced by this Experiment's experimentalData.

containsExperimentalData

public boolean containsExperimentalData(URI experimentalDataURI)

Checks if the given URI is included in this Experiment instance's set of experimentalData URIs.

Parameters:

experimentalDataURI - a URI that is checked against this Experiment's list of experimentalData URIs

Returns:

true if its experimentalData contain the given URI, false otherwise.

clearExperimentalData

public void clearExperimentalData()

Removes all entries of this Experiment's set of reference experimentalData URIs. The set will be empty after this call returns.

hashCode

public int hashCode()

Overrides:

hashCode in class TopLevel

equals

public boolean equals(Object obj)

Overrides:

equals in class TopLevel

toString

public String toString()

Overrides:

toString in class Identified