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:89

Returns: ArlasCollaborativesearchService


Properties

collaborationBus

● collaborationBus: Subject<CollaborationEvent>

Inherited from CollaborativesearchService.collaborationBus

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


collaborationErrorBus

● collaborationErrorBus: Subject<Error>

Inherited from CollaborativesearchService.collaborationErrorBus

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


collaborations

● collaborations: Map<string, Collaboration>

Inherited from CollaborativesearchService.collaborations

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


collections

● collections: Set<string>

Inherited from CollaborativesearchService.collections

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


contribFilterBus

● contribFilterBus: Subject<Contributor>

Inherited from CollaborativesearchService.contribFilterBus

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


countAll

● countAll: Observable<CollectionCount[]>

Inherited from CollaborativesearchService.countAll

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


defaultCollection

● defaultCollection: string

Inherited from CollaborativesearchService.defaultCollection

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


max_age

● max_age: number

Inherited from CollaborativesearchService.max_age

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


ongoingSubscribe

● ongoingSubscribe: Subject<number>

Inherited from CollaborativesearchService.ongoingSubscribe

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


registry

● registry: Map<string, Contributor>

Inherited from CollaborativesearchService.registry

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


totalSubscribe

● totalSubscribe: number

Inherited from CollaborativesearchService.totalSubscribe

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


Methods

dataModelBuilder

dataModelBuilder(filter: string): Object

Inherited from CollaborativesearchService.dataModelBuilder

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

Parameters:

Name Type
filter string

Returns: Object


describe

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

Inherited from CollaborativesearchService.describe

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

Parameters:

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

Returns: Observable<CollectionReferenceDescription>


disable

disable(contributorId: string): void

Inherited from CollaborativesearchService.disable

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

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:226

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:235

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:135

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:93

Returns: ConfigService ConfigService.


getDisableContributors

getDisableContributors(): Array<string>

Inherited from CollaborativesearchService.getDisableContributors

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

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:240

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:83

Returns: ExploreApi ExploreApi.


getFetchOptions

getFetchOptions(): object

Inherited from CollaborativesearchService.getFetchOptions

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

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:260

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

Inherited from CollaborativesearchService.getUrl

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

Parameters:

Name Type
projection [geoaggregate
filters Array<Filter>
Optional max_age number

Returns: string Url encoded string


isEnable

isEnable(contributorId: string): boolean

Inherited from CollaborativesearchService.isEnable

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

Parameters:

Name Type
contributorId string

Returns: boolean Contributor collaboration enabled properties.


list

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

Inherited from CollaborativesearchService.list

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

Parameters:

Name Type Description
Optional pretty boolean Whether pretty print or not

Returns: Observable<Array<CollectionReferenceDescription>>


register

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

Inherited from CollaborativesearchService.register

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

Parameters:

Name Type
identifier string
contributor Contributor

Returns: void


registerCollections

registerCollections(contributor: Contributor): void

Inherited from CollaborativesearchService.registerCollections

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

Parameters:

Name Type
contributor Contributor

Returns: void


removeAll

removeAll(): void

Inherited from CollaborativesearchService.removeAll

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

Returns: void


removeFilter

removeFilter(contributorId: string): void

Inherited from CollaborativesearchService.removeFilter

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

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>

Inherited from CollaborativesearchService.resolveAggregation

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

Parameters:

Name Type 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.
Optional max_age number 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>

Inherited from CollaborativesearchService.resolveButNotAggregation

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

Parameters:

Name Type 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.
Optional max_age number 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>

Inherited from CollaborativesearchService.resolveButNotComputation

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

Parameters:

Name Type 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.
Optional max_age number 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>

Inherited from CollaborativesearchService.resolveButNotFeatureCollection

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

Parameters:

Name Type Description
projection [geosearch, Search] [tiledgeosearch, TiledSearch]
collaborations Map<string, Collaboration>
collection any
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.
Optional max_age number 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>

Inherited from CollaborativesearchService.resolveButNotFeatureCollectionWithAbort

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

Parameters:

Name Type
projection [geosearch, Search]
collaborations Map<string, Collaboration>
collection any
isFlat boolean
abortableSignal any
Optional contributorId string
Optional filter Filter
Optional max_age number

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>

Inherited from CollaborativesearchService.resolveButNotHits

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

Parameters:

Name Type 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.
Optional max_age number 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>

Inherited from CollaborativesearchService.resolveButNotShapefile

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

Parameters:

Name Type
projection [shapeaggregate, Array<Aggregation>]
collaborations Map<string, Collaboration>
collection any
Optional isFlat boolean
Optional contributorId string
Optional filter Filter
Optional max_age number

Returns: Observable<ArrayBuffer>


resolveComputeHits

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

Inherited from CollaborativesearchService.resolveComputeHits

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

Parameters:

Name Type 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.
Optional max_age number 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>

Inherited from CollaborativesearchService.resolveFeatureCollection

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

Parameters:

Name Type Description
projection [geosearch, Search] [tiledgeosearch, TiledSearch]
isFlat boolean 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.
Optional max_age number 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>

Inherited from CollaborativesearchService.resolveHits

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

Parameters:

Name Type 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.
Optional max_age number Duration of browser cache.

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:129

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:98

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:254

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:88

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:78

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:112

Parameters:

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

Returns: void


urlBuilder

urlBuilder(): string

Inherited from CollaborativesearchService.urlBuilder

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

Returns: string