Class TrieField
-
- Direct Known Subclasses:
TrieDateField
,TrieDoubleField
,TrieFloatField
,TrieIntField
,TrieLongField
@Deprecated public class TrieField extends NumericFieldType
Deprecated.Trie fields are deprecated as of Solr 7.0Provides field types to support for Lucene'sLegacyIntField
,LegacyLongField
,LegacyFloatField
andLegacyDoubleField
. SeeLegacyNumericRangeQuery
for more details. It supports integer, float, long, double and date types.For each number being added to this field, multiple terms are generated as per the algorithm described in the above link. The possible number of terms increases dramatically with lower precision steps. For the fast range search to work, trie fields must be indexed.
Trie fields are sortable in numerical order and can be used in function queries.
Note that if you use a precisionStep of 32 for int/float and 64 for long/double/date, then multiple terms will not be generated, range search will be no faster than any other number field, but sorting will still be possible.
- Since:
- solr 1.4
- See Also:
LegacyNumericRangeQuery
,PointField
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.solr.schema.FieldType
FieldType.DefaultAnalyzer, FieldType.MultiValueSelector
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_PRECISION_STEP
Deprecated.protected int
precisionStep
Deprecated.protected int
precisionStepArg
Deprecated.-
Fields inherited from class org.apache.solr.schema.NumericFieldType
doubleOrFloat, type
-
Fields inherited from class org.apache.solr.schema.FieldType
ANALYZER, 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, typeName
-
Fields inherited from class org.apache.solr.schema.FieldProperties
BINARY, 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 Summary
Constructors Constructor Description TrieField()
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description org.apache.lucene.index.IndexableField
createField(SchemaField field, Object value)
Deprecated.Used for adding a document when a field needs to be created from a type and a string.List<org.apache.lucene.index.IndexableField>
createFields(SchemaField sf, Object value)
Deprecated.Given aSchemaField
, create one or moreIndexableField
instancesstatic String
getMainValuePrefix(FieldType ft)
Deprecated.expert internal use, subject to change.int
getPrecisionStep()
Deprecated.protected org.apache.lucene.queries.function.ValueSource
getSingleValueSource(org.apache.lucene.search.SortedSetSelector.Type choice, SchemaField field)
Deprecated.Helper method that will only be called for multivalued Trie fields that have doc values.org.apache.lucene.queries.function.ValueSource
getSingleValueSource(FieldType.MultiValueSelector choice, SchemaField field, QParser parser)
Deprecated.Method for dynamically building a ValueSource based on a single value of a multivalued field.org.apache.lucene.search.SortField
getSortField(SchemaField field, boolean reverse)
Deprecated.Returns the SortField instance that should be used to sort fields of this type.protected org.apache.lucene.search.Query
getSpecializedRangeQuery(QParser parser, SchemaField field, String min, String max, boolean minInclusive, boolean maxInclusive)
Deprecated.Returns a Query instance for doing range searches on this field type.UninvertingReader.Type
getUninversionType(SchemaField sf)
Deprecated.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.org.apache.lucene.queries.function.ValueSource
getValueSource(SchemaField field, QParser qparser)
Deprecated.called to get the default value source (normally, from the Lucene FieldCache.)String
indexedToReadable(String _indexedForm)
Deprecated.Given an indexed term, return the human readable representationorg.apache.lucene.util.CharsRef
indexedToReadable(org.apache.lucene.util.BytesRef indexedForm, org.apache.lucene.util.CharsRefBuilder charsRef)
Deprecated.Given an indexed term, append the human readable representationprotected void
init(IndexSchema schema, Map<String,String> args)
Deprecated.subclasses should initialize themselves with the args provided and remove valid arguments.boolean
isTokenized()
Deprecated.Returns true if fields of this type should be tokenizedboolean
multiValuedFieldCache()
Deprecated.Returns true if a single field value of this type has multiple logical values for the purposes of faceting, sorting, etc.void
readableToIndexed(CharSequence val, org.apache.lucene.util.BytesRefBuilder result)
Deprecated.Given the readable value, return the term value that will match it.String
readableToIndexed(String val)
Deprecated.Given the readable value, return the term value that will match it.String
storedToIndexed(org.apache.lucene.index.IndexableField f)
Deprecated.Given the stored field, return the indexed formString
storedToReadable(org.apache.lucene.index.IndexableField f)
Deprecated.Given the stored field, return the human readable representationString
toExternal(org.apache.lucene.index.IndexableField f)
Deprecated.Convert the stored-field format to an external (string, human readable) valueString
toInternal(String val)
Deprecated.Convert an external value (from XML update command or from query string) into the internal format for both storing and indexing (which can be modified by any analyzers).Object
toObject(org.apache.lucene.index.IndexableField f)
Deprecated.Convert the stored-field format to an external object.Object
toObject(SchemaField sf, org.apache.lucene.util.BytesRef term)
Deprecated.void
write(TextResponseWriter writer, String name, org.apache.lucene.index.IndexableField f)
Deprecated.calls back to TextResponseWriter to write the field value-
Methods inherited from class org.apache.solr.schema.NumericFieldType
getDocValuesRangeQuery, getNumberType, getRangeQueryForFloatDoubleDocValues, getRangeQueryForMultiValuedDoubleDocValues, getRangeQueryForMultiValuedFloatDocValues, getSpecializedExistenceQuery, numericDocValuesRangeQuery, treatUnboundedRangeAsExistence
-
Methods inherited from class org.apache.solr.schema.PrimitiveFieldType
checkSupportsDocValues, enableDocValuesByDefault, getDefaultMultiValueSelectorForSort
-
Methods inherited from class org.apache.solr.schema.FieldType
checkSchemaField, createField, getAnalyzerProperties, getClassArg, getDocValuesFormat, getExistenceQuery, getFieldQuery, getFieldTermQuery, getIndexAnalyzer, getNamedPropertyValues, getNonFieldPropertyArgs, getNumericSort, getPostingsFormat, getPrefixQuery, getQueryAnalyzer, getRangeQuery, getRewriteMethod, getSetQuery, getSimilarity, getSimilarityFactory, getSortedNumericSortField, getSortedSetSortField, getSortField, getStringSort, getTypeName, hasProperty, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isPointField, isPolyField, isUtf8Field, marshalBase64SortValue, marshalSortValue, marshalStringSortValue, restrictProps, setArgs, setIndexAnalyzer, setIsExplicitAnalyzer, setIsExplicitQueryAnalyzer, setQueryAnalyzer, setSimilarity, supportsAnalyzers, toNativeType, toString, unmarshalBase64SortValue, unmarshalSortValue, unmarshalStringSortValue, useDocValuesAsStored, write
-
-
-
-
Field Detail
-
DEFAULT_PRECISION_STEP
public static final int DEFAULT_PRECISION_STEP
Deprecated.- See Also:
- Constant Field Values
-
precisionStepArg
protected int precisionStepArg
Deprecated.
-
precisionStep
protected int precisionStep
Deprecated.
-
-
Method Detail
-
init
protected void init(IndexSchema schema, Map<String,String> args)
Deprecated.Description copied from class:FieldType
subclasses should initialize themselves with the args provided and remove valid arguments. leftover arguments will cause an exception. Common boolean properties have already been handled.- Overrides:
init
in classPrimitiveFieldType
-
toObject
public Object toObject(org.apache.lucene.index.IndexableField f)
Deprecated.Description copied from class:FieldType
Convert the stored-field format to an external object.- Overrides:
toObject
in classFieldType
- See Also:
FieldType.toInternal(java.lang.String)
-
getSortField
public org.apache.lucene.search.SortField getSortField(SchemaField field, boolean reverse)
Deprecated.Description copied from class:FieldType
Returns the SortField instance that should be used to sort fields of this type.
-
getUninversionType
public UninvertingReader.Type getUninversionType(SchemaField sf)
Deprecated.Description copied from class:FieldType
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. This specifies the structure to use.This method will not be used if the field is (effectively)
uninvertible="false"
- Specified by:
getUninversionType
in classFieldType
- Parameters:
sf
- field instance- Returns:
- type to uninvert, or
null
(to disallow uninversion for the field) - See Also:
SchemaField.isUninvertible()
-
getValueSource
public org.apache.lucene.queries.function.ValueSource getValueSource(SchemaField field, QParser qparser)
Deprecated.Description copied from class:FieldType
called to get the default value source (normally, from the Lucene FieldCache.)- Overrides:
getValueSource
in classFieldType
-
getSingleValueSource
public final org.apache.lucene.queries.function.ValueSource getSingleValueSource(FieldType.MultiValueSelector choice, SchemaField field, QParser parser)
Deprecated.Description copied from class:FieldType
Method for dynamically building a ValueSource based on a single value of a multivalued field.The default implementation throws an error except in the trivial case where this method is used on a
SchemaField
that is in fact not-multivalued, in which case it delegates toFieldType.getValueSource(org.apache.solr.schema.SchemaField, org.apache.solr.search.QParser)
- Overrides:
getSingleValueSource
in classFieldType
- See Also:
FieldType.MultiValueSelector
-
getSingleValueSource
protected org.apache.lucene.queries.function.ValueSource getSingleValueSource(org.apache.lucene.search.SortedSetSelector.Type choice, SchemaField field)
Deprecated.Helper method that will only be called for multivalued Trie fields that have doc values. Default impl throws an error indicating that selecting a single value from this multivalued field is not supported for this field type- Parameters:
choice
- the selector Type to use, will never be nullfield
- the field to use, guaranteed to be multivalued.- See Also:
getSingleValueSource(MultiValueSelector,SchemaField,QParser)
-
write
public void write(TextResponseWriter writer, String name, org.apache.lucene.index.IndexableField f) throws IOException
Deprecated.Description copied from class:FieldType
calls back to TextResponseWriter to write the field valueSub-classes should prefer using
FieldType.toExternal(IndexableField)
orFieldType.toObject(IndexableField)
to get the writeable external value off
instead of directly usingf.stringValue()
orf.binaryValue()
- Specified by:
write
in classFieldType
- Throws:
IOException
-
isTokenized
public boolean isTokenized()
Deprecated.Description copied from class:FieldType
Returns true if fields of this type should be tokenized- Overrides:
isTokenized
in classFieldType
-
multiValuedFieldCache
public boolean multiValuedFieldCache()
Deprecated.Description copied from class:FieldType
Returns true if a single field value of this type has multiple logical values for the purposes of faceting, sorting, etc. Text fields normally return true since each token/word is a logical value.- Overrides:
multiValuedFieldCache
in classFieldType
-
getPrecisionStep
public int getPrecisionStep()
Deprecated.- Returns:
- the precisionStep used to index values into the field
-
getSpecializedRangeQuery
protected org.apache.lucene.search.Query getSpecializedRangeQuery(QParser parser, SchemaField field, String min, String max, boolean minInclusive, boolean maxInclusive)
Deprecated.Description copied from class:FieldType
Returns a Query instance for doing range searches on this field type.SolrQueryParser
currently passespart1
andpart2
as null if they are '*' respectively.minInclusive
andmaxInclusive
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/orpart2
as well as unequalminInclusive
andmaxInclusive
parameters gracefully.This method does not, and should not, check for or handle existence queries, please look at
FieldType.getRangeQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String, java.lang.String, boolean, boolean)
for that logic.- Overrides:
getSpecializedRangeQuery
in classFieldType
- Parameters:
parser
- theQParser
calling the methodfield
- the schema fieldmin
- the lower boundary of the range, nulls are allowed.max
- 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 not- Returns:
- a Query instance to perform range search according to given parameters
-
storedToReadable
public String storedToReadable(org.apache.lucene.index.IndexableField f)
Deprecated.Description copied from class:FieldType
Given the stored field, return the human readable representation- Overrides:
storedToReadable
in classFieldType
-
readableToIndexed
public String readableToIndexed(String val)
Deprecated.Description copied from class:FieldType
Given the readable value, return the term value that will match it.- Overrides:
readableToIndexed
in classFieldType
-
readableToIndexed
public void readableToIndexed(CharSequence val, org.apache.lucene.util.BytesRefBuilder result)
Deprecated.Description copied from class:FieldType
Given the readable value, return the term value that will match it. This method will modify the size and length of theresult
parameter and write from offset 0- Overrides:
readableToIndexed
in classFieldType
-
toInternal
public String toInternal(String val)
Deprecated.Description copied from class:FieldType
Convert an external value (from XML update command or from query string) into the internal format for both storing and indexing (which can be modified by any analyzers).- Overrides:
toInternal
in classFieldType
- See Also:
FieldType.toExternal(org.apache.lucene.index.IndexableField)
-
toExternal
public String toExternal(org.apache.lucene.index.IndexableField f)
Deprecated.Description copied from class:FieldType
Convert the stored-field format to an external (string, human readable) value- Overrides:
toExternal
in classFieldType
- See Also:
FieldType.toInternal(java.lang.String)
-
indexedToReadable
public String indexedToReadable(String _indexedForm)
Deprecated.Description copied from class:FieldType
Given an indexed term, return the human readable representation- Overrides:
indexedToReadable
in classFieldType
-
indexedToReadable
public org.apache.lucene.util.CharsRef indexedToReadable(org.apache.lucene.util.BytesRef indexedForm, org.apache.lucene.util.CharsRefBuilder charsRef)
Deprecated.Description copied from class:FieldType
Given an indexed term, append the human readable representation- Overrides:
indexedToReadable
in classFieldType
-
toObject
public Object toObject(SchemaField sf, org.apache.lucene.util.BytesRef term)
Deprecated.
-
storedToIndexed
public String storedToIndexed(org.apache.lucene.index.IndexableField f)
Deprecated.Description copied from class:FieldType
Given the stored field, return the indexed form- Overrides:
storedToIndexed
in classFieldType
-
createField
public org.apache.lucene.index.IndexableField createField(SchemaField field, Object value)
Deprecated.Description copied from class:FieldType
Used for adding a document when a field needs to be created from a type and a string.By default, the indexed value is the same as the stored value (taken from toInternal()). Having a different representation for external, internal, and indexed would present quite a few problems given the current Lucene architecture. An analyzer for adding docs would need to translate internal->indexed while an analyzer for querying would need to translate external->indexed.
The only other alternative to having internal==indexed would be to have internal==external. In this case, toInternal should convert to the indexed representation, toExternal() should do nothing, and createField() should *not* call toInternal, but use the external value and set tokenized=true to get Lucene to convert to the internal(indexed) form. :TODO: clean up and clarify this explanation.
- Overrides:
createField
in classFieldType
- See Also:
FieldType.toInternal(java.lang.String)
-
createFields
public List<org.apache.lucene.index.IndexableField> createFields(SchemaField sf, Object value)
Deprecated.Description copied from class:FieldType
Given aSchemaField
, create one or moreIndexableField
instances- Overrides:
createFields
in classFieldType
- Parameters:
sf
- theSchemaField
value
- The value to add to the field- Returns:
- An array of
IndexableField
- See Also:
FieldType.createField(SchemaField, Object)
,FieldType.isPolyField()
-
-