arlas-web-core > "models/contributor" > Contributor

Class: Contributor

Hierarchy

Contributor

Index

Constructors

• constructor

Properties

• cacheDuration
• collaborativeSearcheService
• collection
• collections
• configService
• endCollaborationEvent
• identifier
• isDataUpdating

Accessors

• updateData

Methods

• computeData
• fetchData
• getConfigValue
• getFilterDisplayName
• getName
• getPackageName
• setData
• setName
• setSelection
• updateFromCollaboration

---

Constructors

constructor

⊕ new Contributor(identifier: string, configService: ConfigService, collaborativeSearcheService: CollaborativesearchService, collection?: string): Contributor

Defined in models/contributor.ts:36

Parameters:

Name	Type	Description
identifier	string	string identifier of the contributor.
configService	ConfigService	configService of the contributor.
collaborativeSearcheService	CollaborativesearchService
Optional collection	string

Returns: Contributor

---

Properties

<Protected> cacheDuration

● cacheDuration: number

Defined in models/contributor.ts:36

---

collaborativeSearcheService

● collaborativeSearcheService: CollaborativesearchService

Defined in models/contributor.ts:45

---

collection

● collection: string

Defined in models/contributor.ts:33

---

collections

● collections: CollectionAggField[]

Defined in models/contributor.ts:34

---

configService

● configService: ConfigService

Defined in models/contributor.ts:44

---

endCollaborationEvent

● endCollaborationEvent: Subject<Object> = new Subject()

Defined in models/contributor.ts:35

---

identifier

● identifier: string

Defined in models/contributor.ts:43

---

isDataUpdating

● isDataUpdating: boolean = false

Defined in models/contributor.ts:32

---

Accessors

updateData

updateData:

Defined in models/contributor.ts:114 Defined in models/contributor.ts:121

---

Methods

<Abstract> computeData

▸ computeData(data: any): any

Defined in models/contributor.ts:133

Parameters:

Name	Type
data	any

Returns: any

---

<Abstract> fetchData

▸ fetchData(collaborationEvent: CollaborationEvent): Observable<any>

Defined in models/contributor.ts:131

Parameters:

Name	Type
collaborationEvent	CollaborationEvent

Returns: Observable<any>

---

getConfigValue

▸ getConfigValue(key: string): any

Defined in models/contributor.ts:86

Parameters:

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

Returns: any value of the key in configuration.

---

<Abstract> getFilterDisplayName

▸ getFilterDisplayName(): string

Defined in models/contributor.ts:129

Returns: string name and live informations about filter contributor.

---

getName

▸ getName(): string

Defined in models/contributor.ts:100

Returns: string name of contributor set in configuration.

---

<Abstract> getPackageName

▸ getPackageName(): string

Defined in models/contributor.ts:80

Returns: string package name of contributor used in configuration.

---

<Abstract> setData

▸ setData(data: any): any

Defined in models/contributor.ts:135

Parameters:

Name	Type
data	any

Returns: any

---

setName

▸ setName(name: string): void

Defined in models/contributor.ts:107

Parameters:

Name	Type
name	string

Returns: void set the name of the contributor

---

<Abstract> setSelection

▸ setSelection(data: any, c: Collaboration): any

Defined in models/contributor.ts:137

Parameters:

Name	Type
data	any
c	Collaboration

Returns: any

---

updateFromCollaboration

▸ updateFromCollaboration(collaborationEvent: CollaborationEvent): void

Defined in models/contributor.ts:139

Parameters:

Name	Type
collaborationEvent	CollaborationEvent

Returns: void

---