Package org.apache.solr.schema

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.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:
    LegacyNumericRangeQuery

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

    • Constructor Detail

      • TrieField

        public TrieField()
        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 class PrimitiveFieldType

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

      • 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:
        getSingleValueSource(MultiValueSelector,SchemaField,QParser)

      • 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

      • getFieldQuery

        public org.apache.lucene.search.Query getFieldQuery​(QParser parser,
                                                    SchemaField field,
                                                    String externalVal)
        Deprecated.
        Description copied from class: FieldType
        Returns a Query instance for doing searches against a field.
        Overrides:
        getFieldQuery in class FieldType
        Parameters:
        parser - The QParser calling the method
        field - The SchemaField of the field to search
        externalVal - The String representation of the value to search
        Returns:
        The Query instance. This implementation returns a TermQuery but overriding queries may not

      • 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

      • 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

      • 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:
        FieldType.toInternal(java.lang.String)

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