Class AstFactory

A factory that helps you create, and check types for AST nodes for SPARQL 1.2

Hierarchy (View Summary)

AstFactory
- AstFactory

Index

Constructors

constructor

new AstFactory(args?: Partial<AstCoreFactoryArgs>): AstFactory
Parameters
- Optionalargs: Partial<AstCoreFactoryArgs>
Returns AstFactory
Inherited from AstFactory.constructor
- Defined in core/dist/esm/lib/AstCoreFactory.d.ts:16

Properties

__blankNodeCounter

__blankNodeCounter: number

tracksSourceLocation

tracksSourceLocation: boolean

Whether this AstFactory will track source location. Default: true. In case source location is not tracked, each generated node using this factory will be SourceLocationNodeAutoGenerate

triple

Overwritten triple constructor to always contain an empty annotations list

Methods

aggregate

aggregate(
    aggregation: string,
    distinct: boolean,
    arg: Expression,
    separator: undefined,
    loc: SourceLocation,
): ExpressionAggregateDefault
Parameters
- aggregation: string
- distinct: boolean
- arg: Expression
- separator: undefined
- loc: SourceLocation
Returns ExpressionAggregateDefault
Inherited from AstFactory.aggregate
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:368
aggregate(
    aggregation: string,
    distinct: boolean,
    arg: Wildcard,
    separator: undefined,
    loc: SourceLocation,
): ExpressionAggregateOnWildcard
Parameters
- aggregation: string
- distinct: boolean
- arg: Wildcard
- separator: undefined
- loc: SourceLocation
Returns ExpressionAggregateOnWildcard
Inherited from AstFactory.aggregate
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:369
aggregate(
    aggregation: string,
    distinct: boolean,
    arg: Expression,
    separator: string,
    loc: SourceLocation,
): ExpressionAggregateSeparator
Parameters
- aggregation: string
- distinct: boolean
- arg: Expression
- separator: string
- loc: SourceLocation
Returns ExpressionAggregateSeparator
Inherited from AstFactory.aggregate
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:370
aggregate(
    aggregation: string,
    distinct: boolean,
    arg: Expression | Wildcard,
    separator: string | undefined,
    loc: SourceLocation,
): ExpressionAggregate
Parameters
- aggregation: string
- distinct: boolean
- arg: Expression | Wildcard
- separator: string | undefined
- loc: SourceLocation
Returns ExpressionAggregate
Inherited from AstFactory.aggregate
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:371

alwaysSparql11

alwaysSparql11(obj: object): obj is Sparql11Nodes
Parameters
- obj: object
Returns obj is Sparql11Nodes
Inherited from AstFactory.alwaysSparql11
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:449

annotatedTriple

annotatedTriple(
    subject: GraphNode,
    predicate:
        | TermIriFull
        | TermIriPrefixed
        | TermVariable
        | PropertyPathChain
        | PathModified
        | PathNegated,
    object: GraphNode,
    annotations?: Annotation[],
    loc?: SourceLocation,
): TripleNesting
Parameters
- subject: GraphNode
- predicate:
      | TermIriFull
      | TermIriPrefixed
      | TermVariable
      | PropertyPathChain
      | PathModified
      | PathNegated
- object: GraphNode
- Optionalannotations: Annotation[]
- Optionalloc: SourceLocation
Returns TripleNesting
- Defined in rules-sparql-1-2/lib/AstFactory.ts:87

contextDefinitionBase

contextDefinitionBase(
loc: SourceLocation,
value: TermIriFull,
): ContextDefinitionBase
Parameters
- loc: SourceLocation
- value: TermIriFull
Returns ContextDefinitionBase
Inherited from AstFactory.contextDefinitionBase
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:414

contextDefinitionPrefix

contextDefinitionPrefix(
    loc: SourceLocation,
    key: string,
    value: TermIriFull,
): ContextDefinitionPrefix
Parameters
- loc: SourceLocation
- key: string
- value: TermIriFull
Returns ContextDefinitionPrefix
Inherited from AstFactory.contextDefinitionPrefix
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:412

contextDefinitionVersion

contextDefinitionVersion(
version: string,
loc: SourceLocation,
): ContextDefinitionVersion
Parameters
- version: string
- loc: SourceLocation
Returns ContextDefinitionVersion
- Defined in rules-sparql-1-2/lib/AstFactory.ts:104

datasetClauses

datasetClauses(
clauses: { clauseType: "default" | "named"; value: TermIri }[],
loc: SourceLocation,
): DatasetClauses
Parameters
- clauses: { clauseType: "default" | "named"; value: TermIri }[]
- loc: SourceLocation
Returns DatasetClauses
Inherited from AstFactory.datasetClauses
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:455

dematerialized

dematerialized<T extends Node>(arg: T): T
Returns a copy of the argument that is not materialized
Type Parameters
- T extends Node
Parameters
- arg: T
Returns T
Inherited from AstFactory.dematerialized
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:45

expressionFunctionCall

expressionFunctionCall<Args extends Expression[]>(
    functionOp: TermIri,
    args: Args,
    distinct: boolean,
    loc: SourceLocation,
): Node & { subType: string; type: "expression" } & {
    args: Expression[];
    distinct: boolean;
    function: TermIri;
    subType: "functionCall";
} & { args: Args }
Type Parameters
- Args extends Expression[]
Parameters
- functionOp: TermIri
- args: Args
- distinct: boolean
- loc: SourceLocation
Returns Node & { subType: string; type: "expression" } & {
    args: Expression[];
    distinct: boolean;
    function: TermIri;
    subType: "functionCall";
} & { args: Args }
Inherited from AstFactory.expressionFunctionCall
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:354

expressionOperation

expressionOperation<Args extends Expression[]>(
    operator: string,
    args: Args,
    loc: SourceLocation,
): Node & { subType: string; type: "expression" } & {
    args: Expression[];
    operator: string;
    subType: "operation";
} & { args: Args }
Type Parameters
- Args extends Expression[]
Parameters
- operator: string
- args: Args
- loc: SourceLocation
Returns Node & { subType: string; type: "expression" } & {
    args: Expression[];
    operator: string;
    subType: "operation";
} & { args: Args }
Inherited from AstFactory.expressionOperation
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:343

expressionPatternOperation

expressionPatternOperation(
    operator: string,
    args: PatternGroup,
    loc: SourceLocation,
): ExpressionPatternOperation
Parameters
- operator: string
- args: PatternGroup
- loc: SourceLocation
Returns ExpressionPatternOperation
Inherited from AstFactory.expressionPatternOperation
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:366

forcedAutoGenTree

forcedAutoGenTree<T extends object>(obj: T): T
Given a (AST) tree, return a copy of that tree where it and it's descendents all have a SourceLocationNodeAutoGenerate localization.
Type Parameters
- T extends object
Parameters
- obj: T
Returns T
Inherited from AstFactory.forcedAutoGenTree
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:47

forceMaterialized

forceMaterialized<T extends Node>(arg: T): T
In case the provided Node is not yet materialized, force it to be autoGenerated.
Type Parameters
- T extends Node
Parameters
- arg: T
Returns T
Inherited from AstFactory.forceMaterialized
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:48

formatOperator

formatOperator(operator: string): string
Parameters
- operator: string
Returns string
Inherited from AstFactory.formatOperator
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:342

gen

gen(): SourceLocationNodeAutoGenerate
Create a SourceLocation indicating the node should be autoGenerated by a generator.

Returns SourceLocationNodeAutoGenerate
Inherited from AstFactory.gen
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:53

