Package org.opensearch.search.suggest.completion.context

Class GeoContextMapping

java.lang.Object

org.opensearch.search.suggest.completion.context.ContextMapping<GeoQueryContext>

org.opensearch.search.suggest.completion.context.GeoContextMapping

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment

public class GeoContextMapping
extends ContextMapping<GeoQueryContext>

A ContextMapping that uses a geo location/area as a criteria. The suggestions can be boosted and/or filtered depending on whether it falls within an area, represented by a query geo hash with a specified precision

GeoQueryContext defines the options for constructing a unit of query context for this context type

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoContextMapping.Builder	Builder for geo context mapping

Nested classes/interfaces inherited from class org.opensearch.search.suggest.completion.context.ContextMapping

ContextMapping.InternalQueryContext, ContextMapping.Type

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PRECISION
static final String	FIELD_FIELDNAME
static final String	FIELD_PRECISION

Fields inherited from class org.opensearch.search.suggest.completion.context.ContextMapping

FIELD_NAME, FIELD_TYPE, name, type

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
protected GeoQueryContext	fromXContent(org.opensearch.core.xcontent.XContentParser parser)	Prototype for the query context
String	getFieldName()
int	getPrecision()
int	hashCode()
protected static GeoContextMapping	load(String name, Map<String,Object> config)
Set<String>	parseContext(ParseContext.Document document)	Retrieves a set of context from a document at index-time.
Set<String>	parseContext(ParseContext parseContext, org.opensearch.core.xcontent.XContentParser parser)	Parse a set of CharSequence contexts at index-time.
protected org.opensearch.core.xcontent.XContentBuilder	toInnerXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)	Implementations should add specific configurations that need to be persisted
List<ContextMapping.InternalQueryContext>	toInternalQueryContexts(List<GeoQueryContext> queryContexts)	Parse a list of GeoQueryContext using parser.
void	validateReferences(org.opensearch.Version indexVersionCreated, Function<String,MappedFieldType> fieldResolver)	Checks if the current context is consistent with the rest of the fields.

Methods inherited from class org.opensearch.search.suggest.completion.context.ContextMapping

name, parseQueryContext, toString, toXContent, type

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Field Details

FIELD_PRECISION

public static final String FIELD_PRECISION

See Also:

• Constant Field Values

FIELD_FIELDNAME

public static final String FIELD_FIELDNAME

See Also:

• Constant Field Values

DEFAULT_PRECISION

public static final int DEFAULT_PRECISION

See Also:

• Constant Field Values

Method Details

getFieldName

public String getFieldName()

getPrecision

public int getPrecision()

load

protected static GeoContextMapping load(String name,
 Map<String,Object> config)

toInnerXContent

protected org.opensearch.core.xcontent.XContentBuilder toInnerXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                                throws IOException

Description copied from class: ContextMapping

Implementations should add specific configurations that need to be persisted

Specified by:

toInnerXContent in class ContextMapping<GeoQueryContext>

Throws:

IOException

parseContext

public Set<String> parseContext(ParseContext parseContext,
 org.opensearch.core.xcontent.XContentParser parser)
                         throws IOException,
org.opensearch.OpenSearchParseException

Parse a set of CharSequence contexts at index-time. Acceptable formats:

• Array:

  [<GEO POINT>, ..]

• String/Object/Array:

  "GEO POINT"

see GeoPoint(String) for GEO POINT

Specified by:

parseContext in class ContextMapping<GeoQueryContext>

Throws:

IOException

org.opensearch.OpenSearchParseException

parseContext

public Set<String> parseContext(ParseContext.Document document)

Description copied from class: ContextMapping

Retrieves a set of context from a document at index-time.

Specified by:

parseContext in class ContextMapping<GeoQueryContext>

fromXContent

protected GeoQueryContext fromXContent(org.opensearch.core.xcontent.XContentParser parser)
                                throws IOException

Description copied from class: ContextMapping

Prototype for the query context

Specified by:

fromXContent in class ContextMapping<GeoQueryContext>

Throws:

IOException

toInternalQueryContexts

public List<ContextMapping.InternalQueryContext> toInternalQueryContexts(List<GeoQueryContext> queryContexts)

Parse a list of GeoQueryContext using parser. A QueryContexts accepts one of the following forms:

• Object: GeoQueryContext
• String: GeoQueryContext value with boost=1 precision=PRECISION neighbours=[PRECISION]
• Array:

  [GeoQueryContext, ..]

A GeoQueryContext has one of the following forms:

• Object:

  • GEO POINT

  • {"lat": <double>, "lon": <double>, "precision":
             <int>, "neighbours": <[int, ..]>}

  • {"context": <string>, "boost": <int>, "precision":
             <int>, "neighbours": <[int, ..]>}

  • {"context": <GEO POINT>, "boost": <int>, "precision":
             <int>, "neighbours": <[int, ..]>}

• String:

  GEO POINT

see GeoPoint(String) for GEO POINT

Specified by:

toInternalQueryContexts in class ContextMapping<GeoQueryContext>

validateReferences

public void validateReferences(org.opensearch.Version indexVersionCreated,
 Function<String,MappedFieldType> fieldResolver)

Description copied from class: ContextMapping

Checks if the current context is consistent with the rest of the fields. For example, the GeoContext should check that the field that it points to has the correct type.

Overrides:

validateReferences in class ContextMapping<GeoQueryContext>

equals

public boolean equals(Object o)

Overrides:

equals in class ContextMapping<GeoQueryContext>

hashCode

public int hashCode()

Overrides:

hashCode in class ContextMapping<GeoQueryContext>