public class CollationField extends FieldType
This field can be created in two ways:
Using a System collator:
Using a Tailored ruleset:
Collator,
Locale,
RuleBasedCollatorFieldType.DefaultAnalyzer, FieldType.MultiValueSelectorANALYZER, args, AUTO_GENERATE_PHRASE_QUERIES, CHAR_FILTER, CHAR_FILTERS, CLASS_NAME, docValuesFormat, ENABLE_GRAPH_QUERIES, falseProperties, FILTER, FILTERS, INDEX, INDEX_ANALYZER, MULTI_TERM, MULTI_TERM_ANALYZER, POLY_FIELD_SEPARATOR, postingsFormat, properties, QUERY, QUERY_ANALYZER, similarity, SIMILARITY, similarityFactory, SYNONYM_QUERY_STYLE, TOKENIZER, trueProperties, TYPE, TYPE_NAME, typeNameBINARY, DOC_VALUES, INDEXED, LARGE_FIELD, MULTIVALUED, OMIT_NORMS, OMIT_POSITIONS, OMIT_TF_POSITIONS, REQUIRED, SORT_MISSING_FIRST, SORT_MISSING_LAST, STORE_OFFSETS, STORE_TERMOFFSETS, STORE_TERMPAYLOADS, STORE_TERMPOSITIONS, STORE_TERMVECTORS, STORED, TOKENIZED, UNINVERTIBLE, USE_DOCVALUES_AS_STORED| Constructor and Description |
|---|
CollationField() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
checkSupportsDocValues()
Called by
FieldType.checkSchemaField(SchemaField) if the field has docValues. |
List<IndexableField> |
createFields(SchemaField field,
Object value)
Given a
SchemaField, create one or more IndexableField instances |
Analyzer |
getIndexAnalyzer()
Returns the Analyzer to be used when indexing fields of this type.
|
Analyzer |
getQueryAnalyzer()
Returns the Analyzer to be used when searching fields of this type.
|
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 top)
Returns the SortField instance that should be used to sort fields
of this type.
|
UninvertingReader.Type |
getUninversionType(SchemaField sf)
If DocValues is not enabled for a field, but it's indexed, docvalues can be constructed
on the fly (uninverted, aka fieldcache) on the first request to sort, facet, etc.
|
protected void |
init(IndexSchema schema,
Map<String,String> args)
subclasses should initialize themselves with the args provided
and remove valid arguments.
|
Object |
marshalSortValue(Object value)
Convert a value used by the FieldComparator for this FieldType's SortField
into a marshalable value for distributed sorting.
|
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, getAnalyzerProperties, getClassArg, getDefaultMultiValueSelectorForSort, getDocValuesFormat, getFieldQuery, getNamedPropertyValues, getNonFieldPropertyArgs, getNumberType, getNumericSort, getPostingsFormat, getPrefixQuery, getRewriteMethod, getSetQuery, getSimilarity, getSimilarityFactory, getSingleValueSource, getSortedNumericSortField, getSortedSetSortField, getSortField, getStringSort, getTypeName, getValueSource, hasProperty, indexedToReadable, indexedToReadable, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isPointField, isPolyField, isTokenized, isUtf8Field, marshalBase64SortValue, marshalStringSortValue, multiValuedFieldCache, readableToIndexed, readableToIndexed, restrictProps, setArgs, setIndexAnalyzer, setIsExplicitAnalyzer, setIsExplicitQueryAnalyzer, setQueryAnalyzer, setSimilarity, storedToIndexed, storedToReadable, supportsAnalyzers, toExternal, toInternal, toNativeType, toObject, toObject, toString, unmarshalBase64SortValue, unmarshalStringSortValue, useDocValuesAsStored, writeprotected void init(IndexSchema schema, Map<String,String> args)
FieldTypepublic void write(TextResponseWriter writer, String name, IndexableField f) throws IOException
FieldTypewrite in class FieldTypeIOExceptionpublic SortField getSortField(SchemaField field, boolean top)
FieldTypepublic UninvertingReader.Type getUninversionType(SchemaField sf)
FieldTypeIf DocValues is not enabled for a field, but it's indexed, docvalues can be constructed on the fly (uninverted, aka fieldcache) on the first request to sort, facet, etc. This specifies the structure to use.
This method will not be used if the field is (effectively) uninvertible="false"
getUninversionType in class FieldTypesf - field instancenull (to disallow uninversion for the field)SchemaField.isUninvertible()public Analyzer getIndexAnalyzer()
FieldTypeThis method may be called many times, at any time.
getIndexAnalyzer in class FieldTypeFieldType.getQueryAnalyzer()public Analyzer getQueryAnalyzer()
FieldTypeThis method may be called many times, at any time.
getQueryAnalyzer in class FieldTypeFieldType.getIndexAnalyzer()public Query getRangeQuery(QParser parser, SchemaField field, String part1, String part2, boolean minInclusive, boolean maxInclusive)
FieldTypeSolrQueryParser
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 FieldTypeparser - 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 notprotected void checkSupportsDocValues()
FieldTypeFieldType.checkSchemaField(SchemaField) if the field has docValues. By default none do.checkSupportsDocValues in class FieldTypepublic List<IndexableField> createFields(SchemaField field, Object value)
FieldTypeSchemaField, create one or more IndexableField instancescreateFields in class FieldTypefield - the SchemaFieldvalue - The value to add to the fieldIndexableFieldFieldType.createField(SchemaField, Object),
FieldType.isPolyField()public Object marshalSortValue(Object value)
FieldTypemarshalSortValue in class FieldTypepublic Object unmarshalSortValue(Object value)
FieldTypeFieldType.marshalSortValue(java.lang.Object) back
into a value usable by the FieldComparator for this FieldType's SortFieldunmarshalSortValue in class FieldTypeCopyright © 2000-2019 Apache Software Foundation. All Rights Reserved.