arlas-web-contributors > "contributors/ComputeContributor" > ComputeContributor

Class: ComputeContributor

Hierarchy

Contributor

↳ ComputeContributor

Index

Constructors

Properties

Methods


Constructors

constructor

new ComputeContributor(identifier: string, collaborativeSearcheService: CollaborativesearchService, configService: ConfigService, collection: string): ComputeContributor

Overrides Contributor.__constructor

Defined in contributors/ComputeContributor.ts:38

Parameters:

Name Type Description
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


Properties

<Protected> cacheDuration

● cacheDuration: number

Inherited from Contributor.cacheDuration

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


collaborativeSearcheService

● collaborativeSearcheService: CollaborativesearchService

Inherited from Contributor.collaborativeSearcheService

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


collection

● collection: string

Inherited from Contributor.collection

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


collections

● collections: CollectionAggField[]

Inherited from Contributor.collections

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


configService

● configService: ConfigService

Inherited from Contributor.configService

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


endCollaborationEvent

● endCollaborationEvent: Subject<unknown>

Inherited from Contributor.endCollaborationEvent

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


function

● function: string = this.getConfigValue('function')

Defined in contributors/ComputeContributor.ts:33


identifier

● identifier: string

Inherited from Contributor.identifier

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


isDataUpdating

● isDataUpdating: boolean

Inherited from Contributor.isDataUpdating

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


metricValue

● metricValue: number

Defined in contributors/ComputeContributor.ts:38


metrics

● metrics: Array<object> = this.getConfigValue('metrics')

Defined in contributors/ComputeContributor.ts:31


title

● title: string = this.getConfigValue('title')

Defined in contributors/ComputeContributor.ts:35


updateData

● updateData: boolean

Inherited from Contributor.updateData

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:46


Methods

computeData

computeData(data: Array<ComputationResponse>): Array<ComputationResponse>

Overrides Contributor.computeData

Defined in contributors/ComputeContributor.ts:75

Parameters:

Name Type
data Array<ComputationResponse>

Returns: Array<ComputationResponse>


fetchData

fetchData(collaborationEvent: CollaborationEvent): Observable<Array<ComputationResponse>>

Overrides Contributor.fetchData

Defined in contributors/ComputeContributor.ts:59

Parameters:

Name Type
collaborationEvent CollaborationEvent

Returns: Observable<Array<ComputationResponse>>


getConfigValue

getConfigValue(key: string): any

Inherited from Contributor.getConfigValue

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:31

Parameters:

Name Type Description
key string a `key` defined in configuration.

Returns: any value of the key in configuration.


getFilterDisplayName

getFilterDisplayName(): string

Overrides Contributor.getFilterDisplayName

Defined in contributors/ComputeContributor.ts:93

Returns: string Pretty name of contributor based on query propoerty.


getName

getName(): string

Inherited from Contributor.getName

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:35

Returns: string name of contributor set in configuration.


getPackageName

getPackageName(): string

Overrides Contributor.getPackageName

Defined in contributors/ComputeContributor.ts:99

Returns: string Package name for the configuration service.


setData

setData(data: Array<ComputationResponse>): any

Overrides Contributor.setData

Defined in contributors/ComputeContributor.ts:79

Parameters:

Name Type
data Array<ComputationResponse>

Returns: any


setName

setName(name: string): void

Inherited from Contributor.setName

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:39

Parameters:

Name Type
name string

Returns: void set the name of the contributor


setSelection

setSelection(collaboration: Collaboration): any

Overrides Contributor.setSelection

Defined in contributors/ComputeContributor.ts:86

Parameters:

Name Type
collaboration Collaboration

Returns: any


updateFromCollaboration

updateFromCollaboration(collaborationEvent: CollaborationEvent): void

Inherited from Contributor.updateFromCollaboration

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:55

Parameters:

Name Type
collaborationEvent CollaborationEvent

Returns: void


<Static> getJsonSchema

getJsonSchema(): Object

Defined in contributors/ComputeContributor.ts:55

Returns: Object