Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class PlaceHolderFieldMapper.PlaceHolderFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.PlaceHolderFieldMapper.PlaceHolderFieldType

Enclosing class:

PlaceHolderFieldMapper

public static final class PlaceHolderFieldMapper.PlaceHolderFieldType
extends MappedFieldType

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.MappedFieldType

MappedFieldType.BlockLoaderContext, MappedFieldType.CollapseType, MappedFieldType.FielddataOperation, MappedFieldType.FieldExtractPreference, MappedFieldType.Relation

Constructor Summary

Constructors

Constructor	Description
PlaceHolderFieldType(String name, String type, Map<String,String> meta)

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.search.Query	distanceFeatureQuery(Object origin, String pivot, SearchExecutionContext context)
IndexFieldData.Builder	fielddataBuilder(FieldDataContext fieldDataContext)	Return a fielddata builder for this field
org.apache.lucene.queries.intervals.IntervalsSource	fuzzyIntervals(String term, int maxDistance, int prefixLength, boolean transpositions, SearchExecutionContext context)	Create a fuzzy IntervalsSource for the given term.
org.apache.lucene.search.Query	fuzzyQuery(Object value, Fuzziness fuzziness, int prefixLength, int maxExpansions, boolean transpositions, SearchExecutionContext context, org.apache.lucene.search.MultiTermQuery.RewriteMethod rewriteMethod)
org.apache.lucene.search.Query	multiPhraseQuery(org.apache.lucene.analysis.TokenStream stream, int slop, boolean enablePositionIncrements, SearchExecutionContext context)
org.apache.lucene.search.Query	normalizedWildcardQuery(String value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, SearchExecutionContext context)
org.apache.lucene.search.Query	phrasePrefixQuery(org.apache.lucene.analysis.TokenStream stream, int slop, int maxExpansions, SearchExecutionContext context)
org.apache.lucene.search.Query	phraseQuery(org.apache.lucene.analysis.TokenStream stream, int slop, boolean enablePositionIncrements, SearchExecutionContext context)
org.apache.lucene.queries.intervals.IntervalsSource	prefixIntervals(org.apache.lucene.util.BytesRef prefix, SearchExecutionContext context)	Create an IntervalsSource for the given prefix.
org.apache.lucene.search.Query	prefixQuery(String value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, boolean caseInsensitve, SearchExecutionContext context)
org.apache.lucene.search.Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, ShapeRelation relation, ZoneId timeZone, DateMathParser parser, SearchExecutionContext context)	Factory method for range queries.
org.apache.lucene.search.Query	regexpQuery(String value, int syntaxFlags, int matchFlags, int maxDeterminizedStates, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, SearchExecutionContext context)
org.apache.lucene.queries.spans.SpanQuery	spanPrefixQuery(String value, org.apache.lucene.queries.spans.SpanMultiTermQueryWrapper.SpanRewriteMethod method, SearchExecutionContext context)
org.apache.lucene.queries.intervals.IntervalsSource	termIntervals(org.apache.lucene.util.BytesRef term, SearchExecutionContext context)	Create an IntervalsSource for the given term.
org.apache.lucene.search.Query	termQuery(Object value, SearchExecutionContext context)	Generates a query that will only match documents that contain the given value.
org.apache.lucene.search.Query	termQueryCaseInsensitive(Object value, SearchExecutionContext context)
String	typeName()	Returns the name of this type, as would be specified in mapping properties
ValueFetcher	valueFetcher(SearchExecutionContext context, String format)	Create a helper class to fetch field values during the FetchFieldsPhase.
org.apache.lucene.queries.intervals.IntervalsSource	wildcardIntervals(org.apache.lucene.util.BytesRef pattern, SearchExecutionContext context)	Create a wildcard IntervalsSource for the given pattern.
org.apache.lucene.search.Query	wildcardQuery(String value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, boolean caseInsensitve, SearchExecutionContext context)

Methods inherited from class org.elasticsearch.index.mapper.MappedFieldType

blockLoader, checkNoFormat, checkNoTimeZone, collapseType, dimensions, docValueFormat, eagerGlobalOrdinals, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, failIfNotIndexedNorDocValuesFallback, familyTypeName, fieldHasValue, fuzzyQuery, getMetricType, getTerms, getTextSearchInfo, hasDocValues, isAggregatable, isDimension, isFieldWithinQuery, isIndexed, isSearchable, isStored, mayExistInIndex, meta, name, pointReaderIfPossible, prefixQuery, termsQuery, validateMatchedRoutingPath, valueForDisplay, wildcardQuery

Methods inherited from class java.lang.Object

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

Constructor Details

PlaceHolderFieldType

public PlaceHolderFieldType(String name,
 String type,
 Map<String,String> meta)

Method Details

valueFetcher

public ValueFetcher valueFetcher(SearchExecutionContext context,
 String format)

Description copied from class: MappedFieldType

Create a helper class to fetch field values during the FetchFieldsPhase. New field types must implement this method in order to support the search 'fields' option. Except for metadata fields, field types should not throw UnsupportedOperationException since this could cause a search retrieving multiple fields (like "fields": ["*"]) to fail.

Specified by:

