Class Collection<T>

A collection of other RDF nodes

Use generic T to control the contents of the array.

Type Parameters

T extends Node = Node | BlankNode | Collection<any> | Literal | Variable

Hierarchy (View Summary)

Node
- Collection

Implements

Term

Index

Constructors

constructor

Properties

classOrder closed compareTerm elements isVar termType value fromValue termType toJS

Accessors

Methods

append close equals hashString sameTerm shift substitute toCanonical toNQ toNT toString unshift toNT

Constructors

constructor

new Collection<
    T extends Node = Node
    | BlankNode
    | Collection<any>
    | Literal
    | Variable,
>(
    initial?: readonly ValueType[],
): Collection<T>
Type Parameters
- T extends Node = Node | BlankNode | Collection<any> | Literal | Variable
Parameters
- Optionalinitial: readonly ValueType[]
Returns Collection<T>
Overrides Node.constructor
- Defined in src/collection.ts:59

Properties

classOrder

classOrder: number = ClassOrder.Collection

The class order for this node

closed

closed: boolean = false

compareTerm

compareTerm: (other: BlankNode) => number = RdflibBlankNode.prototype.compareTerm

Compares this node with another

Type Declaration

- (other: BlankNode): number
- Parameters
  - other: BlankNode
    The other node
  Returns number

See

to check if two nodes are equal

elements

elements: T[] = []

The nodes in this collection

isVar

isVar: number = 0

termType

termType: "Collection" = CollectionTermType

The type of node

value

value: string

The node's value

`Static`fromValue

fromValue: <T extends FromValueReturns>(value: ValueType) => T

`Static`termType

termType: "Collection" = CollectionTermType

`Static`toJS

Accessors

id

get id(): string
Returns string
- Defined in src/collection.ts:69
set id(value: string): void
Parameters
- value: string
Returns void
- Defined in src/collection.ts:73

Methods

append

append(element: T): number
Appends an element to this collection
Parameters
- element: T
  The new element
Returns number
- Defined in src/collection.ts:81

close

close(): boolean
Closes this collection

Returns boolean
- Defined in src/collection.ts:88

equals

equals(other: Term | null | undefined): boolean
Compares whether the two nodes are equal
Parameters
- other: Term | null | undefined
  The other node
Returns boolean
Implementation of Term.equals
Inherited from Node.equals
- Defined in src/node-internal.ts:64

hashString

hashString(): string
Creates a hash for this node

Returns string
Deprecated
use {rdfFactory.id} instead if possible
Inherited from Node.hashString
- Defined in src/node-internal.ts:76

sameTerm

sameTerm(other: Node): boolean
Compares whether this node is the same as the other one
Parameters
- other: Node
  Another node
Returns boolean
Inherited from Node.sameTerm
- Defined in src/node-internal.ts:84

shift

shift(): T | undefined
Removes the first element from the collection (and return it)

Returns T | undefined
- Defined in src/collection.ts:96

substitute

substitute(bindings: Bindings): any
Creates a new Collection with the substituting bindings applied
Parameters
- bindings: Bindings
  The bindings to substitute
Returns any
Overrides Node.substitute
- Defined in src/collection.ts:104

toCanonical

toCanonical(): string
Creates a canonical string representation of this node

Returns string
Inherited from Node.toCanonical
- Defined in src/node-internal.ts:92

toNQ

toNQ(): string
Creates a n-quads string representation of this node

Returns string
Inherited from Node.toNQ
- Defined in src/node-internal.ts:106

toNT

toNT(): string
Creates a n-triples string representation of this node

Returns string
Overrides Node.toNT
- Defined in src/collection.ts:110

toString

toString(): string
Serializes the collection to a string. Surrounded by (parentheses) and separated by spaces.

Returns string
Overrides Node.toString
- Defined in src/collection.ts:124

unshift

unshift(element: T): number
Prepends the specified element to the collection's front
Parameters
- element: T
  The element to prepend
Returns number
- Defined in src/collection.ts:132

`Static`toNT

toNT(collection: any): string
Parameters
- collection: any
Returns string
- Defined in src/collection.ts:114

Class Collection<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Collection<T>

Properties

classOrder

closed

compareTerm

Type Declaration

Parameters

Returns number

See

elements

isVar

termType

value

StaticfromValue

StatictermType

StatictoJS

Accessors

id

Returns string

Parameters

Returns void

Methods

append

Parameters

Returns number

close

Returns boolean

equals

Parameters

Returns boolean

hashString

Returns string

Deprecated

sameTerm

Parameters

Returns boolean

shift

Returns T | undefined

substitute

Parameters

Returns any

toCanonical

Returns string

toNQ

Returns string

toNT

Returns string

toString

Returns string

unshift

Parameters

Returns number

StatictoNT

Parameters

Returns string

Settings

On This Page

`Static`fromValue

`Static`termType

`Static`toJS

`Static`toNT