org.sbolstandard.core2

Class Association

java.lang.Object

org.sbolstandard.core2.Identified

org.sbolstandard.core2.Association

public class Association
extends Identified

Represents an Association 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 association's set of roles.
boolean	addRole(URI roleURI) Adds the given role URI to this association's set of role URIs.
void	clearRoles() Removes all entries of this associations's set of role URIs.
boolean	containsRole(URI roleURI) Checks if the given role URI is included in this association's set of role URIs.
boolean	equals(Object obj)
Agent	getAgent() Returns the agent referenced by this association.
URI	getAgentIdentity() Returns the agent identity referenced by this association.
URI	getAgentURI() Returns the reference agent URI.
Plan	getPlan() Returns the plan referenced by this association.
URI	getPlanIdentity() Returns the plan identity referenced by this association.
URI	getPlanURI() Returns the reference plan URI.
Set<URI>	getRoles() Returns the set of role URIs owned by this association.
int	hashCode()
boolean	isSetPlan() Test if the plan is set.
boolean	removeRole(URI roleURI) Removes the given role URI from the set of roles.
void	setAgent(URI agent)
void	setPlan(URI plan)
void	setRoles(Set<URI> roles) Clears the existing set of roles first, and then adds the given set of the roles to this association.
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

addRole

public boolean addRole(URI roleURI)

Adds the given role URI to this association'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 association'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 association.

Returns:

the set of role URIs owned by this association.

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 association.

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 association'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 associations's set of role URIs. The set will be empty after this call returns.

getAgentURI

public URI getAgentURI()

Returns the reference agent URI.

Returns:

the reference agent URI

getAgentIdentity

public URI getAgentIdentity()

Returns the agent identity referenced by this association.

Returns:

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

getAgent

public Agent getAgent()

Returns the agent referenced by this association.

Returns:

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

setAgent

public void setAgent(URI agent)
              throws SBOLValidationException

Parameters:

agent - the agent to set

Throws:

SBOLValidationException - if either of the following SBOL validation rules was violated: 12605, 12606.

isSetPlan

public boolean isSetPlan()

Test if the plan is set.

Returns:

true if it is not null, or false otherwise

getPlanURI

public URI getPlanURI()

Returns the reference plan URI.

Returns:

the reference plan URI

getPlanIdentity

public URI getPlanIdentity()

Returns the plan identity referenced by this association.

Returns:

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

getPlan

public Plan getPlan()

Returns the plan referenced by this association.

Returns:

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

setPlan

public void setPlan(URI plan)
             throws SBOLValidationException

Parameters:

plan - the plan to set

Throws:

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

toString

public String toString()

Overrides:

toString in class Identified