public class TextField extends FieldType
TextField
is the basic type for configurable text analysis.
Analyzers for field types using this implementation should be defined in the schema.FieldType.DefaultAnalyzer
Modifier and Type | Field and Description |
---|---|
protected boolean |
autoGeneratePhraseQueries |
protected Analyzer |
multiTermAnalyzer
Analyzer set by schema for text types to use when searching fields
of this type, subclasses can set analyzer themselves or override
getIndexAnalyzer()
This analyzer is used to process wildcard, prefix, regex and other multiterm queries.
|
ANALYZER, args, CHAR_FILTER, CHAR_FILTERS, CLASS_NAME, docValuesFormat, falseProperties, FILTER, FILTERS, INDEX, INDEX_ANALYZER, log, MULTI_TERM, MULTI_TERM_ANALYZER, POLY_FIELD_SEPARATOR, postingsFormat, properties, QUERY, QUERY_ANALYZER, similarity, SIMILARITY, similarityFactory, TOKENIZER, trueProperties, TYPE, TYPE_NAME, typeName
BINARY, DOC_VALUES, INDEXED, MULTIVALUED, OMIT_NORMS, OMIT_POSITIONS, OMIT_TF_POSITIONS, REQUIRED, SORT_MISSING_FIRST, SORT_MISSING_LAST, STORE_OFFSETS, STORE_TERMOFFSETS, STORE_TERMPOSITIONS, STORE_TERMVECTORS, STORED, TOKENIZED
Constructor and Description |
---|
TextField() |
Modifier and Type | Method and Description |
---|---|
static BytesRef |
analyzeMultiTerm(String field,
String part,
Analyzer analyzerIn) |
boolean |
getAutoGeneratePhraseQueries() |
Query |
getFieldQuery(QParser parser,
SchemaField field,
String externalVal)
Returns a Query instance for doing searches against a field.
|
Analyzer |
getMultiTermAnalyzer()
Returns the Analyzer to be used when searching fields of this type when mult-term queries are specified.
|
Query |
getRangeQuery(QParser parser,
SchemaField field,
String part1,
String part2,
boolean minInclusive,
boolean maxInclusive)
Returns a Query instance for doing range searches on this field type.
|
SortField |
getSortField(SchemaField field,
boolean reverse)
Returns the SortField instance that should be used to sort fields
of this type.
|
protected void |
init(IndexSchema schema,
Map<String,String> args)
subclasses should initialize themselves with the args provided
and remove valid arguments.
|
boolean |
isExplicitMultiTermAnalyzer() |
Object |
marshalSortValue(Object value)
Convert a value used by the FieldComparator for this FieldType's SortField
into a marshalable value for distributed sorting.
|
void |
setIsExplicitMultiTermAnalyzer(boolean isExplicitMultiTermAnalyzer) |
void |
setMultiTermAnalyzer(Analyzer analyzer) |
protected boolean |
supportsAnalyzers()
Returns true if this type supports index and query analyzers, false otherwise.
|
Object |
toObject(SchemaField sf,
BytesRef term) |
Object |
unmarshalSortValue(Object value)
Convert a value marshaled via
FieldType.marshalSortValue(java.lang.Object) back
into a value usable by the FieldComparator for this FieldType's SortField |
void |
write(TextResponseWriter writer,
String name,
IndexableField f)
calls back to TextResponseWriter to write the field value
|
checkSchemaField, createField, createField, createFields, getAnalyzer, getAnalyzerProperties, getClassArg, getDocValuesFormat, getIndexAnalyzer, getIndexOptions, getNamedPropertyValues, getNonFieldPropertyArgs, getNumericType, getPostingsFormat, getPrefixQuery, getQueryAnalyzer, getRewriteMethod, getSimilarity, getSimilarityFactory, getStringSort, getTypeName, getValueSource, hasProperty, indexedToReadable, indexedToReadable, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isPolyField, isTokenized, marshalBase64SortValue, marshalStringSortValue, multiValuedFieldCache, readableToIndexed, readableToIndexed, restrictProps, setAnalyzer, setArgs, setIndexAnalyzer, setIsExplicitAnalyzer, setIsExplicitQueryAnalyzer, setQueryAnalyzer, setSimilarity, storedToIndexed, storedToReadable, toExternal, toInternal, toObject, toString, unmarshalBase64SortValue, unmarshalStringSortValue
protected boolean autoGeneratePhraseQueries
protected Analyzer multiTermAnalyzer
protected void init(IndexSchema schema, Map<String,String> args)
FieldType
public Analyzer getMultiTermAnalyzer()
This method may be called many times, at any time.
FieldType.getIndexAnalyzer()
public void setMultiTermAnalyzer(Analyzer analyzer)
public boolean getAutoGeneratePhraseQueries()
public SortField getSortField(SchemaField field, boolean reverse)
FieldType
getSortField
in class FieldType
SchemaField.checkSortability()
public void write(TextResponseWriter writer, String name, IndexableField f) throws IOException
FieldType
write
in class FieldType
IOException
public Query getFieldQuery(QParser parser, SchemaField field, String externalVal)
FieldType
getFieldQuery
in class FieldType
parser
- The QParser
calling the methodfield
- The SchemaField
of the field to searchexternalVal
- The String representation of the value to searchQuery
instance. This implementation returns a TermQuery
but overriding queries may notpublic Object toObject(SchemaField sf, BytesRef term)
protected boolean supportsAnalyzers()
FieldType
supportsAnalyzers
in class FieldType
public Query getRangeQuery(QParser parser, SchemaField field, String part1, String part2, boolean minInclusive, boolean maxInclusive)
FieldType
SolrQueryParser
currently passes part1 and part2 as null if they are '*' respectively. minInclusive and maxInclusive are both true
currently by SolrQueryParser but that may change in the future. Also, other QueryParser implementations may have
different semantics.
Sub-classes should override this method to provide their own range query implementation. They should strive to
handle nulls in part1 and/or part2 as well as unequal minInclusive and maxInclusive parameters gracefully.getRangeQuery
in class FieldType
parser
- the QParser
calling the methodfield
- the schema fieldpart1
- the lower boundary of the range, nulls are allowed.part2
- the upper boundary of the range, nulls are allowedminInclusive
- whether the minimum of the range is inclusive or notmaxInclusive
- whether the maximum of the range is inclusive or notpublic static BytesRef analyzeMultiTerm(String field, String part, Analyzer analyzerIn)
public void setIsExplicitMultiTermAnalyzer(boolean isExplicitMultiTermAnalyzer)
public boolean isExplicitMultiTermAnalyzer()
public Object marshalSortValue(Object value)
FieldType
marshalSortValue
in class FieldType
public Object unmarshalSortValue(Object value)
FieldType
FieldType.marshalSortValue(java.lang.Object)
back
into a value usable by the FieldComparator for this FieldType's SortFieldunmarshalSortValue
in class FieldType
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.