graphNodeIdentifier

graphNodeIdentifier(graphNode: GraphNode): Term
Parameters
- graphNode: GraphNode
Returns Term
Inherited from AstFactory.graphNodeIdentifier
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:452

graphQuads

graphQuads(
    graph: TermIri | TermVariable,
    triples: PatternBgp,
    loc: SourceLocation,
): GraphQuads
Parameters
- graph: TermIri | TermVariable
- triples: PatternBgp
- loc: SourceLocation
Returns GraphQuads
Inherited from AstFactory.graphQuads
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:464

graphRefAll

graphRefAll(loc: SourceLocation): GraphRefAll
Parameters
- loc: SourceLocation
Returns GraphRefAll
Inherited from AstFactory.graphRefAll
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:307

graphRefDefault

graphRefDefault(loc: SourceLocation): GraphRefDefault
Parameters
- loc: SourceLocation
Returns GraphRefDefault
Inherited from AstFactory.graphRefDefault
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:303

graphRefNamed

graphRefNamed(loc: SourceLocation): GraphRefNamed
Parameters
- loc: SourceLocation
Returns GraphRefNamed
Inherited from AstFactory.graphRefNamed
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:305

graphRefSpecific

graphRefSpecific(graph: TermIri, loc: SourceLocation): GraphRefSpecific
Parameters
- graph: TermIri
- loc: SourceLocation
Returns GraphRefSpecific
Inherited from AstFactory.graphRefSpecific
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:309

isContextDefinitionBase

isContextDefinitionBase(
contextDef: object,
): contextDef is SubTyped<"contextDef", "base">
Parameters
- contextDef: object
Returns contextDef is SubTyped<"contextDef", "base">
Inherited from AstFactory.isContextDefinitionBase
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:415

isContextDefinitionPrefix

isContextDefinitionPrefix(
contextDef: object,
): contextDef is SubTyped<"contextDef", "prefix">
Parameters
- contextDef: object
Returns contextDef is SubTyped<"contextDef", "prefix">
Inherited from AstFactory.isContextDefinitionPrefix
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:413

isContextDefinitionVersion

isContextDefinitionVersion(
obj: object,
): obj is SubTyped<"contextDef", "version">
Parameters
- obj: object
Returns obj is SubTyped<"contextDef", "version">
- Defined in rules-sparql-1-2/lib/AstFactory.ts:113

isDatasetClauses

isDatasetClauses(obj: object): obj is Typed<"datasetClauses">
Parameters
- obj: object
Returns obj is Typed<"datasetClauses">
Inherited from AstFactory.isDatasetClauses
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:456

isExpression

isExpression(
    obj: object,
): obj is
    | Typed<"expression">
    | SubTyped<"term", "variable" | "literal" | "namedNode">
Parameters
- obj: object
Returns obj is
| Typed<"expression">
| SubTyped<"term", "variable" | "literal" | "namedNode">
Inherited from AstFactory.isExpression
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:451

isExpressionAggregate

isExpressionAggregate(obj: object): obj is SubTyped<"expression", "aggregate">
Parameters
- obj: object
Returns obj is SubTyped<"expression", "aggregate">
Inherited from AstFactory.isExpressionAggregate
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:372

isExpressionAggregateDefault

isExpressionAggregateDefault(
obj: object,
): obj is SubTyped<"expression", "aggregate"> & { expression: [Expression] }
Parameters
- obj: object
Returns obj is SubTyped<"expression", "aggregate"> & { expression: [Expression] }
Inherited from AstFactory.isExpressionAggregateDefault
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:379

isExpressionAggregateOnWildcard

isExpressionAggregateOnWildcard(
obj: object,
): obj is SubTyped<"expression", "aggregate"> & {
expression: [Typed<"wildcard">];
}
Parameters
- obj: object
Returns obj is SubTyped<"expression", "aggregate"> & { expression: [Typed<"wildcard">] }
Inherited from AstFactory.isExpressionAggregateOnWildcard
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:376

isExpressionAggregateSeparator

isExpressionAggregateSeparator(
obj: object,
): obj is SubTyped<"expression", "aggregate"> & { separator: string }
Parameters
- obj: object
Returns obj is SubTyped<"expression", "aggregate"> & { separator: string }
Inherited from AstFactory.isExpressionAggregateSeparator
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:373

isExpressionFunctionCall

isExpressionFunctionCall(
obj: object,
): obj is SubTyped<"expression", "functionCall">
Parameters
- obj: object
Returns obj is SubTyped<"expression", "functionCall">
Inherited from AstFactory.isExpressionFunctionCall
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:365

isExpressionOperator

isExpressionOperator(obj: object): obj is SubTyped<"expression", "operation">
Parameters
- obj: object
Returns obj is SubTyped<"expression", "operation">
Inherited from AstFactory.isExpressionOperator
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:353

isExpressionPatternOperation

isExpressionPatternOperation(
obj: object,
): obj is SubTyped<"expression", "patternOperation">
Parameters
- obj: object
Returns obj is SubTyped<"expression", "patternOperation">
Inherited from AstFactory.isExpressionPatternOperation
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:367

isExpressionPure

isExpressionPure(obj: object): obj is Typed<"expression">
Parameters
- obj: object
Returns obj is Typed<"expression">
Inherited from AstFactory.isExpressionPure
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:341

isGraphQuads

isGraphQuads(obj: object): obj is GraphQuads
Parameters
- obj: object
Returns obj is GraphQuads
Inherited from AstFactory.isGraphQuads
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:465

isGraphRef

isGraphRef(obj: object): obj is Typed<"graphRef">
Parameters
- obj: object
Returns obj is Typed<"graphRef">
Inherited from AstFactory.isGraphRef
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:302

isGraphRefAll

isGraphRefAll(graphRef: object): graphRef is SubTyped<"graphRef", "all">
Parameters
- graphRef: object
Returns graphRef is SubTyped<"graphRef", "all">
Inherited from AstFactory.isGraphRefAll
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:308

isGraphRefDefault

isGraphRefDefault(graphRef: object): graphRef is SubTyped<"graphRef", "default">
Parameters
- graphRef: object
Returns graphRef is SubTyped<"graphRef", "default">
Inherited from AstFactory.isGraphRefDefault
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:304

isGraphRefNamed

isGraphRefNamed(graphRef: object): graphRef is SubTyped<"graphRef", "named">
Parameters
- graphRef: object
Returns graphRef is SubTyped<"graphRef", "named">
Inherited from AstFactory.isGraphRefNamed
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:306

isGraphRefSpecific

isGraphRefSpecific(
graphRef: object,
): graphRef is SubTyped<"graphRef", "specific">
Parameters
- graphRef: object
Returns graphRef is SubTyped<"graphRef", "specific">
Inherited from AstFactory.isGraphRefSpecific
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:310

isLocalized

isLocalized(obj: unknown): obj is Localized
Whether the provided value is an object that tracks source location.
Parameters
- obj: unknown
Returns obj is Localized
Inherited from AstFactory.isLocalized
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:42

isOfSubType

isOfSubType<Type extends string, SubType extends string>(
    obj: object,
    type: Type,
    subType: SubType,
): obj is SubTyped<Type, SubType>
Guard to check if an object is the specified Type: SubTyped.
Type Parameters
- Type extends string
- SubType extends string
Parameters
- obj: object
- type: Type
- subType: SubType
Returns obj is SubTyped<Type, SubType>
Inherited from AstFactory.isOfSubType
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:66

isOfType

