public class CombinatorialDerivation extends TopLevel
ACTIVITY, AGENT, ANNOTATION, ATTACHMENT, COLLECTION, COMBINATORIAL_DERIVATION, COMPONENT_DEFINITION, EXPERIMENT, EXPERIMENTAL_DATA, GENERIC_TOP_LEVEL, IMPLEMENTATION, MODEL, MODULE_DEFINITION, PLAN, SEQUENCE
Modifier and Type | Method and Description |
---|---|
void |
checkDescendantsURIcompliance()
Check if this top-level object's and all of its descendants' URIs are all
compliant.
|
void |
clearVariableComponents()
Removes all entries of this combinatorial derivation's list of variable
components.
|
VariableComponent |
createVariableComponent(String displayId,
OperatorType operator,
String variableId)
Creates a child variable component for this combinatorial derivation with the
given arguments, and then adds to this combinatorial derivation's list of
variable components.
|
VariableComponent |
createVariableComponent(String displayId,
OperatorType operator,
URI variable)
Creates a child variable component for this combinatorial derivation with the
given arguments, and then adds to this combinatorial derivation's list of
variable components.
|
boolean |
equals(Object obj) |
StrategyType |
getStrategy()
Returns the strategy property.
|
ComponentDefinition |
getTemplate()
Returns the component definition referenced by this combinatorial derivation.
|
URI |
getTemplateIdentity()
Returns the component definition identity referenced by this combinatorial
derivation.
|
URI |
getTemplateURI()
Returns the reference component definition URI.
|
VariableComponent |
getVariableComponent(String displayId)
Returns the variable component matching the given variable component's
display ID.
|
VariableComponent |
getVariableComponent(URI variableComponentURI)
Returns the instance matching the given variable component's identity URI.
|
Set<VariableComponent> |
getVariableComponents()
Returns the set of variable components owned by this combinatorial
derivation.
|
int |
hashCode() |
boolean |
isSetStrategy()
Checks if the strategy property is set.
|
boolean |
removeVariableComponent(VariableComponent variableComponent)
Removes the given variable component from the list of variable components.
|
void |
setStrategy(StrategyType strategy)
Sets the strategy property to the given one.
|
void |
setTemplate(URI template)
Sets the template property to the given one.
|
void |
setVariableComponents(Set<VariableComponent> variableComponents)
Clears the existing set of variable components first, and then adds the given
set of the variable components to this combinatorial derivation.
|
String |
toString() |
void |
unsetStrategy()
Sets the strategy property of this combinatorial derivation to
null . |
addAttachment, addAttachment, addAttachment, clearAttachments, containsAttachment, getAttachments, getAttachmentURIs, removeAttachment, setAttachments
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
public boolean isSetStrategy()
true
if it is not null
, false
otherwisepublic boolean removeVariableComponent(VariableComponent variableComponent)
variableComponent
- the given variable componenttrue
if the matching variable component was removed
successfully, false
otherwise.public VariableComponent getVariableComponent(URI variableComponentURI)
variableComponentURI
- the identity URI of the variable component to be retrievednull
otherwise.public VariableComponent getVariableComponent(String displayId)
This method first creates a compliant URI for the variable component to be retrieved. It starts with this combinatorial derivation's persistent identity, followed by the given variable component's display ID, and ends with this combinatorial derivation's version.
displayId
- the display ID of the variable component to be retrievednull
otherwise.public Set<VariableComponent> getVariableComponents()
public void clearVariableComponents()
This method calls
removeVariableComponent(VariableComponent variableComponent)
to
iteratively remove each variable component.
public void setVariableComponents(Set<VariableComponent> variableComponents) throws SBOLValidationException
variableComponents
- The set of variable components for this combinatorial derivation.SBOLValidationException
- if an SBOL validation rule violation occurred in any of the following methods:
public VariableComponent createVariableComponent(String displayId, OperatorType operator, URI variable) throws SBOLValidationException
This method first creates a compliant URI for the child variable component to be created. This URI starts with this combinatorial derivation's persistent identity, followed by the given display ID and ends with this combinatorial derivation's version.
displayId
- the display ID for the variable component to be createdoperator
- the operator property for the variable component to be createdvariable
- the component URI referenced by the variable component to be createdSBOLValidationException
- if any of the following SBOL validation rules was violated:
10201, 10202, 10204, 10206, 13002, 13003, 13004, 13005.public VariableComponent createVariableComponent(String displayId, OperatorType operator, String variableId) throws SBOLValidationException
This method first creates a compliant URI for the child variable component to be created. This URI starts with this combinatorial derivation's persistent identity, followed by the given display ID and ends with this combinatorial derivation's version.
displayId
- the display ID for the variable component to be createdoperator
- the operator property for the variable component to be createdvariableId
- the component displayId referenced by the variable component to be createdSBOLValidationException
- if any of the following SBOL validation rules was violated:
10201, 10202, 10204, 10206, 13002, 13003, 13004, 13005.public URI getTemplateURI()
public URI getTemplateIdentity()
null
if the associated SBOLDocument instance is null
or no matching component definition referenced by this combinatorial
derivation exists; or the matching component definition otherwise.public ComponentDefinition getTemplate()
null
if the associated SBOLDocument instance is null
or no matching component definition referenced by this combinatorial
derivation; or the matching component definition otherwise.public void setTemplate(URI template) throws SBOLValidationException
template
- the given template URI to set toSBOLValidationException
- if either of the following SBOL validation rules was violated:
10602, 10604, 12905.public StrategyType getStrategy()
public void setStrategy(StrategyType strategy) throws SBOLValidationException
strategy
- the given strategy type to set toSBOLValidationException
- on SBOL validation rule violation 12903.public void unsetStrategy()
null
.public void checkDescendantsURIcompliance() throws SBOLValidationException
TopLevel
SBOLValidationException
- an SBOL validation rule violation occurred in either of the
following methods:
URIcompliance.isChildURIcompliant(Identified, Identified)
.public String toString()
toString
in class Identified