Class ActorQueryResultSerializeStats

Serializes SPARQL results for testing and debugging.

Hierarchy (View Summary)

ActorQueryResultSerializeFixedMediaTypes
- ActorQueryResultSerializeStats

Constructors

constructor

new ActorQueryResultSerializeStats(
args: IActorQueryResultSerializeStatsArgs,
): ActorQueryResultSerializeStats
Parameters
- args: IActorQueryResultSerializeStatsArgs
  \
Returns ActorQueryResultSerializeStats
Default Nested
mediaTypePriorities \

Default Nested
mediaTypeFormats \

Default Nested
httpObserver
Overrides ActorQueryResultSerializeFixedMediaTypes.constructor
- Defined in actor-query-result-serialize-stats/lib/ActorQueryResultSerializeStats.ts:32

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionAbstractMediaTyped<IActionSparqlSerialize>,
    IActorTestAbstractMediaTyped<IActorTest>,
    IActorOutputAbstractMediaTyped<IActorQueryResultSerializeOutput>,
    undefined,
>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<
        IActionAbstractMediaTyped<IActionSparqlSerialize>,
        IActorTestAbstractMediaTyped<IActorTest>,
        IActorOutputAbstractMediaTyped<IActorQueryResultSerializeOutput>,
        undefined,
    >,
    IActionAbstractMediaTyped<IActionSparqlSerialize>,
    IActorTestAbstractMediaTyped<IActorTest>,
    IActorOutputAbstractMediaTyped<IActorQueryResultSerializeOutput>,
    undefined,
>

The bus this actor subscribes to.

`Readonly`httpObserver

httpObserver: ActionObserverHttp

`Readonly`mediaTypeFormats

mediaTypeFormats: Record<string, string>

A record of media types, with media type name as key, and its format IRI as value.

Range

`Readonly`mediaTypePriorities

mediaTypePriorities: Record<string, number>

A record of media types, with media type name as key, and its priority as value. Priorities are numbers between [0, 1].