isOfType<Type extends string>(obj: object, type: Type): obj is Typed<Type>
Guard to check if an object is the specified Type: Typed.
Type Parameters
- Type extends string
Parameters
- obj: object
- type: Type
Returns obj is Typed<Type>
Inherited from AstFactory.isOfType
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:65

isPath

isPath(obj: object): obj is SubTyped<"term", "namedNode"> | Typed<"path">
Parameters
- obj: object
Returns obj is SubTyped<"term", "namedNode"> | Typed<"path">
Inherited from AstFactory.isPath
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:450

isPathAlternativeLimited

isPathAlternativeLimited(
    obj: object,
): obj is SubTyped<"path", "|"> & {
    items: (
        | SubTyped<"term", "namedNode">
        | SubTyped<"path", "^"> & { items: [SubTyped<"term", "namedNode">] }
    )[];
}
Parameters
- obj: object
Returns obj is SubTyped<"path", "|"> & {
    items: (
        | SubTyped<"term", "namedNode">
        | SubTyped<"path", "^"> & { items: [SubTyped<"term", "namedNode">] }
    )[];
}
Inherited from AstFactory.isPathAlternativeLimited
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:267

isPathChain

isPathChain(obj: object): obj is SubTyped<"path", "|" | "/">
Parameters
- obj: object
Returns obj is SubTyped<"path", "|" | "/">
Inherited from AstFactory.isPathChain
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:261

isPathModified

isPathModified(obj: object): obj is SubTyped<"path", "?" | "*" | "+" | "^">
Parameters
- obj: object
Returns obj is SubTyped<"path", "?" | "*" | "+" | "^">
Inherited from AstFactory.isPathModified
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:262

isPathNegated

isPathNegated(obj: object): obj is SubTyped<"path", "!">
Parameters
- obj: object
Returns obj is SubTyped<"path", "!">
Inherited from AstFactory.isPathNegated
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:266

isPathNegatedElt

isPathNegatedElt(
obj: object,
): obj is SubTyped<"path", "^"> & { items: [SubTyped<"term", "namedNode">] }
Parameters
- obj: object
Returns obj is SubTyped<"path", "^"> & { items: [SubTyped<"term", "namedNode">] }
Inherited from AstFactory.isPathNegatedElt
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:263

isPathOfType

isPathOfType<T extends U[], U extends string>(
obj: object,
subTypes: T,
): obj is SubTyped<"path", U>
Type Parameters
- T extends U[]
- U extends string
Parameters
- obj: object
- subTypes: T
Returns obj is SubTyped<"path", U>
Inherited from AstFactory.isPathOfType
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:260

isPathPure

isPathPure(obj: object): obj is Typed<"path">
Parameters
- obj: object
Returns obj is Typed<"path">
Inherited from AstFactory.isPathPure
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:254

isPattern

isPattern(obj: object): obj is Typed<"pattern">
Parameters
- obj: object
Returns obj is Typed<"pattern">
Inherited from AstFactory.isPattern
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:203

isPatternBgp

isPatternBgp(obj: object): obj is SubTyped<"pattern", "bgp">
Parameters
- obj: object
Returns obj is SubTyped<"pattern", "bgp">
Inherited from AstFactory.isPatternBgp
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:205

isPatternBind

isPatternBind(obj: object): obj is SubTyped<"pattern", "bind">
Parameters
- obj: object
Returns obj is SubTyped<"pattern", "bind">
Inherited from AstFactory.isPatternBind
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:217

isPatternFilter

isPatternFilter(obj: object): obj is SubTyped<"pattern", "filter">
Parameters
- obj: object
Returns obj is SubTyped<"pattern", "filter">
Inherited from AstFactory.isPatternFilter
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:215

isPatternGraph

isPatternGraph(obj: object): obj is SubTyped<"pattern", "graph">
Parameters
- obj: object
Returns obj is SubTyped<"pattern", "graph">
Inherited from AstFactory.isPatternGraph
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:209

isPatternGroup

isPatternGroup(obj: object): obj is SubTyped<"pattern", "group">
Parameters
- obj: object
Returns obj is SubTyped<"pattern", "group">
Inherited from AstFactory.isPatternGroup
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:207

isPatternMinus

isPatternMinus(obj: object): obj is SubTyped<"pattern", "minus">
Parameters
- obj: object
Returns obj is SubTyped<"pattern", "minus">
Inherited from AstFactory.isPatternMinus
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:221

isPatternOptional

isPatternOptional(obj: object): obj is SubTyped<"pattern", "optional">
Parameters
- obj: object
Returns obj is SubTyped<"pattern", "optional">
Inherited from AstFactory.isPatternOptional
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:211

isPatternService

isPatternService(obj: object): obj is SubTyped<"pattern", "service">
Parameters
- obj: object
Returns obj is SubTyped<"pattern", "service">
Inherited from AstFactory.isPatternService
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:223

isPatternUnion

isPatternUnion(obj: object): obj is SubTyped<"pattern", "union">
Parameters
- obj: object
Returns obj is SubTyped<"pattern", "union">
Inherited from AstFactory.isPatternUnion
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:219

isPatternValues

isPatternValues(obj: object): obj is SubTyped<"pattern", "values">
Parameters
- obj: object
Returns obj is SubTyped<"pattern", "values">
Inherited from AstFactory.isPatternValues
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:213

isPrintingLoc

isPrintingLoc(loc: SourceLocation): boolean
Check whether the provided SourceLocation expects the generator to autoGenerate.
Parameters
- loc: SourceLocation
Returns boolean
Inherited from AstFactory.isPrintingLoc
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:62

isQuery

isQuery(obj: object): obj is Typed<"query">
Parameters
- obj: object
Returns obj is Typed<"query">
Inherited from AstFactory.isQuery
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:166

isQueryAsk

isQueryAsk(obj: object): obj is SubTyped<"query", "ask">
Parameters
- obj: object
Returns obj is SubTyped<"query", "ask">
Inherited from AstFactory.isQueryAsk
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:171

isQueryConstruct

isQueryConstruct(obj: object): obj is SubTyped<"query", "construct">
Parameters
- obj: object
Returns obj is SubTyped<"query", "construct">
Inherited from AstFactory.isQueryConstruct
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:169

isQueryDescribe

isQueryDescribe(obj: object): obj is SubTyped<"query", "describe">
Parameters
- obj: object
Returns obj is SubTyped<"query", "describe">
Inherited from AstFactory.isQueryDescribe
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:170

isQuerySelect

isQuerySelect(obj: object): obj is SubTyped<"query", "select">
Parameters
- obj: object
Returns obj is SubTyped<"query", "select">
Inherited from AstFactory.isQuerySelect
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:167

isSolutionModifier

isSolutionModifier(obj: object): obj is Typed<"solutionModifier">
Parameters
- obj: object
Returns obj is Typed<"solutionModifier">
Inherited from AstFactory.isSolutionModifier
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:127

isSolutionModifierGroup

isSolutionModifierGroup(
obj: object,
): obj is SubTyped<"solutionModifier", "group">
Parameters
- obj: object
Returns obj is SubTyped<"solutionModifier", "group">
Inherited from AstFactory.isSolutionModifierGroup
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:135

isSolutionModifierHaving

isSolutionModifierHaving(
obj: object,
): obj is SubTyped<"solutionModifier", "having">
Parameters
- obj: object
Returns obj is SubTyped<"solutionModifier", "having">
Inherited from AstFactory.isSolutionModifierHaving
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:129

isSolutionModifierLimitOffset

