Package org.opensearch.geo

Class GeoModulePlugin

java.lang.Object

org.opensearch.plugins.Plugin

org.opensearch.geo.GeoModulePlugin

All Implemented Interfaces:

Closeable, AutoCloseable, MapperPlugin, SearchPlugin

public class GeoModulePlugin
extends Plugin
implements MapperPlugin, SearchPlugin

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.plugins.SearchPlugin

SearchPlugin.AggregationSpec, SearchPlugin.CompositeAggregationSpec, SearchPlugin.ExecutorServiceProvider, SearchPlugin.FetchPhaseConstructionContext, SearchPlugin.PipelineAggregationSpec, SearchPlugin.QuerySpec<T extends QueryBuilder>, SearchPlugin.RescorerSpec<T extends RescorerBuilder<T>>, SearchPlugin.ScoreFunctionSpec<T extends ScoreFunctionBuilder<T>>, SearchPlugin.SearchExtensionSpec<W extends org.opensearch.core.common.io.stream.NamedWriteable,P>, SearchPlugin.SearchExtSpec<T extends SearchExtBuilder>, SearchPlugin.SignificanceHeuristicSpec<T extends SignificanceHeuristic>, SearchPlugin.SortSpec<T extends SortBuilder<T>>, SearchPlugin.SuggesterSpec<T extends SuggestionBuilder<T>>

Field Summary

Fields inherited from interface org.opensearch.plugins.MapperPlugin

NOOP_FIELD_FILTER, NOOP_FIELD_PREDICATE

Constructor Summary

Constructors

Constructor	Description
GeoModulePlugin()

Method Summary

Modifier and Type	Method	Description
List<SearchPlugin.AggregationSpec>	getAggregations()	Registering GeoBounds, InternalGeoHashGrid, InternalGeoTileGrid aggregation on GeoPoint and GeoShape fields.
List<SearchPlugin.CompositeAggregationSpec>	getCompositeAggregations()	Registering the GeoTileGridAggregator in the CompositeAggregation.
Map<String,Mapper.TypeParser>	getMappers()

Methods inherited from class org.opensearch.plugins.Plugin

additionalSettings, close, createComponents, createGuiceModules, getAdditionalIndexSettingProviders, getBootstrapChecks, getExecutorBuilders, getFeature, getGuiceServiceClasses, getIndexTemplateMetadataUpgrader, getNamedWriteables, getNamedXContent, getRoles, getSecureSettingFactory, getSettings, getSettingsFilter, getSettingUpgraders, onIndexModule

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.plugins.MapperPlugin

getFieldFilter, getMetadataMappers

Methods inherited from interface org.opensearch.plugins.SearchPlugin

getAggregationExtentions, getFetchSubPhases, getHighlighters, getIndexSearcherExecutorProvider, getMovingAverageModels, getPipelineAggregations, getQueries, getQueryPhaseSearcher, getRescorers, getScoreFunctions, getSearchExts, getSignificanceHeuristics, getSorts, getSuggesters

Constructor Details

GeoModulePlugin

public GeoModulePlugin()

Method Details

getMappers

public Map<String,Mapper.TypeParser> getMappers()

Specified by:

getMappers in interface MapperPlugin

getAggregations

public List<SearchPlugin.AggregationSpec> getAggregations()

Registering GeoBounds, InternalGeoHashGrid, InternalGeoTileGrid aggregation on GeoPoint and GeoShape fields.

Specified by:

getAggregations in interface SearchPlugin

getCompositeAggregations

public List<SearchPlugin.CompositeAggregationSpec> getCompositeAggregations()

Registering the GeoTileGridAggregator in the CompositeAggregation.

Specified by:

getCompositeAggregations in interface SearchPlugin

Returns:

a List of SearchPlugin.CompositeAggregationSpec