Package org.apache.solr.schema

Class TrieField

java.lang.Object
org.apache.solr.schema.FieldProperties
org.apache.solr.schema.FieldType
org.apache.solr.schema.PrimitiveFieldType
org.apache.solr.schema.NumericFieldType
org.apache.solr.schema.TrieField
Direct Known Subclasses:
TrieDateField, TrieDoubleField, TrieFloatField, TrieIntField, TrieLongField
@Deprecated public class TrieField extends NumericFieldType
Deprecated.
Trie fields are deprecated as of Solr 7.0
Provides field types to support for Lucene's LegacyIntField, LegacyLongField, LegacyFloatField and LegacyDoubleField. See LegacyNumericRangeQuery 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:

  • Field Details

    • DEFAULT_PRECISION_STEP

      public static final int DEFAULT_PRECISION_STEP
      Deprecated.
      See Also:

    • precisionStepArg

      protected int precisionStepArg
      Deprecated.

    • precisionStep

      protected int precisionStep
      Deprecated.

  • Constructor Details

    • TrieField

      public TrieField()
      Deprecated.

  • Method Details

    • 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 class PrimitiveFieldType

    • 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 class FieldType
      See Also:

    • 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.
      Specified by:
      getSortField in class FieldType
      See Also:

    • 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 class FieldType
      Parameters:
      sf - field instance
      Returns:
      type to uninvert, or null (to disallow uninversion for the field)
      See Also:

    • 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 class FieldType

    • 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 to FieldType.getValueSource(org.apache.solr.schema.SchemaField, org.apache.solr.search.QParser)

      Overrides:
      getSingleValueSource in class FieldType
      See Also:

    • 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 null
      field - the field to use, guaranteed to be multivalued.
      See Also:

    • 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 value

      Sub-classes should prefer using FieldType.toExternal(IndexableField) or FieldType.toObject(IndexableField) to get the writeable external value of f instead of directly using f.stringValue() or f.binaryValue()

      Specified by:
      write in class FieldType
      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 class FieldType

    • 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 class FieldType

    • 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 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.

      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 class FieldType
      Parameters:
      parser - the QParser calling the method
      field - the schema field
      min - the lower boundary of the range, nulls are allowed.
      max - the upper boundary of the range, nulls are allowed
      minInclusive - whether the minimum of the range is inclusive or not
      maxInclusive - 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 class FieldType

    • 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 class FieldType

    • 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 the result parameter and write from offset 0
      Overrides:
      readableToIndexed in class FieldType

    • 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 class FieldType
      See Also:

    • 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 class FieldType
      See Also:

    • indexedToReadable

      public String indexedToReadable(String _indexedForm)
      Deprecated.
      Description copied from class: FieldType
      Given an indexed term, return the human readable representation
      Overrides:
      indexedToReadable in class FieldType

    • 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 class FieldType

    • toObject

      public Object toObject(SchemaField sf, org.apache.lucene.util.BytesRef term)
      Deprecated.
      Overrides:
      toObject in class FieldType

    • 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 class FieldType

    • 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 class FieldType
      See Also:

    • createFields

      public List<org.apache.lucene.index.IndexableField> createFields(SchemaField sf, Object value)
      Deprecated.
      Description copied from class: FieldType
      Given a SchemaField, create one or more IndexableField instances
      Overrides:
      createFields in class FieldType
      Parameters:
      sf - the SchemaField
      value - The value to add to the field
      Returns:
      An array of IndexableField
      See Also:

    • getMainValuePrefix

      public static String getMainValuePrefix(FieldType ft)
      Deprecated.
      expert internal use, subject to change. Returns null if no prefix or prefix not needed, or the prefix of the main value of a trie field that indexes multiple precisions per value.