isSolutionModifierLimitOffset(
obj: object,
): obj is SubTyped<"solutionModifier", "limitOffset">
Parameters
- obj: object
Returns obj is SubTyped<"solutionModifier", "limitOffset">
Inherited from AstFactory.isSolutionModifierLimitOffset
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:133

isSolutionModifierOrder

isSolutionModifierOrder(
obj: object,
): obj is SubTyped<"solutionModifier", "order">
Parameters
- obj: object
Returns obj is SubTyped<"solutionModifier", "order">
Inherited from AstFactory.isSolutionModifierOrder
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:131

isSourceLocation

isSourceLocation(loc: object): loc is SourceLocation
Check whether an object is in fact a SourceLocation.
Parameters
- loc: object
Returns loc is SourceLocation
Inherited from AstFactory.isSourceLocation
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:49

isSourceLocationInlinedSource

isSourceLocationInlinedSource(loc: object): loc is SourceLocationInlinedSource
Guard to check if an object is a SourceLocation of type SourceLocationInlinedSource.
Parameters
- loc: object
Returns loc is SourceLocationInlinedSource
Inherited from AstFactory.isSourceLocationInlinedSource
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:52

isSourceLocationNodeAutoGenerate

isSourceLocationNodeAutoGenerate(
loc: object,
): loc is SourceLocationNodeAutoGenerate
Guard to check if an object is a SourceLocation of type SourceLocationNodeAutoGenerate.
Parameters
- loc: object
Returns loc is SourceLocationNodeAutoGenerate
Inherited from AstFactory.isSourceLocationNodeAutoGenerate
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:61

isSourceLocationNodeReplace

isSourceLocationNodeReplace(loc: object): loc is SourceLocationNodeReplace
Guard to check if an object is a SourceLocation of type SourceLocationNodeReplace.
Parameters
- loc: object
Returns loc is SourceLocationNodeReplace
Inherited from AstFactory.isSourceLocationNodeReplace
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:60

isSourceLocationNoMaterialize

isSourceLocationNoMaterialize(loc: object): loc is SourceLocationNoMaterialize
Guard to check if an object is a SourceLocation of type SourceLocationNoMaterialize.
Parameters
- loc: object
Returns loc is SourceLocationNoMaterialize
Inherited from AstFactory.isSourceLocationNoMaterialize
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:64

isSourceLocationSource

isSourceLocationSource(loc: object): loc is SourceLocationSource
Guard to check if an object is a SourceLocation of type SourceLocationSource.
Parameters
- loc: object
Returns loc is SourceLocationSource
Inherited from AstFactory.isSourceLocationSource
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:54

isSourceLocationStringReplace

isSourceLocationStringReplace(loc: object): loc is SourceLocationStringReplace
Guard to check if an object is a SourceLocation of type SourceLocationStringReplace.
Parameters
- loc: object
Returns loc is SourceLocationStringReplace
Inherited from AstFactory.isSourceLocationStringReplace
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:56

isTerm

isTerm(x: object): x is Typed<"term">
Parameters
- x: object
Returns x is Typed<"term">
Inherited from AstFactory.isTerm
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:72

isTermBlank

isTermBlank(obj: object): obj is SubTyped<"term", "blankNode">
Parameters
- obj: object
Returns obj is SubTyped<"term", "blankNode">
Inherited from AstFactory.isTermBlank
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:74

isTermLiteral

isTermLiteral(obj: object): obj is SubTyped<"term", "literal">
Parameters
- obj: object
Returns obj is SubTyped<"term", "literal">
Inherited from AstFactory.isTermLiteral
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:79

isTermLiteralLangStr

isTermLiteralLangStr(
obj: object,
): obj is SubTyped<"term", "literal"> & { langOrIri: string }
Parameters
- obj: object
Returns obj is SubTyped<"term", "literal"> & { langOrIri: string }
Inherited from AstFactory.isTermLiteralLangStr
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:80

isTermLiteralStr

isTermLiteralStr(
obj: object,
): obj is SubTyped<"term", "literal"> & { langOrIri: undefined }
Parameters
- obj: object
Returns obj is SubTyped<"term", "literal"> & { langOrIri: undefined }
Inherited from AstFactory.isTermLiteralStr
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:83

isTermLiteralTyped

isTermLiteralTyped(
obj: object,
): obj is SubTyped<"term", "literal"> & {
langOrIri: SubTyped<"term", "namedNode">;
}
Parameters
- obj: object
Returns obj is SubTyped<"term", "literal"> & {
langOrIri: SubTyped<"term", "namedNode">;
}
Inherited from AstFactory.isTermLiteralTyped
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:86

isTermNamed

isTermNamed(obj: object): obj is SubTyped<"term", "namedNode">
Parameters
- obj: object
Returns obj is SubTyped<"term", "namedNode">
Inherited from AstFactory.isTermNamed
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:93

isTermNamedPrefixed

isTermNamedPrefixed(
obj: object,
): obj is SubTyped<"term", "namedNode"> & { prefix: string }
Parameters
- obj: object
Returns obj is SubTyped<"term", "namedNode"> & { prefix: string }
Inherited from AstFactory.isTermNamedPrefixed
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:94

isTermTriple

isTermTriple(obj: object): obj is SubTyped<"term", "triple">
Parameters
- obj: object
Returns obj is SubTyped<"term", "triple">
- Defined in rules-sparql-1-2/lib/AstFactory.ts:36

isTermVariable

isTermVariable(obj: object): obj is SubTyped<"term", "variable">
Parameters
- obj: object
Returns obj is SubTyped<"term", "variable">
Inherited from AstFactory.isTermVariable
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:90

isTriple

isTriple(obj: object): obj is Typed<"triple">
Parameters
- obj: object
Returns obj is Typed<"triple">
Inherited from AstFactory.isTriple
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:454

isTripleCollection

isTripleCollection(obj: object): obj is Typed<"tripleCollection">
Parameters
- obj: object
Returns obj is Typed<"tripleCollection">
Inherited from AstFactory.isTripleCollection
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:459

isTripleCollectionBlankNodeProperties

isTripleCollectionBlankNodeProperties(
obj: object,
): obj is SubTyped<"tripleCollection", "blankNodeProperties">
Parameters
- obj: object
Returns obj is SubTyped<"tripleCollection", "blankNodeProperties">
Inherited from AstFactory.isTripleCollectionBlankNodeProperties
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:461

isTripleCollectionList

isTripleCollectionList(obj: object): obj is SubTyped<"tripleCollection", "list">
Parameters
- obj: object
Returns obj is SubTyped<"tripleCollection", "list">
Inherited from AstFactory.isTripleCollectionList
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:463

isTripleCollectionReifiedTriple

isTripleCollectionReifiedTriple(
obj: object,
): obj is SubTyped<"tripleCollection", "reifiedTriple">
Parameters
- obj: object
Returns obj is SubTyped<"tripleCollection", "reifiedTriple">
- Defined in rules-sparql-1-2/lib/AstFactory.ts:56

isUpdate

isUpdate(obj: object): obj is Update
Parameters
- obj: object
Returns obj is Update
Inherited from AstFactory.isUpdate
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:466

isUpdateOperation

isUpdateOperation(obj: object): obj is Typed<"updateOperation">
Parameters
- obj: object
Returns obj is Typed<"updateOperation">
Inherited from AstFactory.isUpdateOperation
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:6

isUpdateOperationAdd

isUpdateOperationAdd(obj: object): obj is SubTyped<"updateOperation", "add">
Parameters
- obj: object
Returns obj is SubTyped<"updateOperation", "add">
Inherited from AstFactory.isUpdateOperationAdd
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:23

