arlas-wui-toolkit / Exports / ArlasCollaborativesearchService

Class: ArlasCollaborativesearchService

Hierarchy

  • CollaborativesearchService

↳ ArlasCollaborativesearchService

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new ArlasCollaborativesearchService()

Overrides

CollaborativesearchService.constructor

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:104

Properties

collaborationBus

• collaborationBus: Subject<CollaborationEvent>

Bus of CollaborationEvent.

Inherited from

CollaborativesearchService.collaborationBus

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:12

collaborationErrorBus

• collaborationErrorBus: Subject<Error>

Bus of Error.

Inherited from

CollaborativesearchService.collaborationErrorBus

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:50

collaborations

• collaborations: Map<string, Collaboration>

Registry of Collaborations, Map of contributor identifier,Collaboration.

Inherited from

CollaborativesearchService.collaborations

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:20

collections

• collections: Set<string>

ARLAS SERVER collections that declared in the contributos

Inherited from

CollaborativesearchService.collections

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:30

contribFilterBus

• contribFilterBus: Subject<Contributor>

Bus of CollaborationEvent.

Inherited from

CollaborativesearchService.contribFilterBus

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:16

countAll

• countAll: Observable<CollectionCount[]>

Number of entity return by the collaborativesearchService at any time

Inherited from

CollaborativesearchService.countAll

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:38

defaultCollection

• defaultCollection: string

ARLAS SERVER collection used by default by the contributors.

Inherited from

CollaborativesearchService.defaultCollection

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:28

endOfUrlCollaboration

• endOfUrlCollaboration: boolean = false

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:108

max_age

• max_age: number

ARLAS SERVER max age cache used by the collaborativesearchService.

Inherited from

CollaborativesearchService.max_age

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:34

ongoingSubscribe

• ongoingSubscribe: Subject<number>

Bus number of ongoing subscribe to the collaborativesearchService

Inherited from

CollaborativesearchService.ongoingSubscribe

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:42

registry

• registry: Map<string, Contributor>

Registry of Contributor, Map of contributor identifier,Contributor.

Inherited from

CollaborativesearchService.registry

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:24

totalSubscribe

• totalSubscribe: number

Bus number of ongoing subscribe to the collaborativesearchService

Inherited from

CollaborativesearchService.totalSubscribe

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:46

Methods

dataModelBuilder

▸ dataModelBuilder(filter, changeOperator?): any

Parameters

Name Type Default value Description
filter any undefined The filter query parameter
changeOperator boolean false Whether to change the operator of the filters applied for TreeContributors

Returns

any

A dictionnary of the current collaborations

Overrides

CollaborativesearchService.dataModelBuilder

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:115

describe

▸ describe(collection, pretty?, max_age?): Observable<CollectionReferenceDescription>

Describe the structure and the content of the given collection.

Parameters

Name Type Description
collection string collection name
pretty? boolean Whether pretty print or not
max_age? number Duration of browser cache.s

Returns

Observable<CollectionReferenceDescription>

Inherited from

CollaborativesearchService.describe

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:304

disable

▸ disable(contributorId): void

Disable a contributor collaboration from its identifier.

Parameters

Name Type
contributorId string

Returns

void

Inherited from

CollaborativesearchService.disable

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:264

enable

▸ enable(contributorId): void

Enable a contributor collaboration from its identifier.

Parameters

Name Type
contributorId string

Returns

void

Inherited from

CollaborativesearchService.enable

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:260

getAllContributors

▸ getAllContributors(): string[]

Retrieve all the contributor identifiers.

Returns

string[]

List of contributor idenfiers.

Inherited from

CollaborativesearchService.getAllContributors

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:269

getCollaboration

▸ getCollaboration(contributorId): Collaboration

Retrieve the collaboration from a contributor identifier.

Parameters

Name Type Description
contributorId string Identifier of a contributor.

Returns

Collaboration

Collaboration.

Inherited from

CollaborativesearchService.getCollaboration

Defined in

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

getConfigService

▸ getConfigService(): ConfigService

Return the Configuraion Service.

Returns

ConfigService

ConfigService.

Inherited from

CollaborativesearchService.getConfigService

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:93

getDisableContributors

▸ getDisableContributors(): string[]

Retrieve the contributor identifiers for which the collaboration is disabled.

Returns

string[]

List of contributor idenfiers.

Inherited from

CollaborativesearchService.getDisableContributors

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:279

getEnableContributors

▸ getEnableContributors(): string[]

Retrieve the contributor identifiers for which the collaboration is enabled.

Returns

string[]

List of contributor idenfiers.

Inherited from

CollaborativesearchService.getEnableContributors

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:274

getExploreApi

▸ getExploreApi(): ExploreApi

Return the ARLAS Explore API.

Returns

ExploreApi

ExploreApi.

Inherited from

CollaborativesearchService.getExploreApi

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:83

getFetchOptions

▸ getFetchOptions(): Object

Return options used to fetch call.

Returns

Object

Object.

Name Type
credentials string
referrerPolicy? string
responseType? string
signal? any

Inherited from

CollaborativesearchService.getFetchOptions

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:68

getFilters

▸ getFilters(collection): Filter[]

Parameters

Name Type
collection string

Returns

Filter[]

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:149

getFinalFilter

▸ getFinalFilter(filters): Filter

Parameters

Name Type
filters Filter[]

Returns

Filter

Inherited from

CollaborativesearchService.getFinalFilter

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:297

getUrl

▸ getUrl(projection, filters, max_age?): string

Build query parameters from aggregation and filters

Parameters

Name Type
projection [aggregate | geoaggregate | geohashgeoaggregate | geotilegeoaggregate | count | search | geosearch | tiledgeosearch | shapesearch | shapeaggregate, Aggregation[]]
filters Filter[]
max_age? number

Returns

string

Url encoded string

Inherited from

CollaborativesearchService.getUrl

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:293

isEnable

▸ isEnable(contributorId): boolean

Retrieve enabled parameter of collaboration from a contributor identifier.

Parameters

Name Type
contributorId string

Returns

boolean

Contributor collaboration enabled properties.

Inherited from

CollaborativesearchService.isEnable

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:284

list

▸ list(pretty?): Observable<CollectionReferenceDescription[]>

Lists the collections configured in ARLAS.

Parameters

Name Type Description
pretty? boolean Whether pretty print or not

Returns

Observable<CollectionReferenceDescription[]>

Inherited from

CollaborativesearchService.list

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:309

register

▸ register(identifier, contributor): void

Register contributor with its identifier in the map contributor registry.

Parameters

Name Type
identifier string
contributor Contributor

Returns

void

Inherited from

CollaborativesearchService.register

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:102

registerCollections

▸ registerCollections(contributor): void

Register collections of the given contributor in a collections registry.

Parameters

Name Type
contributor Contributor

Returns

void

Inherited from

CollaborativesearchService.registerCollections

Defined in

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

removeAll

▸ removeAll(): void

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

Returns

void

Inherited from

CollaborativesearchService.removeAll

Defined in

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

removeFilter

▸ removeFilter(contributorId): void

Removes the contributor's collaboration of the registry of collaborations. Notifies the collaborationBus of the removed collaboration. If the given contributor is linked to another one, the linked contributor's collaboration will be removed as well. The collaborationBus needs to be notified of this removal as well.

Parameters

Name Type Description
contributorId string Sting identifier of contributor.

Returns

void

Inherited from

CollaborativesearchService.removeFilter

Defined in

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

resolveAggregation

▸ resolveAggregation(projection, collaborations, collection, contributorId?, filter?, isFlat?, max_age?): Observable<AggregationResponse>

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

Parameters

Name Type Description
projection [aggregate, Aggregation[]] Type of projection of ARLAS Server request :Aggregation.
collaborations Map<string, Collaboration> -
collection any -
contributorId? string Identifier contributor to resolve the request with the collaboration of this contributor.
filter? Filter ARLAS API filter to resolve the request with this filter in addition.
isFlat? boolean Whether flatten json.
max_age? number Duration of browser cache.

Returns

Observable<AggregationResponse>

ARLAS Server observable.

Inherited from

CollaborativesearchService.resolveAggregation

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:238

resolveButNotAggregation

▸ resolveButNotAggregation(projection, collaborations, collection, contributorId?, filter?, isFlat?, max_age?): Observable<AggregationResponse>

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

Parameters

Name Type Description
projection [aggregate, Aggregation[]] Type of projection of ARLAS Server request:Aggregation.
collaborations Map<string, Collaboration> -
collection any -
contributorId? string Identifier contributor to resolve the request without the collaboration of this contributor.
filter? Filter ARLAS API filter to resolve the request with this filter in addition.
isFlat? boolean Whether flatten json.
max_age? number Duration of browser cache.

Returns

Observable<AggregationResponse>

ARLAS Server observable.

Inherited from

CollaborativesearchService.resolveButNotAggregation

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:225

resolveButNotComputation

▸ resolveButNotComputation(projection, collaborations, collection, contributorId?, filter?, isFlat?, max_age?): Observable<ComputationResponse>

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

Parameters

Name Type Description
projection [compute, ComputationRequest] Type of projection of ARLAS Server request : ComputationRequest.
collaborations Map<string, Collaboration> Map
collection any -
contributorId? string Identifier contributor to resolve the request without the collaboration of this contributor.
filter? Filter ARLAS API filter to resolve the request with this filter in addition.
isFlat? boolean Whether flatten json.
max_age? number Duration of browser cache.

Returns

Observable<ComputationResponse>

ARLAS Server observable.

Inherited from

CollaborativesearchService.resolveButNotComputation

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:253

resolveButNotFeatureCollection

▸ resolveButNotFeatureCollection(projection, collaborations, collection, isFlat?, contributorId?, filter?, max_age?): Observable<FeatureCollection>

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

Parameters

Name Type Description
projection [geosearch, Search] | [tiledgeosearch, TiledSearch] | [geohashgeoaggregate, GeohashAggregation] | [geotilegeoaggregate, GeoTileAggregation] | [geoaggregate, Aggregation[]] Type of projection of ARLAS Server request:Geosearch or Geoaggregate.
collaborations Map<string, Collaboration> -
collection any -
isFlat? boolean Boolean option to isFlat output geojson properties.
contributorId? string Identifier contributor to resolve the request without the collaboration of this contributor.
filter? Filter ARLAS API filter to resolve the request with this filter in addition.
max_age? number Duration of browser cache.

Returns

Observable<FeatureCollection>

ARLAS Server observable.

Inherited from

CollaborativesearchService.resolveButNotFeatureCollection

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:189

resolveButNotFeatureCollectionWithAbort

▸ resolveButNotFeatureCollectionWithAbort(projection, collaborations, collection, isFlat, abortableSignal, contributorId?, filter?, max_age?): Observable<FeatureCollection>

Parameters

Name Type
projection [geosearch, Search] | [tiledgeosearch, TiledSearch] | [geohashgeoaggregate, GeohashAggregation] | [geotilegeoaggregate, GeoTileAggregation] | [geoaggregate, Aggregation[]]
collaborations Map<string, Collaboration>
collection any
isFlat boolean
abortableSignal any
contributorId? string
filter? Filter
max_age? number

Returns

Observable<FeatureCollection>

Inherited from

CollaborativesearchService.resolveButNotFeatureCollectionWithAbort

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:197

resolveButNotHits

▸ resolveButNotHits(projection, collaborations, collection, contributorId?, filter?, isFlat?, max_age?): Observable<Hits>

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

Parameters

Name Type Description
projection [search, Search] | [count, Count] Type of projection of ARLAS Server request:Search or Count.
collaborations Map<string, Collaboration> -
collection any -
contributorId? string Identifier contributor to resolve the request without the collaboration of this contributor.
filter? Filter ARLAS API filter to resolve the request with this filter in addition.
isFlat? boolean Whether flatten json.
max_age? number Duration of browser cache.

Returns

Observable<Hits>

ARLAS Server observable.

Inherited from

CollaborativesearchService.resolveButNotHits

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:150

resolveButNotShapefile

▸ resolveButNotShapefile(projection, collaborations, collection, isFlat?, contributorId?, filter?, max_age?): Observable<ArrayBuffer>

Parameters

Name Type
projection [shapeaggregate, Aggregation[]] | [shapesearch, Search]
collaborations Map<string, Collaboration>
collection any
isFlat? boolean
contributorId? string
filter? Filter
max_age? number

Returns

Observable<ArrayBuffer>

Inherited from

CollaborativesearchService.resolveButNotShapefile

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:193

resolveComputeHits

▸ resolveComputeHits(projection, filters, collection, isFlat?, max_age?): Observable<Hits>

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

Parameters

Name Type Description
projection [search, Search] | [count, Count] Type of projection of ARLAS Server request :Search or Count .
filters Filter[] ARLAS API filters to resolve the request with compute
collection any -
isFlat? boolean Whether flatten json.
max_age? number Duration of browser cache.

Returns

Observable<Hits>

ARLAS Server observable.

Inherited from

CollaborativesearchService.resolveComputeHits

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:175

resolveFeatureCollection

▸ resolveFeatureCollection(projection, isFlat, collaborations, collection, contributorId?, filter?, max_age?): Observable<FeatureCollection>

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

Parameters

Name Type Description
projection [geosearch, Search] | [tiledgeosearch, TiledSearch] | [geohashgeoaggregate, GeohashAggregation] | [geotilegeoaggregate, GeoTileAggregation] | [geoaggregate, Aggregation[]] Type of projection of ARLAS Server request :Geosearch or Geoaggregate.
isFlat boolean Boolean option to flat output geojson properties.
collaborations Map<string, Collaboration> -
collection any -
contributorId? string Identifier contributor to resolve the request with the collaboration of this contributor.
filter? Filter ARLAS API filter to resolve the request with this filter in addition.
max_age? number Duration of browser cache.

Returns

Observable<FeatureCollection>

ARLAS Server observable.

Inherited from

CollaborativesearchService.resolveFeatureCollection

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:211

resolveHits

▸ resolveHits(projection, collaborations, collection, contributorId?, filter?, isFlat?, max_age?): Observable<Hits>

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

Parameters

Name Type Description
projection [search, Search] | [count, Count] Type of projection of ARLAS Server request :Search or Count .
collaborations Map<string, Collaboration> -
collection any -
contributorId? string Identifier contributor to resolve the request with the collaboration of this contributor.
filter? Filter ARLAS API filter to resolve the request with this filter in addition.
isFlat? boolean Whether flatten json.
max_age? number Duration of browser cache.

Returns

Observable<Hits>

ARLAS Server observable.

Inherited from

CollaborativesearchService.resolveHits

Defined in

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

setCollaborations

▸ setCollaborations(dataModel): void

Initialise all the contributors collaborations from dataModel.

Parameters

Name Type
dataModel Object

Returns

void

Inherited from

CollaborativesearchService.setCollaborations

Defined in

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

setConfigService

▸ setConfigService(configService): void

Set the Configuraion Service.

Parameters

Name Type Description
configService ConfigService ConfigService.

Returns

void

Inherited from

CollaborativesearchService.setConfigService

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:98

setCountAll

▸ setCountAll(collaborations): void

Update countAll property.

Parameters

Name Type
collaborations Map<string, Collaboration>

Returns

void

Inherited from

CollaborativesearchService.setCountAll

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:288

setExploreApi

▸ setExploreApi(exploreApi): void

Set the ARLAS Explore API.

Parameters

Name Type
exploreApi ExploreApi

Returns

void

Inherited from

CollaborativesearchService.setExploreApi

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:88

setFetchOptions

▸ setFetchOptions(fetchOptions): void

Set the fetch options.

Parameters

Name Type Description
fetchOptions any : Object.

Returns

void

Inherited from

CollaborativesearchService.setFetchOptions

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:78

setFilter

▸ setFilter(contributorId, collaboration): void

Adds the contributor's collaboration in the registry of collaborations. Notifies the collaborationBus of the changement. If the given contributor is linked to another one, the linked contributor will be assigned the same collaboration. The collaborationBus in this case doesn't need to be notified.

Parameters

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

Returns

void

Inherited from

CollaborativesearchService.setFilter

Defined in

node_modules/arlas-web-core/services/collaborativesearch.service.d.ts:114

urlBuilder

▸ urlBuilder(): string

Returns

string

Inherited from

CollaborativesearchService.urlBuilder

Defined in

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