Class QuerySourceQpf

A lazy query source.

Implements

IQuerySource

Index

Constructors

constructor

new QuerySourceQpf(
    mediatorMetadata: MediatorRdfMetadata,
    mediatorMetadataExtract: MediatorRdfMetadataExtract,
    mediatorDereferenceRdf: MediatorDereferenceRdf,
    dataFactory: ComunicaDataFactory,
    algebraFactory: AlgebraFactory,
    bindingsFactory: BindingsFactory,
    subjectUri: string,
    predicateUri: string,
    objectUri: string,
    graphUri: string | undefined,
    url: string,
    metadata: Record<string, any>,
    bindingsRestricted: boolean,
    initialQuads?: Stream<Quad>,
): QuerySourceQpf
Parameters
- mediatorMetadata: MediatorRdfMetadata
- mediatorMetadataExtract: MediatorRdfMetadataExtract
- mediatorDereferenceRdf: MediatorDereferenceRdf
- dataFactory: ComunicaDataFactory
- algebraFactory: AlgebraFactory
- bindingsFactory: BindingsFactory
- subjectUri: string
- predicateUri: string
- objectUri: string
- graphUri: string | undefined
- url: string
- metadata: Record<string, any>
- bindingsRestricted: boolean
- OptionalinitialQuads: Stream<Quad>
Returns QuerySourceQpf
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:53

Properties

`Readonly`referenceValue

referenceValue: string

The URL of RDF source of this source.

`Readonly`searchForm

searchForm: ISearchForm

`Protected` `Readonly`selectorShape

selectorShape: FragmentSelectorShape

Methods

`Protected`cacheQuads

cacheQuads(
    quads: AsyncIterator<Quad>,
    subject: Term,
    predicate: Term,
    object: Term,
    graph: Term,
): void
Parameters
- quads: AsyncIterator<Quad>
- subject: Term
- predicate: Term
- object: Term
- graph: Term
Returns void
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:431

createFragmentUri

createFragmentUri(
    searchForm: ISearchForm,
    subject: Term,
    predicate: Term,
    object: Term,
    graph: Term,
): string
Create a QPF fragment IRI for the given quad pattern.
Parameters
- searchForm: ISearchForm
  A search form.
- subject: Term
  A term.
- predicate: Term
  A term.
- object: Term
  A term.
- graph: Term
  A term.
Returns string
A URI.
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:213

`Protected`getBindingsRestrictedLink

getBindingsRestrictedLink(
    subject: Term,
    predicate: Term,
    object: Term,
    graph: Term,
    url: string,
    filterBindings: { bindings: BindingsStream; metadata: MetadataBindings },
): Promise<string>
Protected
If we add bindings for brTPF, append it to the URL. We have to hardcode this because brTPF doesn't expose a URL template for passing bindings.
Parameters
- subject: Term
  The subject.
- predicate: Term
  The predicate.
- object: Term
  The object.
- graph: Term
  The graph.
- url: string
  The original QPF URL.
- filterBindings: { bindings: BindingsStream; metadata: MetadataBindings }
  The bindings to restrict with.
  - bindings: BindingsStream
    The bindings stream.
  - metadata: MetadataBindings
    The bindings metadata.
Returns Promise<string>
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:380

`Protected`getCachedQuads

getCachedQuads(
    subject: Term,
    predicate: Term,
    object: Term,
    graph: Term,
): AsyncIterator<Quad> | undefined
Parameters
- subject: Term
- predicate: Term
- object: Term
- graph: Term
Returns AsyncIterator<Quad> | undefined
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:442

getFilterFactor

getFilterFactor(): Promise<number>
Returns Promise<number>
A value from 0 to 1 indicating to what respect a source type is able to pre-filter the source based on the pattern. 1 indicates that the source can apply the whole pattern, and 0 indicates that the source can not apply the pattern at all (and local filtering must happen). Plain RDF documents for example have a filter factor of 0, while SPARQL endpoints have a filter factor of 1.
Implementation of IQuerySource.getFilterFactor
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:141

getPatternId

getPatternId(subject: Term, predicate: Term, object: Term, graph: Term): string
Parameters
- subject: Term
- predicate: Term
- object: Term
- graph: Term
Returns string
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:422

getSearchForm

getSearchForm(metadata: Record<string, any>): ISearchForm | undefined
Get a first QPF search form.
Parameters
- metadata: Record<string, any>
  A metadata object.
Returns ISearchForm | undefined
A search form, or null if none could be found.
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:179

getSelectorShape

getSelectorShape(): Promise<FragmentSelectorShape>
Get the selector type that is supported by this source.

