Class TurtleReader

A visitor class that constructs RDF/JS quads from Turtle syntax trees.

Hierarchy

BaseVisitor
- TurtleReader

Constructors

constructor

new TurtleReader(): TurtleReader
Returns TurtleReader
Overrides BaseVisitor.constructor
- Defined in src/turtle/reader.ts:40

Properties

baseIri

baseIri: NamedNode<string> = null

The base IRI of the document.

namespaces

namespaces: Record<string, NamedNode> = {}

A map of prefixes to their namespace IRI.

Methods

annotation

annotation(ctx: TurtleReaderCstContext, quads: Quad[]): void
Process an annotation node: (reifier | annotationBlock)* This is only visited when needed, not always.
Parameters
- ctx: TurtleReaderCstContext
- quads: Quad[]
Returns void
- Defined in src/turtle/reader.ts:1102

annotationBlock

annotationBlock(ctx: TurtleReaderCstContext, quads: Quad[]): void
Process an annotationBlock node: {| predicateObjectList |}
Parameters
- ctx: TurtleReaderCstContext
- quads: Quad[]
Returns void
- Defined in src/turtle/reader.ts:1110

anon

anon(ctx: TurtleReaderCstContext): BlankNode
Parameters
- ctx: TurtleReaderCstContext
Returns BlankNode
- Defined in src/turtle/reader.ts:880

base

base(ctx: TurtleReaderCstContext): DirectiveResult
Parameters
- ctx: TurtleReaderCstContext
Returns DirectiveResult
- Defined in src/turtle/reader.ts:661

blankNode

blankNode(ctx: TurtleReaderCstContext): BlankNode
Parameters
- ctx: TurtleReaderCstContext
Returns BlankNode
- Defined in src/turtle/reader.ts:870

blankNodePropertyList

blankNodePropertyList(ctx: TurtleReaderCstContext, quads: Quad[]): BlankNode[]
Parameters
- ctx: TurtleReaderCstContext
- quads: Quad[]
Returns BlankNode[]
- Defined in src/turtle/reader.ts:852

booleanLiteral

booleanLiteral(ctx: TurtleReaderCstContext): Literal
Parameters
- ctx: TurtleReaderCstContext
Returns Literal
- Defined in src/turtle/reader.ts:899

collection

collection(
ctx: TurtleReaderCstContext,
quads: Quad[],
): BlankNode | NamedNode<string>
Parameters
- ctx: TurtleReaderCstContext
- quads: Quad[]
Returns BlankNode | NamedNode<string>
- Defined in src/turtle/reader.ts:732

datatype

datatype(ctx: TurtleReaderCstContext): NamedNode
Parameters
- ctx: TurtleReaderCstContext
Returns NamedNode
- Defined in src/turtle/reader.ts:989

directive

directive(ctx: TurtleReaderCstContext): DirectiveResult
Parameters
- ctx: TurtleReaderCstContext
Returns DirectiveResult
- Defined in src/turtle/reader.ts:637

getBaseIri

getBaseIri(ctx: TurtleReaderCstContext): DirectiveResult
Parameters
- ctx: TurtleReaderCstContext
Returns DirectiveResult
- Defined in src/turtle/reader.ts:1209

getBlankNode

getBlankNode(ctx: TurtleReaderCstContext): BlankNode
Parameters
- ctx: TurtleReaderCstContext
Returns BlankNode
- Defined in src/turtle/reader.ts:1239

getNamedNode

getNamedNode(ctx: TurtleReaderCstContext): NamedNode
Parameters
- ctx: TurtleReaderCstContext
Returns NamedNode
- Defined in src/turtle/reader.ts:1217

iri

iri(ctx: TurtleReaderCstContext): NamedNode
Parameters
- ctx: TurtleReaderCstContext
Returns NamedNode
- Defined in src/turtle/reader.ts:951

literal

literal(ctx: TurtleReaderCstContext): Literal
Parameters
- ctx: TurtleReaderCstContext
Returns Literal
- Defined in src/turtle/reader.ts:977

numericLiteral

numericLiteral(ctx: TurtleReaderCstContext): Literal
Parameters
- ctx: TurtleReaderCstContext
Returns Literal
- Defined in src/turtle/reader.ts:887

object

