SPARQLER Docs
FinishFactory SPARQLER
clauses
AskClause FinishClause FromClause GroupClause HavingClause LimitClause LimitOffsetClause OffsetClause OrderClause QueryClause SelectClause ValuesClause WhereClause
core
Container Factory hasProtocol IRIResolver isAbsolute isBNodeLabel isIRI isPrefixed isRelative QueryUnitContainer
patterns
BindPattern BlankNode BlankNodeBuilder BlankNodeProperty Collection DeniableFluentPath Expression ExpressionsBuilder FilterPattern FinishPattern FluentPath FluentPathContainer FunctionExpressionsBuilder GraphPattern GroupPattern Literal MinusPattern MultipleValuesPattern MultipleValuesPatternMore NotTriplePattern NotTriplePatternsBuilder OperationExpressionsBuilder OptionalPattern OrderBuilder OrderCondition Path PathBuilder PathsBuilder Pattern PatternBuilder Projectable PropertyBuilder PropertyBuilderMore RDFLiteral Resource ServicePattern SingleValuesPattern SingleValuesPatternMore SubSelectPattern SupportedNativeTypes TriplePattern TriplePatternsBuilder TripleSubject Undefined UnionPattern Variable WherePattern
tokens
AdditiveExpressionToken AdditiveOperationToken AskToken AssigmentToken BaseToken BinaryOperationToken BindToken BlankNodePropertyToken BlankNodeToken BracketedExpressionToken CollectionToken ConditionalAndExpressionToken ConditionalAndOperationToken ConditionalOrExpressionToken ConditionalOrOperationToken ConstraintToken ConstructToken ExplicitOrderConditionToken ExpressionListToken ExpressionToken FilterToken FromToken GraphToken GroupPatternToken GroupToken HavingToken InclusionExpressionToken IRIRefToken IRIToken LanguageToken LimitToken LiteralToken MinusPatternToken MultiplicativeExpressionToken MultiplicativeOperationToken NotTripleToken NumericExpressionToken ObjectToken OffsetToken OptionalToken OrderToken PathAlternativeToken PathEltToken PathInAlternativeToken PathInNegatedToken PathInSequenceToken PathInverseToken PathModToken PathNegatedToken PathPrimaryToken PathSequenceToken PathToken PatternToken PrefixedNameToken PrefixToken PrimaryExpressionToken ProjectableToken PropertyToken QueryClauseToken QueryToken RDFLiteralToken RelationalExpressionToken RelationalOperationToken SelectToken ServicePatternToken SharedQueryClauseToken SharedSelectToken SharedSubPathToken SolutionModifierToken SubjectToken SubPathInNegatedToken SubPathToken SubSelectToken TermToken TokenNode TripleNodeToken TripleToken UnaryExpressionToken UnaryOperationToken UnionPatternToken ValueLogicalToken ValuesToken VariableOrIRIToken VariableOrTermToken VariableToken WhereToken
utils
XSD
Menu
sparqler patterns PathBuilder

PathBuilder

Description

Builder with the methods that helps you to construct any path.

See https://www.w3.org/TR/sparql11-query/#propertypaths for more information.

Methods

subPath( path: Path<PathToken> ): FluentPath<SubPathToken<PathToken>>

Parameters

NameTypeDescription
Path<PathToken>
alternatives( ...paths: (string | Resource | Path<PathToken> | (string | Resource | Path<PathToken>)[])[] ): FluentPath<PathAlternativeToken>

Parameters

NameTypeDescription
(string | Resource | Path<PathToken> | (string | Resource | Path<PathToken>)[])[]
sequences( ...paths: (string | Resource | Path<PathToken> | (string | Resource | Path<PathToken>)[])[] ): FluentPath<PathSequenceToken>

Create a sequence path from the paths.

Parameters

NameTypeDescription

The paths to be added as path sequence.

(string | Resource | Path<PathToken> | (string | Resource | Path<PathToken>)[])[]
inverse( path: string | Resource | Path<PathToken> ): FluentPath<PathInverseToken>

Parameters

NameTypeDescription
string | Resource | Path<PathToken>
negated( path: string | Resource | Path<IRIRefToken | PrefixedNameToken | "a" | PathInverseToken<IRIRefToken | PrefixedNameToken | "a"> | PathAlternativeToken<PathInNegatedToken> | SharedSubPathToken<...>> ): FluentPath<PathNegatedToken>

Create an negated path from the another one.

Parameters

NameTypeDescription
string | Resource | Path<IRIRefToken | PrefixedNameToken | "a" | PathInverseToken<IRIRefToken | PrefixedNameToken | "a"> | PathAlternativeToken<PathInNegatedToken> | SharedSubPathToken<...>>

The path to be negated.

oneOrNone( path: string | Resource | Path<PathToken> ): FluentPath<PathModToken>

Set the path to be matched one or zero times. i.e. the ? mod.

Parameters

NameTypeDescription
string | Resource | Path<PathToken>

The path to add the mod.

zeroOrMore( path: string | Resource | Path<PathToken> ): FluentPath<PathModToken>

Set the path to be matched zero or more times. i.e. the * mod.

Parameters

NameTypeDescription
string | Resource | Path<PathToken>

The path to add the mod.

onceOrMore( path: string | Resource | Path<PathToken> ): FluentPath<PathModToken>

Set the path to be matched one or more times. i.e. the + mod.

Parameters

NameTypeDescription
string | Resource | Path<PathToken>

The path to add the mod.

PathBuilder

Description

Constant with the utils for PathBuilder objects.

Methods

createFrom<O extends object>( container: FluentPathContainer<undefined>, object: O ): O & PathBuilder

Factory function that allows to crete a PathBuilder from the object provided.

Parameters

NameTypeDescription
FluentPathContainer<undefined>

The related container with the data for the PathBuilder statement.

O

The base base from where to create the PathBuilder statement.

Returns

The PathBuilder statement created from the object provided.