ComponentDefinition
Extends:
Class to represent an SBOL2 ComponentDefinition.
Constructor Summary
| Public Constructor | ||
| public |
constructor(sbolDocument: *, uri: *) |
|
Member Summary
| Public Members | ||
| public get |
components: Component[]: * Retrieve the list of Components for this ComponentDefinition. |
|
| public get |
roles: URI[]: * Retrieve the list of roles assigned to this ComponentDefinition. |
|
| public get |
Retrieve the list of SequenceAnnotations for this ComponentDefinition. |
|
| public get |
Retrieve the list of SequenceConstraints for this ComponentDefinition. |
|
| public get |
Retrieve the list of Sequences for this ComponentDefinition. |
|
| public get |
types: URI[]: * Retrieve the list of types assigned to this ComponentDefinition. |
|
Method Summary
| Public Methods | ||
| public |
addComponent(component: string | URI | Component) Add a Component to this ComponentDefinition. |
|
| public |
Assign a role to this ComponentDefinition. |
|
| public |
addSequence(sequence: string | URI | Sequence) Add a Sequence to this ComponentDefinition. |
|
| public |
addSequenceAnnotation(sequenceAnnotation: string | URI | SequenceAnnotation) Add a SequenceAnnotation to this ComponentDefinition. |
|
| public |
addSequenceConstraint(sequenceConstraint: string | URI | SequenceConstraint) Add a SequenceConstraint to this ComponentDefinition. |
|
| public |
Assign a type to this ComponentDefinition. |
|
| public |
link() Attempt to resolve the Components, SequenceAnnotations, SequenceConstraints, and Sequences assigned to this ComponentDefinition by URI. |
|
Public Constructors
public constructor(sbolDocument: *, uri: *) source
Parameters:
| Name | Type | Attribute | Description |
| sbolDocument | * | ||
| uri | * |
Public Members
public get components: Component[]: * source
Retrieve the list of Components for this ComponentDefinition. There may be URIs present in this list if the component(s) have not yet been resolved.
public get roles: URI[]: * source
Retrieve the list of roles assigned to this ComponentDefinition.
Returns:
| URI[] |
public get sequenceAnnotations: SequenceAnnotation[]: * source
Retrieve the list of SequenceAnnotations for this ComponentDefinition. There may be URIs present in this list if the sequenceAnnotation(s) have not yet been resolved.
public get sequenceConstraints: SequenceConstraint[]: * source
Retrieve the list of SequenceConstraints for this ComponentDefinition. There may be URIs present in this list if the sequenceConstraint(s) have not yet been resolved.
public get sequences: Sequence[]: * source
Retrieve the list of Sequences for this ComponentDefinition. There may be URIs present in this list if the sequence(s) have not yet been resolved.
public get types: URI[]: * source
Retrieve the list of types assigned to this ComponentDefinition.
Returns:
| URI[] |
Public Methods
public addComponent(component: string | URI | Component) source
Add a Component to this ComponentDefinition.
public addRole(role: string | URI) source
Assign a role to this ComponentDefinition.
Parameters:
| Name | Type | Attribute | Description |
| role | string | URI |
|
public addSequence(sequence: string | URI | Sequence) source
Add a Sequence to this ComponentDefinition.
public addSequenceAnnotation(sequenceAnnotation: string | URI | SequenceAnnotation) source
Add a SequenceAnnotation to this ComponentDefinition.
Parameters:
| Name | Type | Attribute | Description |
| sequenceAnnotation | string | URI | SequenceAnnotation |
|
public addSequenceConstraint(sequenceConstraint: string | URI | SequenceConstraint) source
Add a SequenceConstraint to this ComponentDefinition.
Parameters:
| Name | Type | Attribute | Description |
| sequenceConstraint | string | URI | SequenceConstraint |
|
public addType(type: string | URI) source
Assign a type to this ComponentDefinition.
Parameters:
| Name | Type | Attribute | Description |
| type | string | URI |
|
public link() source
Attempt to resolve the Components, SequenceAnnotations, SequenceConstraints, and Sequences assigned to this ComponentDefinition by URI.