Home Reference Source
public class | source

Identified

Base class for all Identified SBOL2 objects.

Constructor Summary

Public Constructor
public

constructor(sbolDocument: *, uri: *)

Member Summary

Public Members
public get

Retrieve the annotations for this Identified.
public get

Retrieve the description of this Identified.
public set

description(description: string | URI): *

Set the description of this Identified.
public set

displayId(displayId: string | URI): *

Set the display ID of this Identified.
public get

Retrieve the display ID of this Identified.
public set

name(name: string | URI): *

Set the name of this Identified.
public get

name: string: *

Retrieve the name of this Identified.
public get

Retrieve the persistentIdentity of this Identified.
public set

persistentIdentity(persistentIdentity: string | URI): *

Set the persistentIdentity of this Identified.
public get

uri: URI: *

Retrieve the URI of this Identified.
public set

uri(uri: string | URI): *

Set the URI of this Identified.
public get

Retrieve the version of this Identified.
public set

version(version: string | URI): *

Set the version of this Identified.
public set

wasDerivedFrom(wasDerivedFrom: string | URI): *

Set the wasDerivedFrom property of this Identified.
public get

wasDerivedFrom: URI: *

Retrieve the wasDerivedFrom property of this Identified.

Method Summary

Public Methods
public

addAnnotation(name: string, value: string)

Add an annotation to this Identified.
public

getAnnotation(name: *): string

Retrieve the first matching annotation for a given URI.
public

getAnnotations(name: *): string[]

Retrieve all annotations for a given URI

Public Constructors

public constructor(sbolDocument: *, uri: *) source

Parameters:

NameTypeAttributeDescription
sbolDocument *
uri *

Public Members

public get annotations: Object[]: * source

Retrieve the annotations for this Identified.

Properties:

NameTypeAttributeDescription
name string
  • optional

The URI of the annotation
value string
  • optional

The annotation value

Returns:

Object[]

Return Properties:

NameTypeAttributeDescription
name string
  • optional

The URI of the annotation
value string
  • optional

The annotation value

public get description: string: * source

Retrieve the description of this Identified.

Returns:

string

public set description(description: string | URI): * source

Set the description of this Identified.

public set displayId(displayId: string | URI): * source

Set the display ID of this Identified.

public get displayId: string: * source

Retrieve the display ID of this Identified.

Returns:

string

public set name(name: string | URI): * source

Set the name of this Identified.

public get name: string: * source

Retrieve the name of this Identified.

Returns:

string

public get persistentIdentity: URI: * source

Retrieve the persistentIdentity of this Identified.

Returns:

URI

public set persistentIdentity(persistentIdentity: string | URI): * source

Set the persistentIdentity of this Identified.

public get uri: URI: * source

Retrieve the URI of this Identified.

Returns:

URI

public set uri(uri: string | URI): * source

Set the URI of this Identified.

public get version: string: * source

Retrieve the version of this Identified.

Returns:

string

public set version(version: string | URI): * source

Set the version of this Identified.

public set wasDerivedFrom(wasDerivedFrom: string | URI): * source

Set the wasDerivedFrom property of this Identified.

public get wasDerivedFrom: URI: * source

Retrieve the wasDerivedFrom property of this Identified.

Returns:

URI

Public Methods

public addAnnotation(name: string, value: string) source

Add an annotation to this Identified.

Parameters:

NameTypeAttributeDescription
name string
  • optional

The URI of the annotation
value string
  • optional

The annotation value

public getAnnotation(name: *): string source

Retrieve the first matching annotation for a given URI.

Parameters:

NameTypeAttributeDescription
name *

Returns:

string

The annotation value, or undefined.

public getAnnotations(name: *): string[] source

Retrieve all annotations for a given URI

Parameters:

NameTypeAttributeDescription
name *

Returns:

string[]

A list of annotation values