object(ctx: TurtleReaderCstContext, quads: Quad[]): Term[]
Parameters
- ctx: TurtleReaderCstContext
- quads: Quad[]
Returns Term[]
- Defined in src/turtle/reader.ts:794

objectList

objectList(ctx: TurtleReaderCstContext, quads: Quad[]): ObjectListResult[]
Parameters
- ctx: TurtleReaderCstContext
- quads: Quad[]
Returns ObjectListResult[]
- Defined in src/turtle/reader.ts:814

predicate

predicate(ctx: TurtleReaderCstContext): NamedNode
Parameters
- ctx: TurtleReaderCstContext
Returns NamedNode
- Defined in src/turtle/reader.ts:784

predicateObjectList

predicateObjectList(
ctx: TurtleReaderCstContext,
quads: Quad[],
): PredicateObjectResult[]
Parameters
- ctx: TurtleReaderCstContext
- quads: Quad[]
Returns PredicateObjectResult[]
- Defined in src/turtle/reader.ts:830

prefix

prefix(ctx: TurtleReaderCstContext): DirectiveResult
Parameters
- ctx: TurtleReaderCstContext
Returns DirectiveResult
- Defined in src/turtle/reader.ts:654

prefixedName

prefixedName(ctx: TurtleReaderCstContext): NamedNode
Parameters
- ctx: TurtleReaderCstContext
Returns NamedNode
- Defined in src/turtle/reader.ts:961

processAnnotation

processAnnotation(
    annotationCtx: TurtleReaderCstContext,
    subject: BlankNode | NamedNode<string>,
    predicate: NamedNode,
    object: Term,
    quads: Quad[],
): void
Process annotation context from the CST. Annotations create reifiers and emit triples.
Parameters
- annotationCtx: TurtleReaderCstContext
- subject: BlankNode | NamedNode<string>
- predicate: NamedNode
- object: Term
- quads: Quad[]
Returns void
- Defined in src/turtle/reader.ts:1119

readQuadContexts

readQuadContexts(ctx: CstNode, tokens?: IToken[]): QuadContext[]
Parse the document and return quad information with source tokens. This is useful for IDE features that need to associate positions with triples.
Parameters
- ctx: CstNode
- Optionaltokens: IToken[]
Returns QuadContext[]
- Defined in src/turtle/reader.ts:124

reifiedTriple

reifiedTriple(
ctx: TurtleReaderCstContext,
quads: Quad[],
): BlankNode | NamedNode<string>
Process a reifiedTriple node. Returns the reifier node (IRI or blank node). Emits: reifierNode rdf:reifies <<( s p o )>> .
Parameters
- ctx: TurtleReaderCstContext
- quads: Quad[]
Returns BlankNode | NamedNode<string>
- Defined in src/turtle/reader.ts:1001

reifier

reifier(ctx: TurtleReaderCstContext): BlankNode | NamedNode<string>
Process a reifier node: ~ (iri | BlankNode)? Returns the reifier term (IRI, blank node, or fresh blank node).
Parameters
- ctx: TurtleReaderCstContext
Returns BlankNode | NamedNode<string>
- Defined in src/turtle/reader.ts:1085

rtObject

rtObject(ctx: TurtleReaderCstContext, quads: Quad[]): Term
Parameters
- ctx: TurtleReaderCstContext
- quads: Quad[]
Returns Term
- Defined in src/turtle/reader.ts:1035

rtSubject

rtSubject(
ctx: TurtleReaderCstContext,
quads: Quad[],
): BlankNode | NamedNode<string>
Parameters
- ctx: TurtleReaderCstContext
- quads: Quad[]
Returns BlankNode | NamedNode<string>
- Defined in src/turtle/reader.ts:1025

sparqlBase

sparqlBase(ctx: TurtleReaderCstContext): DirectiveResult
Parameters
- ctx: TurtleReaderCstContext
Returns DirectiveResult
- Defined in src/turtle/reader.ts:672

sparqlPrefix

sparqlPrefix(ctx: TurtleReaderCstContext): DirectiveResult
Parameters
- ctx: TurtleReaderCstContext
Returns DirectiveResult
- Defined in src/turtle/reader.ts:665

sparqlVersion

sparqlVersion(ctx: TurtleReaderCstContext): DirectiveResult
Parameters
- ctx: TurtleReaderCstContext
Returns DirectiveResult
- Defined in src/turtle/reader.ts:681

