Class ActorExtractLinksContentPolicies

A comunica Traverse Content Policies RDF Metadata Extract Actor.

Hierarchy (View Summary)

ActorExtractLinks
- ActorExtractLinksContentPolicies

Implements

IActorExtractLinksContentPoliciesArgs

Constructors

constructor

new ActorExtractLinksContentPolicies(
args: IActorExtractLinksContentPoliciesArgs,
): ActorExtractLinksContentPolicies
Parameters
- args: IActorExtractLinksContentPoliciesArgs
Returns ActorExtractLinksContentPolicies
Overrides ActorExtractLinks.constructor
- Defined in packages/actor-extract-links-content-policies/lib/ActorExtractLinksContentPolicies.ts:29

Properties

`Readonly`actorInitQuery

actorInitQuery: ActorInitQueryBase

An init query actor that is used to query all links to follow from a stream.

Default

{<urn:comunica:default:init/actors#query>}

`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>}

`Readonly`queryEngine

queryEngine: QueryEngineBase

`Readonly`traverseConditional

traverseConditional: boolean

If true (default), then content policies will be applied on links that are being detected by some other actor, if false, then links detected by content policies will forcefully be added to the link queue.

Default

{true}

Methods

`Protected`getContentPoliciesFromDocument

getContentPoliciesFromDocument(
documentIri: string,
store: Store,
): Promise<ContentPolicy[]>
Parameters
- documentIri: string
- store: Store
Returns Promise<ContentPolicy[]>
- Defined in packages/actor-extract-links-content-policies/lib/ActorExtractLinksContentPolicies.ts:45

`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-content-policies/lib/ActorExtractLinksContentPolicies.ts:81

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-content-policies/lib/ActorExtractLinksContentPolicies.ts:37

`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`getContentPolicies

getContentPolicies(context: IActionContext): ContentPolicy[]
Parameters
- context: IActionContext
Returns ContentPolicy[]
- Defined in packages/actor-extract-links-content-policies/lib/ActorExtractLinksContentPolicies.ts:41

`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

`Static`getCurrentQuadPattern

getCurrentQuadPattern(context: IActionContext): Pattern | undefined
Parameters
- context: IActionContext
Returns Pattern | undefined
- Defined in packages/actor-extract-links-content-policies/lib/ActorExtractLinksContentPolicies.ts:60

`Static`isContentPolicyApplicableForPattern

isContentPolicyApplicableForPattern(
policy: ContentPolicy,
queryingPattern?: Pattern,
): boolean
Parameters
- policy: ContentPolicy
- OptionalqueryingPattern: Pattern
Returns boolean
- Defined in packages/actor-extract-links-content-policies/lib/ActorExtractLinksContentPolicies.ts:68

Class ActorExtractLinksContentPolicies

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorExtractLinksContentPolicies

Properties

ReadonlyactorInitQuery

Default

ReadonlybeforeActors

Readonlybus

Readonlyname

Default

ReadonlyqueryEngine

ReadonlytraverseConditional

Default

Methods

ProtectedgetContentPoliciesFromDocument

Parameters

Returns Promise<ContentPolicy[]>

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[]>

StaticgetContentPolicies

Parameters

Returns ContentPolicy[]

StaticgetContextLogger

Parameters

Returns Logger | undefined

StaticgetCurrentQuadPattern

Parameters

Returns Pattern | undefined

StaticisContentPolicyApplicableForPattern

Parameters

Returns boolean

Settings

On This Page

`Readonly`actorInitQuery

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Readonly`queryEngine

`Readonly`traverseConditional

`Protected`getContentPoliciesFromDocument

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`collectStream

`Static`getContentPolicies

`Static`getContextLogger

`Static`getCurrentQuadPattern

`Static`isContentPolicyApplicableForPattern