arlas-web-contributors / ComputeContributor

Class: ComputeContributor

This contributor computes a metric on the given field, given the filters

Extends

Contributor

Constructors

new ComputeContributor()

new ComputeContributor(identifier, collaborativeSearcheService, configService, collection): ComputeContributor

Build a new contributor.

Parameters

identifier

string

Identifier of contributor.

collaborativeSearcheService

CollaborativesearchService

Instance of CollaborativesearchService from Arlas-web-core.

configService

ConfigService

Instance of ConfigService from Arlas-web-core.

collection

string

Returns

ComputeContributor

Overrides

Contributor.constructor

Defined in

src/contributors/ComputeContributor.ts:53

Properties

cacheDuration

protected cacheDuration: number

Inherited from

Contributor.cacheDuration

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:18

collaborativeSearcheService

collaborativeSearcheService: CollaborativesearchService

Inherited from

Contributor.collaborativeSearcheService

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:9

collection

collection: string

Inherited from

Contributor.collection

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:14

collections

collections: CollectionAggField[]

Inherited from

Contributor.collections

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:15

configService

configService: ConfigService

Inherited from

Contributor.configService

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:8

endCollaborationEvent

endCollaborationEvent: Subject\<CollaborationEvent>

Inherited from

Contributor.endCollaborationEvent

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:16

function

function: string

String value of function to apply to the results of computation metrics

Defined in

src/contributors/ComputeContributor.ts:40

identifier

identifier: string

Inherited from

Contributor.identifier

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:7

isDataUpdating

isDataUpdating: boolean

Inherited from

Contributor.isDataUpdating

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:13

linkedContributorId

linkedContributorId: string

Inherited from

Contributor.linkedContributorId

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:17

metrics

metrics: ComputeConfig[]

Array of which metrics & filters will be computed

Defined in

src/contributors/ComputeContributor.ts:38

metricValue

metricValue: number

Defined in

src/contributors/ComputeContributor.ts:46

processFunction

processFunction: Function

Function to apply to the results of computation metrics

Defined in

src/contributors/ComputeContributor.ts:44

title

title: string

Title of the contributor

Defined in

src/contributors/ComputeContributor.ts:42

Accessors

updateData

Get Signature

get updateData(): boolean

Returns

boolean

whether the data of contributor should be updated.

Set Signature

set updateData(value): void

Parameters

value

boolean

set if the data of contributor should be updated or not.

Returns

void

Inherited from

Contributor.updateData

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:49

Methods

computeData()

computeData(data): ComputationResponse[]

Parameters

data

(ComputationResponse | Hits)[]

Returns

ComputationResponse[]

Overrides

Contributor.computeData

Defined in

src/contributors/ComputeContributor.ts:94

fetchData()

fetchData(collaborationEvent): Observable\<ComputationResponse[]>

Parameters

collaborationEvent

CollaborationEvent

Returns

Observable\<ComputationResponse[]>

Overrides

Contributor.fetchData

Defined in

src/contributors/ComputeContributor.ts:74

getConfigValue()

getConfigValue(key): any

Parameters

key

string

a key defined in configuration.

Returns

any

value of the key in configuration.

Inherited from

Contributor.getConfigValue

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:34

getFilterDisplayName()

getFilterDisplayName(): string

Returns

string

Pretty name of contributor based on query propoerty.

Overrides

Contributor.getFilterDisplayName

Defined in

src/contributors/ComputeContributor.ts:122

getName()

getName(): string

Returns

string

name of contributor set in configuration.

Inherited from

Contributor.getName

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:41

getPackageName()

getPackageName(): string

Returns

string

Package name for the configuration service.

Overrides

Contributor.getPackageName

Defined in

src/contributors/ComputeContributor.ts:128

isMyLinkedContributorCollaboration()

isMyLinkedContributorCollaboration(collaborationEvent): boolean

Parameters

collaborationEvent

CollaborationEvent

Returns

boolean

Inherited from

Contributor.isMyLinkedContributorCollaboration

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:37

isMyOwnCollaboration()

isMyOwnCollaboration(collaborationEvent): boolean

Parameters

collaborationEvent

CollaborationEvent

Returns

boolean

Inherited from

Contributor.isMyOwnCollaboration

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:36

isUpdateEnabledOnOwnCollaboration()

isUpdateEnabledOnOwnCollaboration(): boolean

Returns

boolean

Overrides

Contributor.isUpdateEnabledOnOwnCollaboration

Defined in

src/contributors/ComputeContributor.ts:70

setData()

setData(data): any

Parameters

data

(ComputationResponse | Hits)[]

Returns

any

Overrides

Contributor.setData

Defined in

src/contributors/ComputeContributor.ts:98

setName()

setName(name): void

Parameters

name

string

Returns

void

set the name of the contributor

Inherited from

Contributor.setName

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:45

setSelection()

setSelection(collaboration): any

Parameters

collaboration

Collaboration

Returns

any

Overrides

Contributor.setSelection

Defined in

src/contributors/ComputeContributor.ts:115

updateFromCollaboration()

updateFromCollaboration(collaborationEvent): void

Parameters

collaborationEvent

CollaborationEvent

Returns

void

Inherited from

Contributor.updateFromCollaboration

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:62

getJsonSchema()

static getJsonSchema(): Object

return the json schem of this contributor

Returns

Object

Defined in

src/contributors/ComputeContributor.ts:66