isUpdateOperationClear

isUpdateOperationClear(obj: object): obj is SubTyped<"updateOperation", "clear">
Parameters
- obj: object
Returns obj is SubTyped<"updateOperation", "clear">
Inherited from AstFactory.isUpdateOperationClear
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:13

isUpdateOperationCopy

isUpdateOperationCopy(obj: object): obj is SubTyped<"updateOperation", "copy">
Parameters
- obj: object
Returns obj is SubTyped<"updateOperation", "copy">
Inherited from AstFactory.isUpdateOperationCopy
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:27

isUpdateOperationCreate

isUpdateOperationCreate(
obj: object,
): obj is SubTyped<"updateOperation", "create">
Parameters
- obj: object
Returns obj is SubTyped<"updateOperation", "create">
Inherited from AstFactory.isUpdateOperationCreate
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:17

isUpdateOperationDeleteData

isUpdateOperationDeleteData(
obj: object,
): obj is SubTyped<"updateOperation", "deletedata">
Parameters
- obj: object
Returns obj is SubTyped<"updateOperation", "deletedata">
Inherited from AstFactory.isUpdateOperationDeleteData
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:35

isUpdateOperationDeleteWhere

isUpdateOperationDeleteWhere(
obj: object,
): obj is SubTyped<"updateOperation", "deletewhere">
Parameters
- obj: object
Returns obj is SubTyped<"updateOperation", "deletewhere">
Inherited from AstFactory.isUpdateOperationDeleteWhere
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:37

isUpdateOperationDrop

isUpdateOperationDrop(obj: object): obj is SubTyped<"updateOperation", "drop">
Parameters
- obj: object
Returns obj is SubTyped<"updateOperation", "drop">
Inherited from AstFactory.isUpdateOperationDrop
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:15

isUpdateOperationInsertData

isUpdateOperationInsertData(
obj: object,
): obj is SubTyped<"updateOperation", "insertdata">
Parameters
- obj: object
Returns obj is SubTyped<"updateOperation", "insertdata">
Inherited from AstFactory.isUpdateOperationInsertData
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:33

isUpdateOperationLoad

isUpdateOperationLoad(obj: object): obj is SubTyped<"updateOperation", "load">
Parameters
- obj: object
Returns obj is SubTyped<"updateOperation", "load">
Inherited from AstFactory.isUpdateOperationLoad
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:8

isUpdateOperationModify

isUpdateOperationModify(
obj: object,
): obj is SubTyped<"updateOperation", "modify">
Parameters
- obj: object
Returns obj is SubTyped<"updateOperation", "modify">
Inherited from AstFactory.isUpdateOperationModify
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:39

isUpdateOperationMove

isUpdateOperationMove(obj: object): obj is SubTyped<"updateOperation", "move">
Parameters
- obj: object
Returns obj is SubTyped<"updateOperation", "move">
Inherited from AstFactory.isUpdateOperationMove
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:25

isWildcard

isWildcard(obj: object): obj is Typed<"wildcard">
Parameters
- obj: object
Returns obj is Typed<"wildcard">
Inherited from AstFactory.isWildcard
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:458

path

path(
    subType: "|",
    items: (TermIri | PathNegatedElt)[],
    loc: SourceLocation,
): PathAlternativeLimited
Parameters
- subType: "|"
- items: (TermIri | PathNegatedElt)[]
- loc: SourceLocation
Returns PathAlternativeLimited
Inherited from AstFactory.path
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:255
path(
    subType: "!",
    items: [TermIri | PathNegatedElt | PathAlternativeLimited],
    loc: SourceLocation,
): PathNegated
Parameters
- subType: "!"
- items: [TermIri | PathNegatedElt | PathAlternativeLimited]
- loc: SourceLocation
Returns PathNegated
Inherited from AstFactory.path
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:256
path(subType: "^", items: [TermIri], loc: SourceLocation): PathNegatedElt
Parameters
- subType: "^"
- items: [TermIri]
- loc: SourceLocation
Returns PathNegatedElt
Inherited from AstFactory.path
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:257
path(
    subType: "?" | "*" | "+" | "^",
    item: [Path],
    loc: SourceLocation,
): PathModified
Parameters
- subType: "?" | "*" | "+" | "^"
- item: [Path]
- loc: SourceLocation
Returns PathModified
Inherited from AstFactory.path
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:258
path(subType: "|" | "/", items: Path[], loc: SourceLocation): PropertyPathChain
Parameters
- subType: "|" | "/"
- items: Path[]
- loc: SourceLocation
Returns PropertyPathChain
Inherited from AstFactory.path
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:259

patternBgp

patternBgp(triples: BasicGraphPattern, loc: SourceLocation): PatternBgp
Parameters
- triples: BasicGraphPattern
- loc: SourceLocation
Returns PatternBgp
Inherited from AstFactory.patternBgp
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:204

patternBind

patternBind(
    expression: Expression,
    variable: TermVariable,
    loc: SourceLocation,
): PatternBind
Parameters
- expression: Expression
- variable: TermVariable
- loc: SourceLocation
Returns PatternBind
Inherited from AstFactory.patternBind
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:216

patternFilter

patternFilter(expression: Expression, loc: SourceLocation): PatternFilter
Parameters
- expression: Expression
- loc: SourceLocation
Returns PatternFilter
Inherited from AstFactory.patternFilter
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:214

patternGraph

patternGraph(
    name: TermIri | TermVariable,
    patterns: Pattern[],
    loc: SourceLocation,
): PatternGraph
Parameters
- name: TermIri | TermVariable
- patterns: Pattern[]
- loc: SourceLocation
Returns PatternGraph
Inherited from AstFactory.patternGraph
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:208

patternGroup

patternGroup(patterns: Pattern[], loc: SourceLocation): PatternGroup
Parameters
- patterns: Pattern[]
- loc: SourceLocation
Returns PatternGroup
Inherited from AstFactory.patternGroup
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:206

patternMinus

patternMinus(patterns: Pattern[], loc: SourceLocation): PatternMinus
Parameters
- patterns: Pattern[]
- loc: SourceLocation
Returns PatternMinus
Inherited from AstFactory.patternMinus
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:220

patternOptional

patternOptional(patterns: Pattern[], loc: SourceLocation): PatternOptional
Parameters
- patterns: Pattern[]
- loc: SourceLocation
Returns PatternOptional
Inherited from AstFactory.patternOptional
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:210

patternService

patternService(
    name: TermIri | TermVariable,
    patterns: Pattern[],
    silent: boolean,
    loc: SourceLocation,
): PatternService
Parameters
- name: TermIri | TermVariable
- patterns: Pattern[]
- silent: boolean
- loc: SourceLocation
Returns PatternService
Inherited from AstFactory.patternService
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:222

patternUnion

patternUnion(patterns: PatternGroup[], loc: SourceLocation): PatternUnion
Parameters
- patterns: PatternGroup[]
- loc: SourceLocation
Returns PatternUnion
Inherited from AstFactory.patternUnion
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:218

patternValues

patternValues(
    variables: TermVariable[],
    values: ValuePatternRow[],
    loc: SourceLocation,
): PatternValues
Parameters
- variables: TermVariable[]
- values: ValuePatternRow[]
- loc: SourceLocation
Returns PatternValues
Inherited from AstFactory.patternValues
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:212

printFilter

printFilter(node: Localized, callback: () => void): void
A simple filter that will only execute the provided callback when the provided SourceLocation expects the generator steps to autoGenerate.
Parameters
- node: Localized
- callback: () => void
Returns void
Inherited from AstFactory.printFilter
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:63

queryConstruct

queryConstruct(
    loc: SourceLocation,
    context: ContextDefinition[],
    template: PatternBgp,
    where: PatternGroup,
    solutionModifiers: SolutionModifiers,
    datasets: DatasetClauses,
    values?: PatternValues,
): QueryConstruct
Parameters
- loc: SourceLocation
- context: ContextDefinition[]
- template: PatternBgp
- where: PatternGroup
- solutionModifiers: SolutionModifiers
- datasets: DatasetClauses
- Optionalvalues: PatternValues
Returns QueryConstruct
Inherited from AstFactory.queryConstruct
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:168

querySelect

querySelect(
arg: Omit<QuerySelect, "type" | "subType" | "loc">,
loc: SourceLocation,
): QuerySelect
Parameters
- arg: Omit<QuerySelect, "type" | "subType" | "loc">
- loc: SourceLocation
Returns QuerySelect
Inherited from AstFactory.querySelect
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:172

resetBlankNodeCounter

resetBlankNodeCounter(): void
Returns void
Inherited from AstFactory.resetBlankNodeCounter
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:71

safeObjectTransform

safeObjectTransform(value: unknown, mapper: (some: object) => any): any
Given a value and some mapper from objects to objects, map all containing items in case it is an array, otherwise map the provided value in case it is an object, finally, do nothing.
Parameters
- value: unknown
  the value to map
- mapper: (some: object) => any
  the function mapping an object to another object.
Returns any
Inherited from AstFactory.safeObjectTransform
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:46

solutionModifierGroup

solutionModifierGroup(
groupings: (Expression | SolutionModifierGroupBind)[],
loc: SourceLocation,
): SolutionModifierGroup
Parameters
- groupings: (Expression | SolutionModifierGroupBind)[]
- loc: SourceLocation
Returns SolutionModifierGroup
Inherited from AstFactory.solutionModifierGroup
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:134

solutionModifierHaving

solutionModifierHaving(
having: Expression[],
loc: SourceLocation,
): SolutionModifierHaving
Parameters
- having: Expression[]
- loc: SourceLocation
Returns SolutionModifierHaving
Inherited from AstFactory.solutionModifierHaving
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:128

solutionModifierLimitOffset

solutionModifierLimitOffset(
    limit: number | undefined,
    offset: number | undefined,
    loc: SourceLocation,
): SolutionModifierLimitOffset
Parameters
- limit: number | undefined
- offset: number | undefined
- loc: SourceLocation
Returns SolutionModifierLimitOffset
Inherited from AstFactory.solutionModifierLimitOffset
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:132

solutionModifierOrder

solutionModifierOrder(
orderDefs: Ordering[],
loc: SourceLocation,
): SolutionModifierOrder
Parameters
- orderDefs: Ordering[]
- loc: SourceLocation
Returns SolutionModifierOrder
Inherited from AstFactory.solutionModifierOrder
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:130

sourceLocation

sourceLocation(...elements: (IToken | Localized | undefined)[]): SourceLocation
Compute the source location of an element based on the elements it contains. The provided arguments should be in order of occurrence in the string.
Parameters
- ...elements: (IToken | Localized | undefined)[]
Returns SourceLocation
Inherited from AstFactory.sourceLocation
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:43

sourceLocationInlinedSource

sourceLocationInlinedSource(
    newSource: string,
    subLoc: SourceLocation,
    start: number,
    end: number,
    startOnNew?: number,
    endOnNew?: number,
): SourceLocation
Create a SourceLocation that indicates a given range of the current range should be replaced by a new source.
Parameters
- newSource: string
- subLoc: SourceLocation
- start: number
- end: number
- OptionalstartOnNew: number
- OptionalendOnNew: number
Returns SourceLocation
Inherited from AstFactory.sourceLocationInlinedSource
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:51

sourceLocationNodeReplace

sourceLocationNodeReplace(
location: SourceLocationSource,
): SourceLocationNodeReplace
Parameters
- location: SourceLocationSource
Returns SourceLocationNodeReplace
Inherited from AstFactory.sourceLocationNodeReplace
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:58
sourceLocationNodeReplace(start: number, end: number): SourceLocationNodeReplace
Parameters
- start: number
- end: number
Returns SourceLocationNodeReplace
Inherited from AstFactory.sourceLocationNodeReplace
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:59

sourceLocationNodeReplaceUnsafe

sourceLocationNodeReplaceUnsafe(loc: SourceLocation): SourceLocationNodeReplace
Given a sourceLocation, generate a new SourceLocation that indicates the range of the given location should now be autoGenerated
Parameters
- loc: SourceLocation
Returns SourceLocationNodeReplace
Inherited from AstFactory.sourceLocationNodeReplaceUnsafe
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:57

sourceLocationNoMaterialize

sourceLocationNoMaterialize(): SourceLocation
Generate a source location indicating the no materialization.

Returns SourceLocation
Inherited from AstFactory.sourceLocationNoMaterialize
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:44

sourceLocationSource

sourceLocationSource(start: number, end: number): SourceLocationSource
Create a SourceLocation that indicates what range of characters this node represents in the source string.
Parameters
- start: number
- end: number
Returns SourceLocationSource
Inherited from AstFactory.sourceLocationSource
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:50

sourceLocationStringReplace

sourceLocationStringReplace(
    newSource: string,
    start: number,
    end: number,
): SourceLocation
Create a SourceLocation that indicates this node, representing a range of characters in the original string, should be replaced by some string during generation.
Parameters
- newSource: string
- start: number
- end: number
Returns SourceLocation
Inherited from AstFactory.sourceLocationStringReplace
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:55

termBlank

termBlank(label: string | undefined, loc: SourceLocation): TermBlank
Parameters
- label: string | undefined
- loc: SourceLocation
Returns TermBlank
Inherited from AstFactory.termBlank
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:73

termLiteral

termLiteral(
    loc: SourceLocation,
    value: string,
    lang?: undefined,
): TermLiteralStr
String, no lang, no type
Parameters
- loc: SourceLocation
- value: string
- Optionallang: undefined
Returns TermLiteralStr
Inherited from AstFactory.termLiteral
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:75
termLiteral(
    loc: SourceLocation,
    value: string,
    lang: string,
): TermLiteralLangStr
String with a language tag
Parameters
- loc: SourceLocation
- value: string
- lang: string
Returns TermLiteralLangStr
Inherited from AstFactory.termLiteral
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:76
termLiteral(loc: SourceLocation, value: string, iri: TermIri): TermLiteralTyped
Lexical form with a type
Parameters
- loc: SourceLocation
- value: string
- iri: TermIri
Returns TermLiteralTyped
Inherited from AstFactory.termLiteral
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:77
termLiteral(
    loc: SourceLocation,
    value: string,
    langOrIri?: string | TermIri,
): TermLiteral
String, no lang, no type
Parameters
- loc: SourceLocation
- value: string
- OptionallangOrIri: string | TermIri
Returns TermLiteral
Inherited from AstFactory.termLiteral
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:78

termNamed

termNamed(loc: SourceLocation, value: string, prefix?: undefined): TermIriFull
A namednode with fully defined with a uri.
Parameters
- loc: SourceLocation
- value: string
- Optionalprefix: undefined
Returns TermIriFull
Inherited from AstFactory.termNamed
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:91
termNamed(loc: SourceLocation, value: string, prefix: string): TermIriPrefixed
A namednode defined using a prefix
Parameters
- loc: SourceLocation
- value: string
- prefix: string
Returns TermIriPrefixed
Inherited from AstFactory.termNamed
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:92