valueFetcher in class MappedFieldType

typeName

public String typeName()

Description copied from class: MappedFieldType

Returns the name of this type, as would be specified in mapping properties

Specified by:

typeName in class MappedFieldType

termQuery

public org.apache.lucene.search.Query termQuery(Object value,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Generates a query that will only match documents that contain the given value. The default implementation returns a TermQuery over the value bytes

Specified by:

termQuery in class MappedFieldType

termQueryCaseInsensitive

public org.apache.lucene.search.Query termQueryCaseInsensitive(Object value,
 @Nullable
 SearchExecutionContext context)

Overrides:

termQueryCaseInsensitive in class MappedFieldType

rangeQuery

public org.apache.lucene.search.Query rangeQuery(Object lowerTerm,
 Object upperTerm,
 boolean includeLower,
 boolean includeUpper,
 ShapeRelation relation,
 ZoneId timeZone,
 DateMathParser parser,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Factory method for range queries.

Overrides:

rangeQuery in class MappedFieldType

relation - the relation, nulls should be interpreted like INTERSECTS

fuzzyQuery

public org.apache.lucene.search.Query fuzzyQuery(Object value,
 Fuzziness fuzziness,
 int prefixLength,
 int maxExpansions,
 boolean transpositions,
 SearchExecutionContext context,
 @Nullable
 org.apache.lucene.search.MultiTermQuery.RewriteMethod rewriteMethod)

Overrides:

fuzzyQuery in class MappedFieldType

prefixQuery

public org.apache.lucene.search.Query prefixQuery(String value,
 @Nullable
 org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
 boolean caseInsensitve,
 SearchExecutionContext context)

Overrides:

prefixQuery in class MappedFieldType

wildcardQuery

public org.apache.lucene.search.Query wildcardQuery(String value,
 @Nullable
 org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
 boolean caseInsensitve,
 SearchExecutionContext context)

Overrides:

wildcardQuery in class MappedFieldType

normalizedWildcardQuery

public org.apache.lucene.search.Query normalizedWildcardQuery(String value,
 @Nullable
 org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
 SearchExecutionContext context)

Overrides:

normalizedWildcardQuery in class MappedFieldType

regexpQuery

public org.apache.lucene.search.Query regexpQuery(String value,
 int syntaxFlags,
 int matchFlags,
 int maxDeterminizedStates,
 @Nullable
 org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
 SearchExecutionContext context)

Overrides:

regexpQuery in class MappedFieldType

phraseQuery

public org.apache.lucene.search.Query phraseQuery(org.apache.lucene.analysis.TokenStream stream,
 int slop,
 boolean enablePositionIncrements,
 SearchExecutionContext context)

Overrides:

phraseQuery in class MappedFieldType

multiPhraseQuery

public org.apache.lucene.search.Query multiPhraseQuery(org.apache.lucene.analysis.TokenStream stream,
 int slop,
 boolean enablePositionIncrements,
 SearchExecutionContext context)

Overrides:

multiPhraseQuery in class MappedFieldType

phrasePrefixQuery

public org.apache.lucene.search.Query phrasePrefixQuery(org.apache.lucene.analysis.TokenStream stream,
 int slop,
 int maxExpansions,
 SearchExecutionContext context)
                                                 throws IOException

Overrides:

phrasePrefixQuery in class MappedFieldType

Throws:

IOException

spanPrefixQuery

public org.apache.lucene.queries.spans.SpanQuery spanPrefixQuery(String value,
 org.apache.lucene.queries.spans.SpanMultiTermQueryWrapper.SpanRewriteMethod method,
 SearchExecutionContext context)

Overrides:

spanPrefixQuery in class MappedFieldType

distanceFeatureQuery

public org.apache.lucene.search.Query distanceFeatureQuery(Object origin,
 String pivot,
 SearchExecutionContext context)

Overrides:

distanceFeatureQuery in class MappedFieldType

termIntervals

public org.apache.lucene.queries.intervals.IntervalsSource termIntervals(org.apache.lucene.util.BytesRef term,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Create an IntervalsSource for the given term.

Overrides:

termIntervals in class MappedFieldType

prefixIntervals

public org.apache.lucene.queries.intervals.IntervalsSource prefixIntervals(org.apache.lucene.util.BytesRef prefix,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Create an IntervalsSource for the given prefix.

Overrides:

prefixIntervals in class MappedFieldType

fuzzyIntervals

public org.apache.lucene.queries.intervals.IntervalsSource fuzzyIntervals(String term,
 int maxDistance,
 int prefixLength,
 boolean transpositions,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Create a fuzzy IntervalsSource for the given term.

Overrides:

fuzzyIntervals in class MappedFieldType

wildcardIntervals

public org.apache.lucene.queries.intervals.IntervalsSource wildcardIntervals(org.apache.lucene.util.BytesRef pattern,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Create a wildcard IntervalsSource for the given pattern.

Overrides:

wildcardIntervals in class MappedFieldType

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder(FieldDataContext fieldDataContext)

Description copied from class: MappedFieldType

Return a fielddata builder for this field

Overrides:

fielddataBuilder in class MappedFieldType

Parameters:

fieldDataContext - the context for the fielddata