Home Reference Source
public class | source

ComponentDefinition

Extends:

Identified → ComponentDefinition

Class to represent an SBOL2 ComponentDefinition.

Constructor Summary

Public Constructor
public

constructor(sbolDocument: *, uri: *)

Member Summary

Public Members
public get

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

addRole(role: string | URI)

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

addType(type: string | URI)

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:

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

Returns:

Component[]

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.

Returns:

SequenceAnnotation[]

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.

Returns:

SequenceConstraint[]

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.

Returns:

Sequence[]

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.

Parameters:

NameTypeAttributeDescription
component string | URI | Component
  • optional

public addRole(role: string | URI) source

Assign a role to this ComponentDefinition.

Parameters:

NameTypeAttributeDescription
role string | URI
  • optional

public addSequence(sequence: string | URI | Sequence) source

Add a Sequence to this ComponentDefinition.

Parameters:

NameTypeAttributeDescription
sequence string | URI | Sequence
  • optional

public addSequenceAnnotation(sequenceAnnotation: string | URI | SequenceAnnotation) source

Add a SequenceAnnotation to this ComponentDefinition.

Parameters:

NameTypeAttributeDescription
sequenceAnnotation string | URI | SequenceAnnotation
  • optional

public addSequenceConstraint(sequenceConstraint: string | URI | SequenceConstraint) source

Add a SequenceConstraint to this ComponentDefinition.

Parameters:

NameTypeAttributeDescription
sequenceConstraint string | URI | SequenceConstraint
  • optional

public addType(type: string | URI) source

Assign a type to this ComponentDefinition.

Parameters:

NameTypeAttributeDescription
type string | URI
  • optional

Attempt to resolve the Components, SequenceAnnotations, SequenceConstraints, and Sequences assigned to this ComponentDefinition by URI.