Class Literal

An RDF literal, containing some value which isn't expressed as an IRI.

Link

https://rdf.js.org/data-model-spec/#literal-interface

Hierarchy (view full)

Node
- Literal

Implements

Literal

Index

Constructors

Properties

classOrder datatype isVar language termType value toJS

Accessors

Methods

compareTerm copy equals hashString sameTerm substitute toCanonical toNQ toNT toString fromBoolean fromDate fromNumber fromValue toNT

Constructors

constructor

new Literal(value, language?, datatype?): Literal
Initializes a literal
Parameters
- value: string
  The literal's lexical value
- Optional language: null | string
  The language for the literal. Defaults to ''.
- Optional datatype: any
  The literal's datatype as a named node. Defaults to xsd:string.
Returns Literal
Overrides Node.constructor
- Defined in src/literal.ts:40

Properties

classOrder

classOrder: number = ClassOrder.Literal

The class order for this node

datatype

datatype: NamedNode = XSD.string

The literal's datatype as a named node

isVar

isVar: number = 0

language

language: string = ''

The language for the literal

termType

termType: "Literal" = LiteralTermType

The type of node

value

value: string

The node's value

`Static` toJS

toJS: ((term) => string | boolean | object | Number | Date | (string | boolean | object | Number | Date)[])

Type declaration

- (term): string | boolean | object | Number | Date | (string | boolean | object | Number | Date)[]
- Parameters
  - term: any
  Returns string | boolean | object | Number | Date | (string | boolean | object | Number | Date)[]

Accessors

lang

get lang(): string
The language for the literal

Returns string
Deprecated
use {language} instead
- Defined in src/literal.ts:80
set lang(language): void
Parameters
- language: string
Returns void
- Defined in src/literal.ts:84

Methods

compareTerm

compareTerm(other): number
Compares this node with another
Parameters
- other: Node
  The other node
Returns number
See
to check if two nodes are equal
Inherited from Node.compareTerm
- Defined in src/node-internal.ts:44

copy

copy(): Literal
Gets a copy of this literal

Returns Literal
- Defined in src/literal.ts:56

equals

equals(other): boolean
Gets whether two literals are the same
Parameters
- other: undefined | null | Term
  The other statement
Returns boolean
Implementation of TFLiteral.equals
Overrides Node.equals
- Defined in src/literal.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): 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

substitute

substitute<T>(bindings): T
Creates the substituted node for this one, according to the specified bindings
Type Parameters
- T extends Node<T> = Node
Parameters
- bindings: Bindings
  Bindings of identifiers to nodes
Returns T
Inherited from Node.substitute
- Defined in src/node-internal.ts:35

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/literal.ts:88

toString

toString(): string
Creates a string representation of this node

Returns string
Overrides Node.toString
- Defined in src/literal.ts:118

`Static` fromBoolean

fromBoolean(value): Literal
Builds a literal node from a boolean value
Parameters
- value: boolean
  The value
Returns Literal
- Defined in src/literal.ts:126

`Static` fromDate

fromDate(value): Literal
Builds a literal node from a date value
Parameters
- value: Date
  The value
Returns Literal
- Defined in src/literal.ts:135

`Static` fromNumber

fromNumber(value): Literal
Builds a literal node from a number value
Parameters
- value: number
  The value
Returns Literal
- Defined in src/literal.ts:152

`Static` fromValue

fromValue<T>(value): T
Builds a literal node from an input value
Type Parameters
- T extends FromValueReturns
Parameters
- value: ValueType
  The input value
Returns T
Overrides Node.fromValue
- Defined in src/literal.ts:170

`Static` toNT

toNT(literal): string
Serializes a literal to an N-Triples string
Parameters
- literal: Literal
Returns string
- Defined in src/literal.ts:93