org.sbolstandard.core2

Class Collection

java.lang.Object

org.sbolstandard.core2.Identified

org.sbolstandard.core2.TopLevel

org.sbolstandard.core2.Collection

public class Collection
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	addMember(URI memberURI) Adds the given member URI to this Collection instance's set of reference member URIs.
void	clearMembers() Removes all entries of this Collection instance's set of reference member URIs.
boolean	containsMember(URI memberURI) Checks if the given URI is included in this Collection instance's set of member URIs.
boolean	equals(Object obj)
Set<URI>	getMemberIdentities() Returns the set of member identities referenced by this Collection instance.
Set<TopLevel>	getMembers() Returns the set of objects referenced by this Collection instance's members.
Set<URI>	getMemberURIs() Returns the set of member URIs referenced by this Collection instance.
int	hashCode()
boolean	removeMember(URI memberURI) Removes the given member from this Collection instance's set of members.
void	setMembers(Set<URI> members) Clears the existing set of members of this Collection instance first, then adds the given set of the member 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

addMember

public boolean addMember(URI memberURI)
                  throws SBOLValidationException

Adds the given member URI to this Collection instance's set of reference member URIs.

Parameters:

memberURI - References to a TopLevel instance

Returns:

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

Throws:

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

removeMember

public boolean removeMember(URI memberURI)

Removes the given member from this Collection instance's set of members.

Parameters:

memberURI - the member identity URI to be removed from this Collection's members

Returns:

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

setMembers

public void setMembers(Set<URI> members)
                throws SBOLValidationException

Clears the existing set of members of this Collection instance first, then adds the given set of the member references to it.

Parameters:

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

Throws:

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

getMemberURIs

public Set<URI> getMemberURIs()

Returns the set of member URIs referenced by this Collection instance.

Returns:

the set of member URIs referenced by this Collection instance.

getMemberIdentities

public Set<URI> getMemberIdentities()

Returns the set of member identities referenced by this Collection instance.

Returns:

the set of member identities referenced by this Collection instance.

getMembers

public Set<TopLevel> getMembers()

Returns the set of objects referenced by this Collection instance's members.

Returns:

the set of objects referenced by this Collection instance's members.

containsMember

public boolean containsMember(URI memberURI)

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

Parameters:

memberURI - a URI that is checked against this Collection instance's list of member URIs

Returns:

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

clearMembers

public void clearMembers()

Removes all entries of this Collection instance's set of reference member 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