Range

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Readonly`priorityScale

priorityScale: number

A multiplier for media type priorities. This can be used for keeping the original media types in place, but scaling all of their scores with a certain value.

Range

Methods

createSpecialLine

createSpecialLine(label: string, startTime: number): string
Parameters
- label: string
- startTime: number
Returns string
- Defined in actor-query-result-serialize-stats/lib/ActorQueryResultSerializeStats.ts:59

createStat

createStat(startTime: number, result: number): string
Parameters
- startTime: number
- result: number
Returns string
- Defined in actor-query-result-serialize-stats/lib/ActorQueryResultSerializeStats.ts:53

delay

delay(startTime: number): number
Parameters
- startTime: number
Returns number
- Defined in actor-query-result-serialize-stats/lib/ActorQueryResultSerializeStats.ts:94

`Protected`getDefaultLogData

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

getMediaTypeFormats

getMediaTypeFormats(_context: IActionContext): Promise<Record<string, string>>
Get the media type formats of this given actor.
Parameters
- _context: IActionContext
Returns Promise<Record<string, string>>
A promise that resolves to the media types.
Inherited from ActorQueryResultSerializeFixedMediaTypes.getMediaTypeFormats
- Defined in actor-abstract-mediatyped/lib/ActorAbstractMediaTypedFixed.ts:52

getMediaTypes

getMediaTypes(_context: IActionContext): Promise<Record<string, number>>
Get the media type of this given actor.
Parameters
- _context: IActionContext
Returns Promise<Record<string, number>>
A promise that resolves to the media types.
Inherited from ActorQueryResultSerializeFixedMediaTypes.getMediaTypes
- Defined in actor-abstract-mediatyped/lib/ActorAbstractMediaTypedFixed.ts:44

`Protected`logDebug

logDebug(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorQueryResultSerializeFixedMediaTypes.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 ActorQueryResultSerializeFixedMediaTypes.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 ActorQueryResultSerializeFixedMediaTypes.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 ActorQueryResultSerializeFixedMediaTypes.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 ActorQueryResultSerializeFixedMediaTypes.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 ActorQueryResultSerializeFixedMediaTypes.logWarn
- Defined in core/lib/Actor.ts:122

now

now(): number
Returns number
- Defined in actor-query-result-serialize-stats/lib/ActorQueryResultSerializeStats.ts:90

pushHeader

pushHeader(data: Readable): void
Parameters
- data: Readable
Returns void
- Defined in actor-query-result-serialize-stats/lib/ActorQueryResultSerializeStats.ts:47

run

run(
action: IActionAbstractMediaTyped<IActionSparqlSerialize>,
): Promise<IActorOutputAbstractMediaTyped<IActorQueryResultSerializeOutput>>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionAbstractMediaTyped<IActionSparqlSerialize>
  The action to run.
Returns Promise<IActorOutputAbstractMediaTyped<IActorQueryResultSerializeOutput>>
A promise that resolves to the run result.
Inherited from ActorQueryResultSerializeFixedMediaTypes.run
- Defined in actor-abstract-mediatyped/lib/ActorAbstractMediaTyped.ts:26

runHandle

runHandle(
    action: IActionSparqlSerialize,
    _mediaType: string,
    _context: IActionContext,
): Promise<IActorQueryResultSerializeOutput>
Run the given handle action on this actor.
Parameters
- action: IActionSparqlSerialize
  The handle action to run.
- _mediaType: string
- _context: IActionContext
Returns Promise<IActorQueryResultSerializeOutput>
A promise that resolves to the handle run result.
Overrides ActorQueryResultSerializeFixedMediaTypes.runHandle
- Defined in actor-query-result-serialize-stats/lib/ActorQueryResultSerializeStats.ts:65

runObservable

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

test

test(
action: IActionAbstractMediaTyped<IActionSparqlSerialize>,
): Promise<TestResult<IActorTestAbstractMediaTyped<IActorTest>>>
Check if this actor can run the given action, without actually running it.
Parameters
- action: IActionAbstractMediaTyped<IActionSparqlSerialize>
  The action to test.
Returns Promise<TestResult<IActorTestAbstractMediaTyped<IActorTest>>>
A promise that resolves to the test result.
Inherited from ActorQueryResultSerializeFixedMediaTypes.test
- Defined in actor-abstract-mediatyped/lib/ActorAbstractMediaTyped.ts:40

testHandle

testHandle(
    action: IActionSparqlSerialize,
    mediaType: undefined | string,
    context: IActionContext,
): Promise<TestResult<IActorTest>>
Check if this actor can run the given handle action, without actually running it.
Parameters
- action: IActionSparqlSerialize
  The handle action to test.
- mediaType: undefined | string
  The media type to test.
- context: IActionContext
  An optional context.
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the handle test result.
Inherited from ActorQueryResultSerializeFixedMediaTypes.testHandle
- Defined in actor-abstract-mediatyped/lib/ActorAbstractMediaTypedFixed.ts:24

testHandleChecked

testHandleChecked(
action: IActionSparqlSerialize,
_context: IActionContext,
): Promise<TestResult<boolean>>
Check to see if this actor can handle the given action. The media type has already been checked before this is called.
Parameters
- action: IActionSparqlSerialize
  The action to test.
- _context: IActionContext
  An optional context.
Returns Promise<TestResult<boolean>>
Overrides ActorQueryResultSerializeFixedMediaTypes.testHandleChecked
- Defined in actor-query-result-serialize-stats/lib/ActorQueryResultSerializeStats.ts:37

testMediaType

testMediaType(_context: IActionContext): Promise<TestResult<boolean>>
Check if this actor can emit its media types.
Parameters
- _context: IActionContext
Returns Promise<TestResult<boolean>>
A promise that resolves to the media type run result.
Inherited from ActorQueryResultSerializeFixedMediaTypes.testMediaType
- Defined in actor-abstract-mediatyped/lib/ActorAbstractMediaTypedFixed.ts:40

testMediaTypeFormats

testMediaTypeFormats(_context: IActionContext): Promise<TestResult<boolean>>
Check if this actor can emit its media type formats.
Parameters
- _context: IActionContext
Returns Promise<TestResult<boolean>>
A promise that resolves to the media type run result.
Inherited from ActorQueryResultSerializeFixedMediaTypes.testMediaTypeFormats
- Defined in actor-abstract-mediatyped/lib/ActorAbstractMediaTypedFixed.ts:48

`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 ActorQueryResultSerializeFixedMediaTypes.getContextLogger
- Defined in core/lib/Actor.ts:56

Class ActorQueryResultSerializeStats

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorQueryResultSerializeStats

Default Nested

Default Nested

Default Nested

Properties

ReadonlybeforeActors

Readonlybus

ReadonlyhttpObserver

ReadonlymediaTypeFormats

Range

ReadonlymediaTypePriorities

Range

Readonlyname

Default

ReadonlypriorityScale

Range

Methods

createSpecialLine

Parameters

Returns string

createStat

Parameters

Returns string

delay

Parameters

Returns number

ProtectedgetDefaultLogData

Parameters

Returns any

getMediaTypeFormats

Parameters

Returns Promise<Record<string, string>>

getMediaTypes

Parameters

Returns Promise<Record<string, number>>

ProtectedlogDebug

Parameters

Returns void

ProtectedlogError

Parameters

Returns void

ProtectedlogFatal

Parameters

Returns void

ProtectedlogInfo

Parameters

Returns void

ProtectedlogTrace

Parameters

Returns void

ProtectedlogWarn

Parameters

Returns void

now

Returns number

pushHeader

Parameters

Returns void

run

Parameters

Returns Promise<IActorOutputAbstractMediaTyped<IActorQueryResultSerializeOutput>>

runHandle

Parameters

Returns Promise<IActorQueryResultSerializeOutput>

runObservable

Parameters

Returns Promise<IActorOutputAbstractMediaTyped<IActorQueryResultSerializeOutput>>

test

Parameters

Returns Promise<TestResult<IActorTestAbstractMediaTyped<IActorTest>>>

testHandle

`Readonly`beforeActors

`Readonly`bus

`Readonly`httpObserver

`Readonly`mediaTypeFormats

`Readonly`mediaTypePriorities

`Readonly`name

`Readonly`priorityScale

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger