arlas-web-core > "services/collaborativesearch.service" > CollaborativesearchService

Class: CollaborativesearchService

Hierarchy

CollaborativesearchService

Index

Constructors

Properties

Methods


Constructors

constructor

new CollaborativesearchService(): CollaborativesearchService

Defined in services/collaborativesearch.service.ts:97

Returns: CollaborativesearchService


Properties

collaborationBus

● collaborationBus: Subject<CollaborationEvent> = new Subject()

Defined in services/collaborativesearch.service.ts:36


collaborationErrorBus

● collaborationErrorBus: Subject<Error> = new Subject()

Defined in services/collaborativesearch.service.ts:77


collaborations

● collaborations: Map<string, Collaboration> = new Map()

Defined in services/collaborativesearch.service.ts:45


collections

● collections: Set<string> = new Set()

Defined in services/collaborativesearch.service.ts:57


contribFilterBus

● contribFilterBus: Subject<Contributor> = new Subject()

Defined in services/collaborativesearch.service.ts:41


countAll

● countAll: Observable<CollectionCount[]>

Defined in services/collaborativesearch.service.ts:65


defaultCollection

● defaultCollection: string

Defined in services/collaborativesearch.service.ts:53


max_age

● max_age: number = 60

Defined in services/collaborativesearch.service.ts:61


ongoingSubscribe

● ongoingSubscribe: Subject<number> = new Subject()

Defined in services/collaborativesearch.service.ts:69


registry

● registry: Map<string, Contributor> = new Map()

Defined in services/collaborativesearch.service.ts:49


totalSubscribe

● totalSubscribe: number = 0

Defined in services/collaborativesearch.service.ts:73


Methods

dataModelBuilder

dataModelBuilder(filter: string): Object

Defined in services/collaborativesearch.service.ts:225

Parameters:

Name Type
filter string

Returns: Object


describe

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

Defined in services/collaborativesearch.service.ts:605

Parameters:

Name Type Default value Description
collection string - collection name
Optional pretty boolean - Whether pretty print or not
Default value max_age number this.max_age Duration of browser cache.s

Returns: Observable<CollectionReferenceDescription>


disable

disable(contributorId: string): void

Defined in services/collaborativesearch.service.ts:460

Parameters:

Name Type
contributorId string

Returns: void


enable

enable(contributorId: string): void

Defined in services/collaborativesearch.service.ts:454

Parameters:

Name Type
contributorId string

Returns: void


getAllContributors

getAllContributors(): Array<string>

Defined in services/collaborativesearch.service.ts:467

Returns: Array<string> List of contributor idenfiers.


getCollaboration

getCollaboration(contributorId: string): Collaboration

Defined in services/collaborativesearch.service.ts:284

Parameters:

Name Type Description
contributorId string Identifier of a contributor.

Returns: Collaboration Collaboration.


getConfigService

getConfigService(): ConfigService

Defined in services/collaborativesearch.service.ts:151

Returns: ConfigService ConfigService.


getDisableContributors

getDisableContributors(): Array<string>

Defined in services/collaborativesearch.service.ts:481

Returns: Array<string> List of contributor idenfiers.


getEnableContributors

getEnableContributors(): Array<string>

Defined in services/collaborativesearch.service.ts:474

Returns: Array<string> List of contributor idenfiers.


getExploreApi

getExploreApi(): ExploreApi

Defined in services/collaborativesearch.service.ts:137

Returns: ExploreApi ExploreApi.


getFetchOptions

getFetchOptions(): object

Defined in services/collaborativesearch.service.ts:123

Returns: object Object.


getFinalFilter

getFinalFilter(filters: Array<Filter>): Filter

Defined in services/collaborativesearch.service.ts:558

Parameters:

Name Type
filters Array<Filter>

Returns: Filter


getUrl

getUrl(projection: [geoaggregate | geosearch | aggregate | shapeaggregate | shapesearch | count | geohashgeoaggregate | geotilegeoaggregate | search | tiledgeosearch, Array<Aggregation>], filters: Array<Filter>, max_age?: number): string

Defined in services/collaborativesearch.service.ts:506

Parameters:

Name Type Default value
projection [geoaggregate geosearch
filters Array<Filter> -
Default value max_age number this.max_age

Returns: string Url encoded string


isEnable

isEnable(contributorId: string): boolean

Defined in services/collaborativesearch.service.ts:488

Parameters:

Name Type
contributorId string

Returns: boolean Contributor collaboration enabled properties.


list

list(pretty?: boolean): Observable<Array<CollectionReferenceDescription>>

Defined in services/collaborativesearch.service.ts:616

Parameters:

Name Type Default value Description
Default value pretty boolean false Whether pretty print or not

Returns: Observable<Array<CollectionReferenceDescription>>


register

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

Defined in services/collaborativesearch.service.ts:164

Parameters:

Name Type
identifier string
contributor Contributor

Returns: void


registerCollections

registerCollections(contributor: Contributor): void

Defined in services/collaborativesearch.service.ts:172

Parameters:

Name Type
contributor Contributor

Returns: void


removeAll

removeAll(): void

Defined in services/collaborativesearch.service.ts:215

Returns: void


removeFilter

removeFilter(contributorId: string): void

Defined in services/collaborativesearch.service.ts:203

Parameters:

Name Type Description
contributorId string Sting identifier of contributor.

Returns: void


resolveAggregation

resolveAggregation(projection: [aggregate, Array<Aggregation>], collaborations: Map<string, Collaboration>, collection: any, contributorId?: string, filter?: Filter, isFlat?: boolean, max_age?: number): Observable<AggregationResponse>

Defined in services/collaborativesearch.service.ts:428

Parameters:

Name Type Default value Description
projection [aggregate, Array<Aggregation>] - Type of projection of ARLAS Server request :Aggregation.
collaborations Map<string, Collaboration> -
collection any -
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.
Optional isFlat boolean - Whether flatten json.
Default value max_age number this.max_age Duration of browser cache.

Returns: Observable<AggregationResponse> ARLAS Server observable.


resolveButNotAggregation

resolveButNotAggregation(projection: [aggregate, Array<Aggregation>], collaborations: Map<string, Collaboration>, collection: any, contributorId?: string, filter?: Filter, isFlat?: boolean, max_age?: number): Observable<AggregationResponse>

Defined in services/collaborativesearch.service.ts:413

Parameters:

Name Type Default value Description
projection [aggregate, Array<Aggregation>] - Type of projection of ARLAS Server request:Aggregation.
collaborations Map<string, Collaboration> -
collection any -
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.
Optional isFlat boolean - Whether flatten json.
Default value max_age number this.max_age Duration of browser cache.

Returns: Observable<AggregationResponse> ARLAS Server observable.


resolveButNotComputation

resolveButNotComputation(projection: [compute, ComputationRequest], collaborations: Map<string, Collaboration>, collection: any, contributorId?: string, filter?: Filter, isFlat?: boolean, max_age?: number): Observable<ComputationResponse>

Defined in services/collaborativesearch.service.ts:445

Parameters:

Name Type Default value Description
projection [compute, ComputationRequest] - Type of projection of ARLAS Server request : ComputationRequest.
collaborations Map<string, Collaboration> - Map
collection any -
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.
Optional isFlat boolean - Whether flatten json.
Default value max_age number this.max_age Duration of browser cache.

Returns: Observable<ComputationResponse> ARLAS Server observable.


resolveButNotFeatureCollection

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

Defined in services/collaborativesearch.service.ts:351

Parameters:

Name Type Default value Description
projection [geosearch, Search] [tiledgeosearch, TiledSearch] [geohashgeoaggregate, GeohashAggregation]
collaborations Map<string, Collaboration> -
collection any -
Default value isFlat boolean true 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.
Default value max_age number this.max_age Duration of browser cache.

Returns: Observable<FeatureCollection> ARLAS Server observable.


resolveButNotFeatureCollectionWithAbort

resolveButNotFeatureCollectionWithAbort(projection: [geosearch, Search] | [tiledgeosearch, TiledSearch] | [geohashgeoaggregate, GeohashAggregation] | [geotilegeoaggregate, GeoTileAggregation] | [geoaggregate, Array<Aggregation>], collaborations: Map<string, Collaboration>, collection: any, isFlat?: boolean, abortableSignal: any, contributorId?: string, filter?: Filter, max_age?: number): Observable<FeatureCollection>

Defined in services/collaborativesearch.service.ts:370

Parameters:

Name Type Default value
projection [geosearch, Search] [tiledgeosearch, TiledSearch]
collaborations Map<string, Collaboration> -
collection any -
Default value isFlat boolean true
abortableSignal any -
Optional contributorId string -
Optional filter Filter -
Default value max_age number this.max_age

Returns: Observable<FeatureCollection>


resolveButNotHits

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

Defined in services/collaborativesearch.service.ts:301

Parameters:

Name Type Default value Description
projection [search, Search] [count, Count] -
collaborations Map<string, Collaboration> -
collection any -
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.
Optional isFlat boolean - Whether flatten json.
Default value max_age number this.max_age Duration of browser cache.

Returns: Observable<Hits> ARLAS Server observable.


resolveButNotShapefile

resolveButNotShapefile(projection: [shapeaggregate, Array<Aggregation>] | [shapesearch, Search], collaborations: Map<string, Collaboration>, collection: any, isFlat?: boolean, contributorId?: string, filter?: Filter, max_age?: number): Observable<ArrayBuffer>

Defined in services/collaborativesearch.service.ts:362

Parameters:

Name Type Default value
projection [shapeaggregate, Array<Aggregation>] [shapesearch, Search]
collaborations Map<string, Collaboration> -
collection any -
Default value isFlat boolean true
Optional contributorId string -
Optional filter Filter -
Default value max_age number this.max_age

Returns: Observable<ArrayBuffer>


resolveComputeHits

resolveComputeHits(projection: [search, Search] | [count, Count], filters: Array<Filter>, collection: any, isFlat?: boolean, max_age?: number): Observable<Hits>

Defined in services/collaborativesearch.service.ts:333

Parameters:

Name Type Default value Description
projection [search, Search] [count, Count] -
filters Array<Filter> - ARLAS API filters to resolve the request with compute
collection any -
Optional isFlat boolean - Whether flatten json.
Default value max_age number this.max_age Duration of browser cache.

Returns: Observable<Hits> ARLAS Server observable.


resolveFeatureCollection

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

Defined in services/collaborativesearch.service.ts:393

Parameters:

Name Type Default value Description
projection [geosearch, Search] [tiledgeosearch, TiledSearch] [geohashgeoaggregate, GeohashAggregation]
Default value isFlat boolean true Boolean option to flat output geojson properties.
collaborations Map<string, Collaboration> -
collection any -
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.
Default value max_age number this.max_age Duration of browser cache.

Returns: Observable<FeatureCollection> ARLAS Server observable.


resolveHits

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

Defined in services/collaborativesearch.service.ts:317

Parameters:

Name Type Default value Description
projection [search, Search] [count, Count] -
collaborations Map<string, Collaboration> -
collection any -
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.
Optional isFlat boolean - Whether flatten json.
Default value max_age number this.max_age Duration of browser cache.

Returns: Observable<Hits> ARLAS Server observable.


setCollaborations

setCollaborations(dataModel: Object): void

Defined in services/collaborativesearch.service.ts:263

Parameters:

Name Type Description
dataModel Object

Returns: void


setConfigService

setConfigService(configService: ConfigService): void

Defined in services/collaborativesearch.service.ts:158

Parameters:

Name Type Description
configService ConfigService ConfigService.

Returns: void


setCountAll

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

Defined in services/collaborativesearch.service.ts:494

Parameters:

Name Type
collaborations Map<string, Collaboration>

Returns: void


setExploreApi

setExploreApi(exploreApi: ExploreApi): void

Defined in services/collaborativesearch.service.ts:144

Parameters:

Name Type
exploreApi ExploreApi

Returns: void


setFetchOptions

setFetchOptions(fetchOptions: any): void

Defined in services/collaborativesearch.service.ts:130

Parameters:

Name Type Description
fetchOptions any : Object.

Returns: void


setFilter

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

Defined in services/collaborativesearch.service.ts:188

Parameters:

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

Returns: void


urlBuilder

urlBuilder(): string

Defined in services/collaborativesearch.service.ts:242

Returns: string