public class

FeatureCollectionSearchService

extends Object
java.lang.Object
   ↳ com.carto.search.FeatureCollectionSearchService

Class Overview

A search service for finding features from a specified feature collection.

Summary

Public Constructors
FeatureCollectionSearchService(Projection projection, FeatureCollection featureCollection)
Constructs a FeatureCollectionSearchService for given feature collection.
Public Methods
synchronized void delete()
FeatureCollection findFeatures(SearchRequest request)
Searches for the features specified by search request from the feature collection bound to the service.
FeatureCollection getFeatureCollection()
Returns the feature collection of the search service.
int getMaxResults()
Returns the maximum number of results the search service returns.
Projection getProjection()
Returns the projection of the feature collection of the search service.
void setMaxResults(int maxResults)
Sets the maximum number of results the search service returns.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public FeatureCollectionSearchService (Projection projection, FeatureCollection featureCollection)

Constructs a FeatureCollectionSearchService for given feature collection.

Parameters
projection The projection to use for the feature collection.
featureCollection The feature collection to search from.

Public Methods

public synchronized void delete ()

public FeatureCollection findFeatures (SearchRequest request)

Searches for the features specified by search request from the feature collection bound to the service.

Parameters
request The search request containing search filters.
Returns
  • The resulting feature collection containing features matching the request.

public FeatureCollection getFeatureCollection ()

Returns the feature collection of the search service.

Returns
  • The feature collection of the search service.

public int getMaxResults ()

Returns the maximum number of results the search service returns.

Returns
  • The maximum number of results the search service returns.

public Projection getProjection ()

Returns the projection of the feature collection of the search service.

Returns
  • The projection of the feature collection of the search service.

public void setMaxResults (int maxResults)

Sets the maximum number of results the search service returns.
The default number of results is 1000.

Parameters
maxResults The new maximum number of results the geocoding service returns.