org.sbolstandard.core2

Class Participation

java.lang.Object

org.sbolstandard.core2.Identified

org.sbolstandard.core2.Measured

org.sbolstandard.core2.Participation

public class Participation
extends Measured

Represents a Participation object in the SBOL data model.

Version:

2.1

Author:

Zhen Zhang, Nicholas Roehner, Chris Myers

Method Summary

Modifier and Type	Method and Description
boolean	addRole(URI roleURI) Adds the given role to this participation's set of roles.
boolean	containsRole(URI roleURI) Checks if the given role is included in this participation's set of roles.
boolean	equals(Object obj)
FunctionalComponent	getParticipant() Returns the functional component this participation refers to.
ComponentDefinition	getParticipantDefinition() Returns the component definition referenced by this participation's participant.
URI	getParticipantIdentity() Returns the functional component identity this participation refers to.
URI	getParticipantURI() Returns the FunctionalComponent URI that this participation refers to.
Set<URI>	getRoles() Returns the set of role URIs owned by this participation.
int	hashCode()
boolean	removeRole(URI roleURI) Removes the given role from the set of roles.
void	setParticipant(URI participant) Sets the participant property of this object to the given one.
void	setRoles(Set<URI> roles) Clears the existing set of roles first, and then adds the given set of the roles to this participation.
String	toString()

Methods inherited from class org.sbolstandard.core2.Measured

clearMeasures, createMeasure, getMeasure, getMeasure, getMeasures, removeMeasure

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

getParticipantURI

public URI getParticipantURI()

Returns the FunctionalComponent URI that this participation refers to.

Returns:

the FunctionalComponent URI that this participation refers to

getParticipantIdentity

public URI getParticipantIdentity()

Returns the functional component identity this participation refers to.

Returns:

the functional component identity this participation refers to

getParticipant

public FunctionalComponent getParticipant()

Returns the functional component this participation refers to.

Returns:

the functional component this participation refers to

getParticipantDefinition

public ComponentDefinition getParticipantDefinition()

Returns the component definition referenced by this participation's participant.

Returns:

the component definition referenced by this participation's participant

setParticipant

public void setParticipant(URI participant)
                    throws SBOLValidationException

Sets the participant property of this object to the given one.

Parameters:

participant - the participant property to set to

Throws:

SBOLValidationException - if either of the following SBOL validation rules was violated: 12002, 12003.

addRole

public boolean addRole(URI roleURI)

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

Parameters:

roleURI - the given role to be added

Returns:

true if this set did not already contain the given role, or false otherwise

removeRole

public boolean removeRole(URI roleURI)
                   throws SBOLValidationException

Removes the given role from the set of roles.

Parameters:

roleURI - the given role to be removed

Returns:

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

Throws:

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

setRoles

public void setRoles(Set<URI> roles)
              throws SBOLValidationException

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

Parameters:

roles - the set of roles to set to

Throws:

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

getRoles

public Set<URI> getRoles()

Returns the set of role URIs owned by this participation.

Returns:

the set of role URIs owned by this participation

containsRole

public boolean containsRole(URI roleURI)

Checks if the given role is included in this participation's set of roles.

Parameters:

roleURI - the given role to be checked

Returns:

true if this set contains the specified URI, or false otherwise

equals

public boolean equals(Object obj)

Overrides:

equals in class Measured

hashCode

public int hashCode()

Overrides:

hashCode in class Measured

toString

public String toString()

Overrides:

toString in class Measured