Class ActorRdfMetadataExtractHydraControls

An RDF Metadata Extract Actor that extracts all Hydra controls from the metadata stream.

Hierarchy (View Summary)

ActorRdfMetadataExtract
- ActorRdfMetadataExtractHydraControls

Index

Constructors

constructor

new ActorRdfMetadataExtractHydraControls(
args: IActorRdfMetadataExtractArgs,
): ActorRdfMetadataExtractHydraControls
Parameters
- args: IActorRdfMetadataExtractArgs
Returns ActorRdfMetadataExtractHydraControls
Overrides ActorRdfMetadataExtract.constructor
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:21

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionRdfMetadataExtract,
    IActorTest,
    IActorRdfMetadataExtractOutput,
    undefined,
>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<
        IActionRdfMetadataExtract,
        IActorTest,
        IActorRdfMetadataExtractOutput,
        undefined,
    >,
    IActionRdfMetadataExtract,
    IActorTest,
    IActorRdfMetadataExtractOutput,
    undefined,
>

The bus this actor subscribes to.

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Protected` `Readonly`parsedUriTemplateCache

parsedUriTemplateCache: Record<string, UriTemplate> = {}

`Static` `Readonly`HYDRA

HYDRA: string = 'http://www.w3.org/ns/hydra/core#'

`Static` `Readonly`LINK_TYPES

LINK_TYPES: string[] = ...

Methods

`Protected`getDefaultLogData

getDefaultLogData(context: IActionContext, data?: () => any): any
Parameters
- context: IActionContext
- Optionaldata: () => any
Returns any
Inherited from ActorRdfMetadataExtract.getDefaultLogData
- Defined in core/lib/Actor.ts:95

getHydraProperties

getHydraProperties(
metadata: Stream,
): Promise<Record<string, Record<string, string[]>>>
Collect all hydra properties from a given metadata stream in a nice convenient nested hash (property / subject / objects).
Parameters
- metadata: Stream
Returns Promise<Record<string, Record<string, string[]>>>
The collected Hydra properties.
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:111

getLinks

getLinks(
pageUrl: string,
hydraProperties: Record<string, Record<string, string[]>>,
): Record<string, any>
Collect all Hydra page links from the given Hydra properties object.
Parameters
- pageUrl: string
  The page URL in which the Hydra properties are defined.
- hydraProperties: Record<string, Record<string, string[]>>
  The collected Hydra properties.
Returns Record<string, any>
The Hydra links
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:35

getSearchForms

getSearchForms(
hydraProperties: Record<string, Record<string, string[]>>,
): ISearchForms
Collect all search forms from the given Hydra properties object.
Parameters
- hydraProperties: Record<string, Record<string, string[]>>
  The collected Hydra properties.
Returns ISearchForms
The search forms.
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:64

`Protected`logDebug

logDebug(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logDebug
- Defined in core/lib/Actor.ts:108

`Protected`logError

logError(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logError
- Defined in core/lib/Actor.ts:129

`Protected`logFatal

logFatal(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logFatal
- Defined in core/lib/Actor.ts:136

`Protected`logInfo

logInfo(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logInfo
- Defined in core/lib/Actor.ts:115

`Protected`logTrace

logTrace(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logTrace
- Defined in core/lib/Actor.ts:101

`Protected`logWarn

logWarn(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logWarn
- Defined in core/lib/Actor.ts:122

parseUriTemplateCached

parseUriTemplateCached(template: string): UriTemplate
Parse a URI template, or retrieve it from a cache.
Parameters
- template: string
  A URI template string.
Returns UriTemplate
A parsed URI template object.
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:50

run

run(action: IActionRdfMetadataExtract): Promise<IActorRdfMetadataExtractOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionRdfMetadataExtract
  The action to run.
Returns Promise<IActorRdfMetadataExtractOutput>
A promise that resolves to the run result.
Overrides ActorRdfMetadataExtract.run
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:130

runObservable

runObservable(
action: IActionRdfMetadataExtract,
sideData: undefined,
): Promise<IActorRdfMetadataExtractOutput>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: IActionRdfMetadataExtract
  The action to run.
- sideData: undefined
Returns Promise<IActorRdfMetadataExtractOutput>
A promise that resolves to the run result.
Inherited from ActorRdfMetadataExtract.runObservable
- Defined in core/lib/Actor.ts:87

test

test(_action: IActionRdfMetadataExtract): Promise<TestResult<IActorTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- _action: IActionRdfMetadataExtract
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the test result.
Overrides ActorRdfMetadataExtract.test
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:25

`Static`getContextLogger

getContextLogger(context: IActionContext): undefined | Logger
Get the logger from the given context.
Parameters
- context: IActionContext
  An optional context.
Returns undefined | Logger
The logger or undefined.
Inherited from ActorRdfMetadataExtract.getContextLogger
- Defined in core/lib/Actor.ts:56

Class ActorRdfMetadataExtractHydraControls

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorRdfMetadataExtractHydraControls

Properties

ReadonlybeforeActors

Readonlybus

Readonlyname

Default

Protected ReadonlyparsedUriTemplateCache

Static ReadonlyHYDRA

Static ReadonlyLINK_TYPES

Methods

ProtectedgetDefaultLogData

Parameters

Returns any

getHydraProperties

Parameters

Returns Promise<Record<string, Record<string, string[]>>>

getLinks

Parameters

Returns Record<string, any>

getSearchForms

Parameters

Returns ISearchForms

ProtectedlogDebug

Parameters

Returns void

ProtectedlogError

Parameters

Returns void

ProtectedlogFatal

Parameters

Returns void

ProtectedlogInfo

Parameters

Returns void

ProtectedlogTrace

Parameters

Returns void

ProtectedlogWarn

Parameters

Returns void

parseUriTemplateCached

Parameters

Returns UriTemplate

run

Parameters

Returns Promise<IActorRdfMetadataExtractOutput>

runObservable

Parameters

Returns Promise<IActorRdfMetadataExtractOutput>

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Protected` `Readonly`parsedUriTemplateCache

`Static` `Readonly`HYDRA

`Static` `Readonly`LINK_TYPES

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger