Skip to content

arlas-wui-toolkit > "src/app/services/startup/startup.service" > ArlasCollaborativesearchService

Class: ArlasCollaborativesearchService

Hierarchy

CollaborativesearchService

↳ ArlasCollaborativesearchService

Index

Constructors

Properties

Methods


Constructors

constructor

new ArlasCollaborativesearchService(): ArlasCollaborativesearchService

Overrides CollaborativesearchService.__constructor

Defined in src/app/services/startup/startup.service.ts:74

Returns: ArlasCollaborativesearchService


Properties

collaborationBus

● collaborationBus: Subject<CollaborationEvent>

Inherited from CollaborativesearchService.collaborationBus

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:11

Bus of CollaborationEvent.


collaborationErrorBus

● collaborationErrorBus: Subject<Error>

Inherited from CollaborativesearchService.collaborationErrorBus

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:47

Bus of Error.


collaborations

● collaborations: Map<string, Collaboration>

Inherited from CollaborativesearchService.collaborations

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:19

Registry of Collaborations, Map of contributor identifier,Collaboration.


collection

● collection: string

Inherited from CollaborativesearchService.collection

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:27

ARLAS SERVER collection used by the collaborativesearchService.


contribFilterBus

● contribFilterBus: Subject<Contributor>

Inherited from CollaborativesearchService.contribFilterBus

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:15

Bus of CollaborationEvent.


countAll

● countAll: Observable<number>

Inherited from CollaborativesearchService.countAll

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:35

Number of entity return by the collaborativesearchService at any time


max_age

● max_age: number

Inherited from CollaborativesearchService.max_age

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:31

ARLAS SERVER max age cache used by the collaborativesearchService.


ongoingSubscribe

● ongoingSubscribe: Subject<number>

Inherited from CollaborativesearchService.ongoingSubscribe

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:39

Bus number of ongoing subscribe to the collaborativesearchService


registry

● registry: Map<string, Contributor>

Inherited from CollaborativesearchService.registry

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:23

Registry of Contributor, Map of contributor identifier,Contributor.


totalSubscribe

● totalSubscribe: number

Inherited from CollaborativesearchService.totalSubscribe

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:43

Bus number of ongoing subscribe to the collaborativesearchService


Methods

dataModelBuilder

dataModelBuilder(filter: string): Object

Inherited from CollaborativesearchService.dataModelBuilder

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:127

Parameters:

Name Type
filter string

Returns: Object


describe

describe(collection: string, pretty?: boolean): Observable<CollectionReferenceDescription>

Inherited from CollaborativesearchService.describe

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:252

Describe the structure and the content of the given collection.

Parameters:

Name Type Description
collection string collection name
Optional pretty boolean Whether pretty print or not

Returns: Observable<CollectionReferenceDescription>


disable

disable(contributorId: string): void

Inherited from CollaborativesearchService.disable

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:216

Disable a contributor collaboration from its identifier.

Parameters:

Name Type
contributorId string

Returns: void


enable

enable(contributorId: string): void

Inherited from CollaborativesearchService.enable

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:212

Enable a contributor collaboration from its identifier.

Parameters:

Name Type
contributorId string

Returns: void


getAllContributors

getAllContributors(): Array<string>

Inherited from CollaborativesearchService.getAllContributors

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:221

Retrieve all the contributor identifiers.

Returns: Array<string> List of contributor idenfiers.


getCollaboration

getCollaboration(contributorId: string): Collaboration

Inherited from CollaborativesearchService.getCollaboration

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:139

Retrieve the collaboration from a contributor identifier.

Parameters:

Name Type Description
contributorId string Identifier of a contributor.

Returns: Collaboration Collaboration.


getConfigService

getConfigService(): ConfigService

Inherited from CollaborativesearchService.getConfigService

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:101

Return the Configuraion Service.

Returns: ConfigService ConfigService.


getDisableContributors

getDisableContributors(): Array<string>

Inherited from CollaborativesearchService.getDisableContributors

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:231

Retrieve the contributor identifiers for which the collaboration is disabled.

Returns: Array<string> List of contributor idenfiers.


getEnableContributors

getEnableContributors(): Array<string>

Inherited from CollaborativesearchService.getEnableContributors

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:226

Retrieve the contributor identifiers for which the collaboration is enabled.

Returns: Array<string> List of contributor idenfiers.


getExploreApi

getExploreApi(): ExploreApi

Inherited from CollaborativesearchService.getExploreApi

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:81

Return the ARLAS Explore API.

Returns: ExploreApi ExploreApi.


getFetchOptions

getFetchOptions(): object

Inherited from CollaborativesearchService.getFetchOptions

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:69

Return options used to fetch call.

Returns: object Object.


getFinalFilter

getFinalFilter(filters: Array<Filter>): Filter

Inherited from CollaborativesearchService.getFinalFilter

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:246

Parameters:

Name Type
filters Array<Filter>

Returns: Filter


getUrl

getUrl(projection: [geoaggregate | geosearch | aggregate | count | geohashgeoaggregate | search | tiledgeosearch, Array<Aggregation>], filters: Array<Filter>): string

Inherited from CollaborativesearchService.getUrl

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:245

Build query parameters from aggregation and filters

Parameters:

Name Type
projection [geoaggregate
filters Array<Filter>

Returns: string Url encoded string


getWriteApi

getWriteApi(): WriteApi

Inherited from CollaborativesearchService.getWriteApi

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:91

Return the ARLAS Write API.

Returns: WriteApi WriteApi.


isEnable

isEnable(contributorId: string): boolean

Inherited from CollaborativesearchService.isEnable

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:236

Retrieve enabled parameter of collaboration from a contributor identifier.

Parameters:

Name Type
contributorId string

Returns: boolean Contributor collaboration enabled properties.


register

register(identifier: string, contributor: Contributor): void

Inherited from CollaborativesearchService.register

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:110

Register contributor with its identifier in the map contributor registry.

Parameters:

Name Type
identifier string
contributor Contributor

Returns: void


removeAll

removeAll(): void

Inherited from CollaborativesearchService.removeAll

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:126

Remove all the collaborations filters, notify the collaborationBus of a all removing changement.

Returns: void


removeFilter

removeFilter(contributorId: string): void

Inherited from CollaborativesearchService.removeFilter

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:122

Remove Filter from the registry of collaboration , notify the collaborationBus of a removing changement.

Parameters:

Name Type Description
contributorId string Sting identifier of contributor.

Returns: void


resolveAggregation

resolveAggregation(projection: [aggregate, Array<Aggregation>], collaborations: Map<string, Collaboration>, contributorId?: string, filter?: Filter): Observable<AggregationResponse>

Inherited from CollaborativesearchService.resolveAggregation

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:199

Resolve an ARLAS Server Aggregation request for an optional contributor and optional filters.

Parameters:

Name Type Description
projection [aggregate, Array<Aggregation>] Type of projection of ARLAS Server request :Aggregation.
collaborations Map<string, Collaboration>
Optional contributorId string Identifier contributor to resolve the request with the collaboration of this contributor.
Optional filter Filter ARLAS API filter to resolve the request with this filter in addition.

Returns: Observable<AggregationResponse> ARLAS Server observable.


resolveButNotAggregation

resolveButNotAggregation(projection: [aggregate, Array<Aggregation>], collaborations: Map<string, Collaboration>, contributorId?: string, filter?: Filter): Observable<AggregationResponse>

Inherited from CollaborativesearchService.resolveButNotAggregation

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:191

Resolve an ARLAS Server Aggregation request with all the collaborations enabled in the collaboration registry expect for the contributor given in second optionnal parameter.

Parameters:

Name Type Description
projection [aggregate, Array<Aggregation>] Type of projection of ARLAS Server request:Aggregation.
collaborations Map<string, Collaboration>
Optional contributorId string Identifier contributor to resolve the request without the collaboration of this contributor.
Optional filter Filter ARLAS API filter to resolve the request with this filter in addition.

Returns: Observable<AggregationResponse> ARLAS Server observable.


resolveButNotFeatureCollection

resolveButNotFeatureCollection(projection: [geosearch, Search] | [tiledgeosearch, TiledSearch] | [geohashgeoaggregate, GeohashAggregation] | [geoaggregate, Array<Aggregation>], collaborations: Map<string, Collaboration>, isFlat?: boolean, contributorId?: string, filter?: Filter): Observable<FeatureCollection>

Inherited from CollaborativesearchService.resolveButNotFeatureCollection

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:173

Resolve an ARLAS Server Geosearch or Geoaggregate request with all the collaborations enabled in the collaboration registry expect for the contributor given in second optionnal parameter.

Parameters:

Name Type Description
projection [geosearch, Search] [tiledgeosearch, TiledSearch]
collaborations Map<string, Collaboration>
Optional isFlat boolean Boolean option to isFlat output geojson properties.
Optional contributorId string Identifier contributor to resolve the request without the collaboration of this contributor.
Optional filter Filter ARLAS API filter to resolve the request with this filter in addition.

Returns: Observable<FeatureCollection> ARLAS Server observable.


resolveButNotFieldRange

resolveButNotFieldRange(projection: [range, RangeRequest], collaborations: Map<string, Collaboration>, contributorId?: string, filter?: Filter): Observable<RangeResponse>

Inherited from CollaborativesearchService.resolveButNotFieldRange

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:208

Resolve an ARLAS Server Range request with all the collaborations enabled in the collaboration registry expect for the contributor given in second optionnal parameter.

Parameters:

Name Type Description
projection [range, RangeRequest] Type of projection of ARLAS Server request:Aggregation.
collaborations Map<string, Collaboration>
Optional contributorId string Identifier contributor to resolve the request without the collaboration of this contributor.
Optional filter Filter ARLAS API filter to resolve the request with this filter in addition.

Returns: Observable<RangeResponse> ARLAS Server observable.


resolveButNotHits

resolveButNotHits(projection: [search, Search] | [count, Count], collaborations: Map<string, Collaboration>, contributorId?: string, filter?: Filter): Observable<Hits>

Inherited from CollaborativesearchService.resolveButNotHits

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:148

Resolve an ARLAS Server Search or Count request with all the collaborations enabled in the collaboration registry expect for the contributor given in second optionnal parameter.

Parameters:

Name Type Description
projection [search, Search] [count, Count]
collaborations Map<string, Collaboration>
Optional contributorId string Identifier contributor to resolve the request without the collaboration of this contributor.
Optional filter Filter ARLAS API filter to resolve the request with this filter in addition.

Returns: Observable<Hits> ARLAS Server observable.


resolveComputeHits

resolveComputeHits(projection: [search, Search] | [count, Count], filters: Array<Filter>): Observable<Hits>

Inherited from CollaborativesearchService.resolveComputeHits

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:163

Resolve an ARLAS Server Search or Count request for an array of filter.

Parameters:

Name Type Description
projection [search, Search] [count, Count]
filters Array<Filter> ARLAS API filters to resolve the request with compute

Returns: Observable<Hits> ARLAS Server observable.


resolveFeatureCollection

resolveFeatureCollection(projection: [geosearch, Search] | [tiledgeosearch, TiledSearch] | [geohashgeoaggregate, GeohashAggregation] | [geoaggregate, Array<Aggregation>], isFlat: boolean, collaborations: Map<string, Collaboration>, contributorId?: string, filter?: Filter): Observable<FeatureCollection>

Inherited from CollaborativesearchService.resolveFeatureCollection

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:182

Resolve an ARLAS Server Geosearch or Geoaggregate request for an optional contributor and optional filters.

Parameters:

Name Type Description
projection [geosearch, Search] [tiledgeosearch, TiledSearch]
isFlat boolean Boolean option to flat output geojson properties.
collaborations Map<string, Collaboration>
Optional contributorId string Identifier contributor to resolve the request with the collaboration of this contributor.
Optional filter Filter ARLAS API filter to resolve the request with this filter in addition.

Returns: Observable<FeatureCollection> ARLAS Server observable.


resolveHits

resolveHits(projection: [search, Search] | [count, Count], collaborations: Map<string, Collaboration>, contributorId?: string, filter?: Filter): Observable<Hits>

Inherited from CollaborativesearchService.resolveHits

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:156

Resolve an ARLAS Server Search or Count request for an optional contributor and optional filters.

Parameters:

Name Type Description
projection [search, Search] [count, Count]
collaborations Map<string, Collaboration>
Optional contributorId string Identifier contributor to resolve the request with the collaboration of this contributor.
Optional filter Filter ARLAS API filter to resolve the request with this filter in addition.

Returns: Observable<Hits> ARLAS Server observable.


setCollaborations

setCollaborations(dataModel: Object): void

Inherited from CollaborativesearchService.setCollaborations

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:133

Initialize all the contributor in the state of dataModel.

Parameters:

Name Type Description
dataModel Object

Returns: void


setConfigService

setConfigService(configService: ConfigService): void

Inherited from CollaborativesearchService.setConfigService

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:106

Set the Configuraion Service.

Parameters:

Name Type Description
configService ConfigService ConfigService.

Returns: void


setCountAll

setCountAll(collaborations: Map<string, Collaboration>): void

Inherited from CollaborativesearchService.setCountAll

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:240

Update countAll property.

Parameters:

Name Type
collaborations Map<string, Collaboration>

Returns: void


setExploreApi

setExploreApi(exploreApi: ExploreApi): void

Inherited from CollaborativesearchService.setExploreApi

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:86

Set the ARLAS Explore API.

Parameters:

Name Type
exploreApi ExploreApi

Returns: void


setFetchOptions

setFetchOptions(fetchOptions: any): void

Inherited from CollaborativesearchService.setFetchOptions

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:76

Set the fetch options.

Parameters:

Name Type Description
fetchOptions any : Object.

Returns: void


setFilter

setFilter(contributorId: string, collaboration: Collaboration): void

Inherited from CollaborativesearchService.setFilter

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:116

Add Filter setted by a contributor in the registry of collaboration, notify the collaborationBus of a changement.

Parameters:

Name Type Description
contributorId string Sting identifier of contributor.
collaboration Collaboration Collaboration added by the contributor.

Returns: void


setWriteApi

setWriteApi(writeApi: WriteApi): void

Inherited from CollaborativesearchService.setWriteApi

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:96

Set the ARLAS Write API.

Parameters:

Name Type
writeApi WriteApi

Returns: void


tag

tag(collection: string, body?: TagRequest, pretty?: boolean): Observable<UpdateResponse>

Inherited from CollaborativesearchService.tag

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:259

Search and tag the elements found in the collection, given the filters

Parameters:

Name Type Description
collection string collection name
Optional body TagRequest Request body
Optional pretty boolean Whether pretty print or not

Returns: Observable<UpdateResponse>


untag

untag(collection: string, body?: TagRequest, pretty?: boolean): Observable<UpdateResponse>

Inherited from CollaborativesearchService.untag

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:266

Search and untag the elements found in the collection, given the filters

Parameters:

Name Type Description
collection string collection name
Optional body TagRequest Request body
Optional pretty boolean Whether pretty print or not

Returns: Observable<UpdateResponse>


urlBuilder

urlBuilder(): string

Inherited from CollaborativesearchService.urlBuilder

Defined in node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:128

Returns: string