termTriple

termTriple(
    subject: Term,
    predicate: TermIri | TermVariable,
    object: Term,
    loc: SourceLocation,
): TermTriple
Parameters
- subject: Term
- predicate: TermIri | TermVariable
- object: Term
- loc: SourceLocation
Returns TermTriple
- Defined in rules-sparql-1-2/lib/AstFactory.ts:20

termVariable

termVariable(value: string, loc: SourceLocation): TermVariable
Parameters
- value: string
- loc: SourceLocation
Returns TermVariable
Inherited from AstFactory.termVariable
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:89

tripleCollectionBlankNodeProperties

tripleCollectionBlankNodeProperties(
    identifier: TermIri | TermVariable | TermBlank,
    triples: TripleNesting[],
    loc: SourceLocation,
): TripleCollectionBlankNodeProperties
Parameters
- identifier: TermIri | TermVariable | TermBlank
- triples: TripleNesting[]
- loc: SourceLocation
Returns TripleCollectionBlankNodeProperties
Overrides AstFactory.tripleCollectionBlankNodeProperties
- Defined in rules-sparql-1-2/lib/AstFactory.ts:60

tripleCollectionList

tripleCollectionList(
    identifier: TermBlank,
    triples: TripleNesting[],
    loc: SourceLocation,
): TripleCollectionList
Parameters
- identifier: TermBlank
- triples: TripleNesting[]
- loc: SourceLocation
Returns TripleCollectionList
Inherited from AstFactory.tripleCollectionList
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:462

tripleCollectionReifiedTriple

tripleCollectionReifiedTriple(
    loc: SourceLocation,
    subject: GraphNode,
    predicate:
        | TermIriFull
        | TermIriPrefixed
        | TermVariable
        | PropertyPathChain
        | PathModified
        | PathNegated,
    object: GraphNode,
    reifier?: Term & (TermIri | TermVariable | TermBlank),
): TripleCollectionReifiedTriple
Parameters
- loc: SourceLocation
- subject: GraphNode
- predicate:
      | TermIriFull
      | TermIriPrefixed
      | TermVariable
      | PropertyPathChain
      | PathModified
      | PathNegated
- object: GraphNode
- Optionalreifier: Term & (TermIri | TermVariable | TermBlank)
Returns TripleCollectionReifiedTriple
- Defined in rules-sparql-1-2/lib/AstFactory.ts:40

updateOperationAdd

updateOperationAdd(
    source: GraphRefDefault | GraphRefSpecific,
    destination: GraphRefDefault | GraphRefSpecific,
    silent: boolean,
    loc: SourceLocation,
): UpdateOperationAdd
Parameters
- source: GraphRefDefault | GraphRefSpecific
- destination: GraphRefDefault | GraphRefSpecific
- silent: boolean
- loc: SourceLocation
Returns UpdateOperationAdd
Inherited from AstFactory.updateOperationAdd
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:22

updateOperationAddMoveCopy

updateOperationAddMoveCopy(
    subType: "add",
    source: GraphRefDefault | GraphRefSpecific,
    destination: GraphRefDefault | GraphRefSpecific,
    silent: boolean,
    loc: SourceLocation,
): UpdateOperationAdd
Parameters
- subType: "add"
- source: GraphRefDefault | GraphRefSpecific
- destination: GraphRefDefault | GraphRefSpecific
- silent: boolean
- loc: SourceLocation
Returns UpdateOperationAdd
Inherited from AstFactory.updateOperationAddMoveCopy
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:18
updateOperationAddMoveCopy(
    subType: "move",
    source: GraphRefDefault | GraphRefSpecific,
    destination: GraphRefDefault | GraphRefSpecific,
    silent: boolean,
    loc: SourceLocation,
): UpdateOperationMove
Parameters
- subType: "move"
- source: GraphRefDefault | GraphRefSpecific
- destination: GraphRefDefault | GraphRefSpecific
- silent: boolean
- loc: SourceLocation
Returns UpdateOperationMove
Inherited from AstFactory.updateOperationAddMoveCopy
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:19
updateOperationAddMoveCopy(
    subType: "copy",
    source: GraphRefDefault | GraphRefSpecific,
    destination: GraphRefDefault | GraphRefSpecific,
    silent: boolean,
    loc: SourceLocation,
): UpdateOperationCopy
Parameters
- subType: "copy"
- source: GraphRefDefault | GraphRefSpecific
- destination: GraphRefDefault | GraphRefSpecific
- silent: boolean
- loc: SourceLocation
Returns UpdateOperationCopy
Inherited from AstFactory.updateOperationAddMoveCopy
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:20
updateOperationAddMoveCopy(
    subType: "add" | "copy" | "move",
    source: GraphRefDefault | GraphRefSpecific,
    destination: GraphRefDefault | GraphRefSpecific,
    silent: boolean,
    loc: SourceLocation,
): UpdateOperationAdd | UpdateOperationMove | UpdateOperationCopy
Parameters
- subType: "add" | "copy" | "move"
- source: GraphRefDefault | GraphRefSpecific
- destination: GraphRefDefault | GraphRefSpecific
- silent: boolean
- loc: SourceLocation
Returns UpdateOperationAdd | UpdateOperationMove | UpdateOperationCopy
Inherited from AstFactory.updateOperationAddMoveCopy
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:21

updateOperationClear

updateOperationClear(
    destination: GraphRef,
    silent: boolean,
    loc: SourceLocation,
): UpdateOperationClear
Parameters
- destination: GraphRef
- silent: boolean
- loc: SourceLocation
Returns UpdateOperationClear
Inherited from AstFactory.updateOperationClear
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:12

updateOperationClearDrop

updateOperationClearDrop(
    subType: "clear",
    silent: boolean,
    destination: GraphRef,
    loc: SourceLocation,
): UpdateOperationClear
Parameters
- subType: "clear"
- silent: boolean
- destination: GraphRef
- loc: SourceLocation
Returns UpdateOperationClear
Inherited from AstFactory.updateOperationClearDrop
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:9
updateOperationClearDrop(
    subType: "drop",
    silent: boolean,
    destination: GraphRef,
    loc: SourceLocation,
): UpdateOperationDrop
Parameters
- subType: "drop"
- silent: boolean
- destination: GraphRef
- loc: SourceLocation
Returns UpdateOperationDrop
Inherited from AstFactory.updateOperationClearDrop
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:10
updateOperationClearDrop(
    subType: "clear" | "drop",
    silent: boolean,
    destination: GraphRef,
    loc: SourceLocation,
): UpdateOperationClear | UpdateOperationDrop
Parameters
- subType: "clear" | "drop"
- silent: boolean
- destination: GraphRef
- loc: SourceLocation
Returns UpdateOperationClear | UpdateOperationDrop
Inherited from AstFactory.updateOperationClearDrop
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:11

updateOperationCopy

updateOperationCopy(
    source: GraphRefDefault | GraphRefSpecific,
    destination: GraphRefDefault | GraphRefSpecific,
    silent: boolean,
    loc: SourceLocation,
): UpdateOperationCopy
Parameters
- source: GraphRefDefault | GraphRefSpecific
- destination: GraphRefDefault | GraphRefSpecific
- silent: boolean
- loc: SourceLocation
Returns UpdateOperationCopy
Inherited from AstFactory.updateOperationCopy
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:26