string

string(ctx: TurtleReaderCstContext): string
Parameters
- ctx: TurtleReaderCstContext
Returns string
- Defined in src/turtle/reader.ts:926

stringLiteral

stringLiteral(ctx: TurtleReaderCstContext): Literal
Parameters
- ctx: TurtleReaderCstContext
Returns Literal
- Defined in src/turtle/reader.ts:909

subject

subject(
ctx: TurtleReaderCstContext,
quads: Quad[],
): BlankNode | NamedNode<string>
Parameters
- ctx: TurtleReaderCstContext
- quads: Quad[]
Returns BlankNode | NamedNode<string>
- Defined in src/turtle/reader.ts:774

triples

triples(ctx: TurtleReaderCstContext): Quad[]
Parameters
- ctx: TurtleReaderCstContext
Returns Quad[]
- Defined in src/turtle/reader.ts:689

tripleTerm

tripleTerm(ctx: TurtleReaderCstContext): Quad
Process a tripleTerm node: <<( s p o )>> Returns a triple term (RDF/JS Quad used as a term).
Parameters
- ctx: TurtleReaderCstContext
Returns Quad
- Defined in src/turtle/reader.ts:1053

ttObject

ttObject(ctx: TurtleReaderCstContext): Term
Parameters
- ctx: TurtleReaderCstContext
Returns Term
- Defined in src/turtle/reader.ts:1069

ttSubject

ttSubject(ctx: TurtleReaderCstContext): BlankNode | NamedNode<string>
Parameters
- ctx: TurtleReaderCstContext
Returns BlankNode | NamedNode<string>
- Defined in src/turtle/reader.ts:1061

turtleDoc

turtleDoc(ctx: TurtleReaderCstContext): Quad[]
Parameters
- ctx: TurtleReaderCstContext
Returns Quad[]
- Defined in src/turtle/reader.ts:46

unescapeString

unescapeString(raw: string): string
Interpret escape sequences in a Turtle string value.
Parameters
- raw: string
Returns string
- Defined in src/turtle/reader.ts:947

validateVisitor

validateVisitor(): void
Will throw an error if the visitor is missing any required methods
- visitXYZ for each XYZ grammar rule.
Returns void
Inherited from BaseVisitor.validateVisitor
- Defined in node_modules/@chevrotain/types/api.d.ts:1912

version

version(ctx: TurtleReaderCstContext): DirectiveResult
Parameters
- ctx: TurtleReaderCstContext
Returns DirectiveResult
- Defined in src/turtle/reader.ts:676

versionSpecifier

versionSpecifier(ctx: TurtleReaderCstContext): DirectiveResult
Parameters
- ctx: TurtleReaderCstContext
Returns DirectiveResult
- Defined in src/turtle/reader.ts:685

visit

visit(cstNode: CstNode | CstNode[], param?: any): any
Parameters
- cstNode: CstNode | CstNode[]
- Optionalparam: any
Returns any
Inherited from BaseVisitor.visit
- Defined in node_modules/@chevrotain/types/api.d.ts:1906

Class TurtleReader

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns TurtleReader

Properties

baseIri

namespaces

Methods

annotation

Parameters

Returns void

annotationBlock

Parameters

Returns void

anon

Parameters

Returns BlankNode

base

Parameters

Returns DirectiveResult

blankNode

Parameters

Returns BlankNode

blankNodePropertyList

Parameters

Returns BlankNode[]

booleanLiteral

Parameters

Returns Literal

collection

Parameters

Returns BlankNode | NamedNode<string>

datatype

Parameters

Returns NamedNode

directive

Parameters

Returns DirectiveResult

getBaseIri

Parameters

Returns DirectiveResult

getBlankNode

Parameters

Returns BlankNode

getNamedNode

Parameters

Returns NamedNode

iri

Parameters

Returns NamedNode

literal

Parameters

Returns Literal

numericLiteral

Parameters

Returns Literal

object

Parameters

Returns Term[]

objectList

Parameters

Returns ObjectListResult[]

predicate

Parameters

Returns NamedNode

predicateObjectList

Parameters

Returns PredicateObjectResult[]

prefix

Parameters

Returns DirectiveResult

prefixedName

Parameters

Returns NamedNode

processAnnotation