org.sbolstandard.core2

Class Usage

java.lang.Object

org.sbolstandard.core2.Identified

org.sbolstandard.core2.Usage

public class Usage
extends Identified

Represents an Usage object in the SBOL data model.

Version:

2.2

Author:

Chris Myers

Method Summary

Modifier and Type	Method and Description
boolean	addRole(ActivityRoleType role) Adds the given role to this usage's set of roles.
boolean	addRole(URI roleURI) Adds the given role URI to this usage's set of role URIs.
void	clearRoles() Removes all entries of this usage's set of role URIs.
boolean	containsRole(URI roleURI) Checks if the given role URI is included in this usage's set of role URIs.
boolean	equals(Object obj)
TopLevel	getEntity() Returns the entity referenced by this usage.
URI	getEntityIdentity() Returns the entity identity referenced by this usage.
URI	getEntityURI() Returns the reference entity URI.
Set<URI>	getRoles() Returns the set of role URIs owned by this usage.
int	hashCode()
boolean	removeRole(URI roleURI) Removes the given role URI from the set of roles.
void	setEntity(URI entity)
void	setRoles(Set<URI> roles) Clears the existing set of roles first, and then adds the given set of the roles to this usage.
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

getEntityURI

public URI getEntityURI()

Returns the reference entity URI.

Returns:

the reference entity URI

getEntityIdentity

public URI getEntityIdentity()

Returns the entity identity referenced by this usage.

Returns:

null if the associated SBOLDocument instance is null or no matching entity identity referenced by this usage exists; or the matching entity otherwise.

getEntity

public TopLevel getEntity()

Returns the entity referenced by this usage.

Returns:

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

setEntity

public void setEntity(URI entity)
               throws SBOLValidationException

Parameters:

entity - the entity to set

Throws:

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

addRole

public boolean addRole(URI roleURI)

Adds the given role URI to this usage's set of role URIs.

Parameters:

roleURI - the role URI to be added

Returns:

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

addRole

public boolean addRole(ActivityRoleType role)

Adds the given role to this usage's set of roles.

Parameters:

role - the role to be added

Returns:

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

removeRole

public boolean removeRole(URI roleURI)

Removes the given role URI from the set of roles.

Parameters:

roleURI - the given role URI to be removed

Returns:

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

getRoles

public Set<URI> getRoles()

Returns the set of role URIs owned by this usage.

Returns:

the set of role URIs owned by this usage.

setRoles

public void setRoles(Set<URI> roles)

Clears the existing set of roles first, and then adds the given set of the roles to this usage.

Parameters:

roles - the set of roles to set to

containsRole

public boolean containsRole(URI roleURI)

Checks if the given role URI is included in this usage's set of role URIs.

Parameters:

roleURI - the role URI to be checked

Returns:

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

clearRoles

public void clearRoles()

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

toString

public String toString()

Overrides:

toString in class Identified