Returns Promise<FragmentSelectorShape>
Implementation of IQuerySource.getSelectorShape
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:145

`Protected`match

match(
    subject: Term,
    predicate: Term,
    object: Term,
    graph: Term,
    unionDefaultGraph: boolean,
    context: IActionContext,
    options?: IQueryBindingsOptions,
): AsyncIterator<Quad>
Parameters
- subject: Term
- predicate: Term
- object: Term
- graph: Term
- unionDefaultGraph: boolean
- context: IActionContext
- Optionaloptions: IQueryBindingsOptions
Returns AsyncIterator<Quad>
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:237

queryBindings

queryBindings(
    operation: BaseOperation,
    context: IActionContext,
    options?: IQueryBindingsOptions,
): BindingsStream
Returns a (possibly lazy) stream that returns all bindings matching the operation.

Passed operations MUST conform to the query shape exposed by the selector type returned from getSelectorShape. The given operation represents a Linked Data Fragments selector.

The returned stream MUST expose the property 'metadata' of type MetadataBindings. The implementor is reponsible for handling cases where 'metadata' is being called without the stream being in flow-mode. This metadata object can become invalidated (see metadata.state), in which case the 'metadata' property must and will be updated.
Parameters
- operation: BaseOperation
  The query operation to execute.
- context: IActionContext
  The query context.
- Optionaloptions: IQueryBindingsOptions
  Options for querying bindings
Returns BindingsStream
The resulting bindings stream.

See
https://linkeddatafragments.org/specification/linked-data-fragments/#selectors
Implementation of IQuerySource.queryBindings
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:149

queryBoolean

queryBoolean(_operation: Ask, _context: IActionContext): Promise<boolean>
Returns a promise resolving to the ask response of the given operation.

This method should only be supported if the selector type returned from getSelectorShape supports ask queries.
Parameters
- _operation: Ask
- _context: IActionContext
Returns Promise<boolean>
The resulting ask reply.
Implementation of IQuerySource.queryBoolean
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:458

queryQuads

queryQuads(
_operation: BaseOperation,
_context: IActionContext,
): AsyncIterator<Quad>
Returns a (possibly lazy) stream that returns all quads matching the operation.

This method should only be supported if the selector type returned from getSelectorShape supports construct queries.
Parameters
- _operation: BaseOperation
- _context: IActionContext
Returns AsyncIterator<Quad>
The resulting quads stream.
Implementation of IQuerySource.queryQuads
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:451

queryVoid

queryVoid(_operation: BaseOperation, _context: IActionContext): Promise<void>
Returns a promise resolving when the given update operation succeeds.

This method should only be supported if the selector type returned from getSelectorShape supports update queries.
Parameters
- _operation: BaseOperation
- _context: IActionContext
Returns Promise<void>
The void response.
Implementation of IQuerySource.queryVoid
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:465

`Protected`reverseMapQuadsToDefaultGraph

reverseMapQuadsToDefaultGraph(quads: AsyncIterator<Quad>): AsyncIterator<Quad>
Parameters
- quads: AsyncIterator<Quad>
Returns AsyncIterator<Quad>
- Defined in actor-query-source-identify-hypermedia-qpf/lib/QuerySourceQpf.ts:412

Class QuerySourceQpf

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns QuerySourceQpf

Properties

ReadonlyreferenceValue

ReadonlysearchForm

Protected ReadonlyselectorShape

Methods

ProtectedcacheQuads

Parameters

Returns void

createFragmentUri

Parameters

Returns string

ProtectedgetBindingsRestrictedLink

Parameters

bindings: BindingsStream

metadata: MetadataBindings

Returns Promise<string>

ProtectedgetCachedQuads

Parameters

Returns AsyncIterator<Quad> | undefined

getFilterFactor

Returns Promise<number>

getPatternId

Parameters

Returns string

getSearchForm

Parameters

Returns ISearchForm | undefined

getSelectorShape

Returns Promise<FragmentSelectorShape>

Protectedmatch

Parameters

Returns AsyncIterator<Quad>

queryBindings

Parameters

Returns BindingsStream

See

queryBoolean

Parameters

Returns Promise<boolean>

queryQuads

Parameters

Returns AsyncIterator<Quad>

queryVoid

Parameters

Returns Promise<void>

ProtectedreverseMapQuadsToDefaultGraph

Parameters

Returns AsyncIterator<Quad>

Settings

On This Page

`Readonly`referenceValue

`Readonly`searchForm

`Protected` `Readonly`selectorShape

`Protected`cacheQuads

`Protected`getBindingsRestrictedLink

`Protected`getCachedQuads

`Protected`match

`Protected`reverseMapQuadsToDefaultGraph