Package org.elasticsearch.index.mapper
Class TextSearchInfo
java.lang.Object
org.elasticsearch.index.mapper.TextSearchInfo
public class TextSearchInfo
extends java.lang.Object
Encapsulates information about how to perform text searches over a field
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TextSearchInfo.TermVector
What sort of term vectors are available -
Field Summary
Fields Modifier and Type Field Description static TextSearchInfo
NONE
Specifies that this field does not support text searching of any kindstatic TextSearchInfo
SIMPLE_MATCH_ONLY
Defines indexing information for fields that support only simple match text queriesstatic TextSearchInfo
SIMPLE_MATCH_WITHOUT_TERMS
Defines indexing information for fields that support simple match text queries without using the terms indexstatic TextSearchInfo
WHITESPACE_MATCH_ONLY
Defines indexing information for fields that index as keywords, but split query input on whitespace to build disjunctions. -
Constructor Summary
Constructors Constructor Description TextSearchInfo(org.apache.lucene.document.FieldType luceneFieldType, SimilarityProvider similarity, NamedAnalyzer searchAnalyzer, NamedAnalyzer searchQuoteAnalyzer)
Create a new TextSearchInfo -
Method Summary
Modifier and Type Method Description NamedAnalyzer
getSearchAnalyzer()
NamedAnalyzer
getSearchQuoteAnalyzer()
SimilarityProvider
getSimilarity()
boolean
hasNorms()
boolean
hasOffsets()
boolean
hasPositions()
boolean
isTokenized()
TextSearchInfo.TermVector
termVectors()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
SIMPLE_MATCH_ONLY
Defines indexing information for fields that support only simple match text queries -
WHITESPACE_MATCH_ONLY
Defines indexing information for fields that index as keywords, but split query input on whitespace to build disjunctions. -
SIMPLE_MATCH_WITHOUT_TERMS
Defines indexing information for fields that support simple match text queries without using the terms index -
NONE
Specifies that this field does not support text searching of any kind
-
-
Constructor Details
-
TextSearchInfo
public TextSearchInfo(org.apache.lucene.document.FieldType luceneFieldType, SimilarityProvider similarity, NamedAnalyzer searchAnalyzer, NamedAnalyzer searchQuoteAnalyzer)Create a new TextSearchInfo- Parameters:
luceneFieldType
- the luceneFieldType
of the field to be searchedsimilarity
- defines which Similarity to use when searching. If set tonull
then the default Similarity will be used.searchAnalyzer
- the search-time analyzer to use. May not benull
searchQuoteAnalyzer
- the search-time analyzer to use for phrase searches. May not benull
-
-
Method Details
-
getSimilarity
-
getSearchAnalyzer
-
getSearchQuoteAnalyzer
-
hasPositions
public boolean hasPositions()- Returns:
- whether or not this field supports positional queries
-
hasOffsets
public boolean hasOffsets()- Returns:
- whether or not this field has indexed offsets for highlighting
-
hasNorms
public boolean hasNorms()- Returns:
- whether or not this field has indexed norms
-
isTokenized
public boolean isTokenized()- Returns:
- whether or not this field is tokenized
-
termVectors
- Returns:
- the type of term vectors available for this field
-