updateOperationCreate

updateOperationCreate(
    destination: GraphRefSpecific,
    silent: boolean,
    loc: SourceLocation,
): UpdateOperationCreate
Parameters
- destination: GraphRefSpecific
- silent: boolean
- loc: SourceLocation
Returns UpdateOperationCreate
Inherited from AstFactory.updateOperationCreate
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:16

updateOperationDeleteData

updateOperationDeleteData(
data: Quads[],
loc: SourceLocation,
): UpdateOperationDeleteData
Parameters
- data: Quads[]
- loc: SourceLocation
Returns UpdateOperationDeleteData
Inherited from AstFactory.updateOperationDeleteData
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:34

updateOperationDeleteWhere

updateOperationDeleteWhere(
data: Quads[],
loc: SourceLocation,
): UpdateOperationDeleteWhere
Parameters
- data: Quads[]
- loc: SourceLocation
Returns UpdateOperationDeleteWhere
Inherited from AstFactory.updateOperationDeleteWhere
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:36

updateOperationDrop

updateOperationDrop(
    destination: GraphRef,
    silent: boolean,
    loc: SourceLocation,
): UpdateOperationDrop
Parameters
- destination: GraphRef
- silent: boolean
- loc: SourceLocation
Returns UpdateOperationDrop
Inherited from AstFactory.updateOperationDrop
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:14

updateOperationInsDelDataWhere

updateOperationInsDelDataWhere(
    subType: "insertdata",
    data: Quads[],
    loc: SourceLocation,
): UpdateOperationInsertData
Parameters
- subType: "insertdata"
- data: Quads[]
- loc: SourceLocation
Returns UpdateOperationInsertData
Inherited from AstFactory.updateOperationInsDelDataWhere
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:28
updateOperationInsDelDataWhere(
    subType: "deletedata",
    data: Quads[],
    loc: SourceLocation,
): UpdateOperationDeleteData
Parameters
- subType: "deletedata"
- data: Quads[]
- loc: SourceLocation
Returns UpdateOperationDeleteData
Inherited from AstFactory.updateOperationInsDelDataWhere
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:29
updateOperationInsDelDataWhere(
    subType: "deletewhere",
    data: Quads[],
    loc: SourceLocation,
): UpdateOperationDeleteWhere
Parameters
- subType: "deletewhere"
- data: Quads[]
- loc: SourceLocation
Returns UpdateOperationDeleteWhere
Inherited from AstFactory.updateOperationInsDelDataWhere
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:30
updateOperationInsDelDataWhere(
    subType: "insertdata" | "deletedata" | "deletewhere",
    data: Quads[],
    loc: SourceLocation,
):
    | UpdateOperationInsertData
    | UpdateOperationDeleteData
    | UpdateOperationDeleteWhere
Parameters
- subType: "insertdata" | "deletedata" | "deletewhere"
- data: Quads[]
- loc: SourceLocation
Returns
    | UpdateOperationInsertData
    | UpdateOperationDeleteData
    | UpdateOperationDeleteWhere
Inherited from AstFactory.updateOperationInsDelDataWhere
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:31

updateOperationInsertData

updateOperationInsertData(
data: Quads[],
loc: SourceLocation,
): UpdateOperationInsertData
Parameters
- data: Quads[]
- loc: SourceLocation
Returns UpdateOperationInsertData
Inherited from AstFactory.updateOperationInsertData
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:32

updateOperationLoad

updateOperationLoad(
    loc: SourceLocation,
    source: TermIri,
    silent: boolean,
    destination?: GraphRefSpecific,
): UpdateOperationLoad
Parameters
- loc: SourceLocation
- source: TermIri
- silent: boolean
- Optionaldestination: GraphRefSpecific
Returns UpdateOperationLoad
Inherited from AstFactory.updateOperationLoad
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:7

updateOperationModify

updateOperationModify(
    loc: SourceLocation,
    insert: Quads[] | undefined,
    del: Quads[] | undefined,
    where: PatternGroup,
    from: DatasetClauses,
    graph?: TermIri,
): UpdateOperationModify
Parameters
- loc: SourceLocation
- insert: Quads[] | undefined
- del: Quads[] | undefined
- where: PatternGroup
- from: DatasetClauses
- Optionalgraph: TermIri
Returns UpdateOperationModify
Inherited from AstFactory.updateOperationModify
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:38

updateOperationMove

updateOperationMove(
    source: GraphRefDefault | GraphRefSpecific,
    destination: GraphRefDefault | GraphRefSpecific,
    silent: boolean,
    loc: SourceLocation,
): UpdateOperationMove
Parameters
- source: GraphRefDefault | GraphRefSpecific
- destination: GraphRefDefault | GraphRefSpecific
- silent: boolean
- loc: SourceLocation
Returns UpdateOperationMove
Inherited from AstFactory.updateOperationMove
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:24

wildcard

wildcard(loc: SourceLocation): Wildcard
Parameters
- loc: SourceLocation
Returns Wildcard
Inherited from AstFactory.wildcard
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:457

wrap

wrap<T>(val: T, loc: SourceLocation): Wrap<T>
Wrap any type into an object that tracks the source location of tha value.
Type Parameters
- T
Parameters
- val: T
  the value to wrap
- loc: SourceLocation
  the source location for that value
Returns Wrap<T>
Inherited from AstFactory.wrap
- Defined in rules-sparql-1-1/dist/esm/lib/astFactory.d.ts:41

Class AstFactory

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AstFactory

Properties

__blankNodeCounter

tracksSourceLocation

triple

Methods

aggregate

Parameters

Returns ExpressionAggregateDefault

Parameters

Returns ExpressionAggregateOnWildcard

Parameters

Returns ExpressionAggregateSeparator

Parameters

Returns ExpressionAggregate

alwaysSparql11

Parameters

Returns obj is Sparql11Nodes

annotatedTriple

Parameters

Returns TripleNesting

contextDefinitionBase

Parameters

Returns ContextDefinitionBase

contextDefinitionPrefix

Parameters

Returns ContextDefinitionPrefix

contextDefinitionVersion

Parameters

Returns ContextDefinitionVersion

datasetClauses

Parameters

Returns DatasetClauses

dematerialized

Type Parameters

Parameters

Returns T

expressionFunctionCall

Type Parameters

Parameters

Returns Node & { subType: string; type: "expression" } & { args: Expression[]; distinct: boolean; function: TermIri; subType: "functionCall";} & { args: Args }

expressionOperation

Type Parameters

Parameters

Returns Node & { subType: string; type: "expression" } & { args: Expression[]; operator: string; subType: "operation";} & { args: Args }

expressionPatternOperation

Parameters

Returns ExpressionPatternOperation

forcedAutoGenTree

Type Parameters

Parameters

Returns T

forceMaterialized

Type Parameters

Parameters

Returns T

formatOperator

Parameters

Returns string

gen

Returns SourceLocationNodeAutoGenerate

graphNodeIdentifier

Parameters

Returns Term

graphQuads

Parameters

Returns GraphQuads

graphRefAll

Parameters

Returns GraphRefAll

graphRefDefault

Returns Node & { subType: string; type: "expression" } & {
args: Expression[];
distinct: boolean;
function: TermIri;
subType: "functionCall";
} & { args: Args }

Returns Node & { subType: string; type: "expression" } & {
args: Expression[];
operator: string;
subType: "operation";
} & { args: Args }

Returns obj is
| Typed<"expression">
| SubTyped<"term", "variable" | "literal" | "namedNode">