Class ActorExtractLinksTree

A comunica Extract Links Tree Extract Links Actor.

Hierarchy (View Summary)

ActorExtractLinks
- ActorExtractLinksTree

Index

Constructors

constructor

new ActorExtractLinksTree(args: IActorExtractLinksArgs): ActorExtractLinksTree
Parameters
- args: IActorExtractLinksArgs
Returns ActorExtractLinksTree
Overrides ActorExtractLinks.constructor
- Defined in packages/actor-extract-links-extract-tree/lib/ActorExtractLinksTree.ts:26

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionExtractLinks,
    IActorTest,
    IActorExtractLinksOutput,
    undefined,
>[]

Actor that must be registered in the bus before this actor.

`Readonly`bus

bus: Bus<
    Actor<
        IActionExtractLinks,
        IActorTest,
        IActorExtractLinksOutput,
        undefined,
    >,
    IActionExtractLinks,
    IActorTest,
    IActorExtractLinksOutput,
    undefined,
>

The bus this actor subscribes to.

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Static` `Readonly`aNodeType

aNodeType: NamedNode<"https://w3id.org/tree#node"> = ...

`Static` `Readonly`aRelation

aRelation: NamedNode<"https://w3id.org/tree#relation"> = ...

`Static` `Readonly`aSubset

aSubset: NamedNode<"http://rdfs.org/ns/void#subset"> = ...

`Static` `Readonly`aView

aView: NamedNode<"https://w3id.org/tree#view"> = ...

`Static` `Readonly`isPartOf

isPartOf: NamedNode<"http://purl.org/dc/terms/isPartOf"> = ...

Methods

`Protected`getDefaultLogData

getDefaultLogData(context: IActionContext, data?: () => any): any
Parameters
- context: IActionContext
- Optionaldata: () => any
Returns any
Inherited from ActorExtractLinks.getDefaultLogData
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:69

`Protected`logDebug

logDebug(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorExtractLinks.logDebug
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:71

`Protected`logError

logError(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorExtractLinks.logError
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:74

`Protected`logFatal

logFatal(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorExtractLinks.logFatal
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:75

`Protected`logInfo

logInfo(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorExtractLinks.logInfo
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:72

`Protected`logTrace

logTrace(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorExtractLinks.logTrace
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:70

`Protected`logWarn

logWarn(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorExtractLinks.logWarn
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:73

run

run(action: IActionExtractLinks): Promise<IActorExtractLinksOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionExtractLinks
  The action to run.
Returns Promise<IActorExtractLinksOutput>
A promise that resolves to the run result.
Overrides ActorExtractLinks.run
- Defined in packages/actor-extract-links-extract-tree/lib/ActorExtractLinksTree.ts:34

runObservable

runObservable(
action: IActionExtractLinks,
sideData: undefined,
): Promise<IActorExtractLinksOutput>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: IActionExtractLinks
  The action to run.
- sideData: undefined
Returns Promise<IActorExtractLinksOutput>
A promise that resolves to the run result.
Inherited from ActorExtractLinks.runObservable
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:68

test

test(_action: IActionExtractLinks): Promise<TestResult<IActorTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- _action: IActionExtractLinks
  The action to test.
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the test result.
Overrides ActorExtractLinks.test
- Defined in packages/actor-extract-links-extract-tree/lib/ActorExtractLinksTree.ts:30

`Static`collectStream

collectStream(
metadata: Stream,
onQuad: (quad: Quad, links: ILink[]) => void,
): Promise<ILink[]>
A helper function to append links based on incoming quads.
Parameters
- metadata: Stream
  A metadata stream of quads.
- onQuad: (quad: Quad, links: ILink[]) => void
  A callback that will be invoked for each quad in the metadata stream. The second argument is the array of links that can be appended to.
Returns Promise<ILink[]>
Inherited from ActorExtractLinks.collectStream
- Defined in packages/bus-extract-links/lib/ActorExtractLinks.ts:32

`Static`getContextLogger

getContextLogger(context: IActionContext): Logger | undefined
Get the logger from the given context.
Parameters
- context: IActionContext
  An optional context.
Returns Logger | undefined
The logger or undefined.
Inherited from ActorExtractLinks.getContextLogger
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:42

Class ActorExtractLinksTree

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorExtractLinksTree

Properties

ReadonlybeforeActors

Readonlybus

Readonlyname

Default

Static ReadonlyaNodeType

Static ReadonlyaRelation

Static ReadonlyaSubset

Static ReadonlyaView

Static ReadonlyisPartOf

Methods

ProtectedgetDefaultLogData

Parameters

Returns any

ProtectedlogDebug

Parameters

Returns void

ProtectedlogError

Parameters

Returns void

ProtectedlogFatal

Parameters

Returns void

ProtectedlogInfo

Parameters

Returns void

ProtectedlogTrace

Parameters

Returns void

ProtectedlogWarn

Parameters

Returns void

run

Parameters

Returns Promise<IActorExtractLinksOutput>

runObservable

Parameters

Returns Promise<IActorExtractLinksOutput>

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticcollectStream

Parameters

Returns Promise<ILink[]>

StaticgetContextLogger

Parameters

Returns Logger | undefined

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Static` `Readonly`aNodeType

`Static` `Readonly`aRelation

`Static` `Readonly`aSubset

`Static` `Readonly`aView

`Static` `Readonly`isPartOf

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`collectStream

`Static`getContextLogger