Package org.apache.solr.schema

Class DatePointField

  • All Implemented Interfaces:
    DateValueFieldType
    public class DatePointField
extends PointField
implements DateValueFieldType
    FieldType that can represent any Date/Time with millisecond precision.

    Date Format for the XML, incoming and outgoing:

    A date field shall be of the form 1995-12-31T23:59:59Z The trailing "Z" designates UTC time and is mandatory (See below for an explanation of UTC). Optional fractional seconds are allowed, as long as they do not end in a trailing 0 (but any precision beyond milliseconds will be ignored). All other parts are mandatory.

    This format was derived to be standards compliant (ISO 8601) and is a more restricted form of the canonical representation of dateTime from XML schema part 2. Examples...

    • 1995-12-31T23:59:59Z
    • 1995-12-31T23:59:59.9Z
    • 1995-12-31T23:59:59.99Z
    • 1995-12-31T23:59:59.999Z

    Note that DatePointField is lenient with regards to parsing fractional seconds that end in trailing zeros and will ensure that those values are indexed in the correct canonical format.

    This FieldType also supports incoming "Date Math" strings for computing values by adding/rounding internals of time relative either an explicit datetime (in the format specified above) or the literal string "NOW", ie: "NOW+1YEAR", "NOW/DAY", "1995-12-31T23:59:59.999Z+5MINUTES", etc... -- see DateMathParser for more examples.

    NOTE: Although it is possible to configure a DatePointField instance with a default value of "NOW" to compute a timestamp of when the document was indexed, this is not advisable when using SolrCloud since each replica of the document may compute a slightly different value. TimestampUpdateProcessorFactory is recommended instead.

    Explanation of "UTC"...

    "In 1970 the Coordinated Universal Time system was devised by an international advisory group of technical experts within the International Telecommunication Union (ITU). The ITU felt it was best to designate a single abbreviation for use in all languages in order to minimize confusion. Since unanimous agreement could not be achieved on using either the English word order, CUT, or the French word order, TUC, the acronym UTC was chosen as a compromise."
    See Also:
    TrieDateField, PointField

    • Constructor Detail

      • DatePointField

        public DatePointField()

    • Method Detail

      • readableToIndexed

        public void readableToIndexed​(CharSequence val,
                              org.apache.lucene.util.BytesRefBuilder result)
        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

      • getUninversionType

        public UninvertingReader.Type getUninversionType​(SchemaField sf)
        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 parser)
        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.SortedNumericSelector.Type choice,
                                                                              SchemaField field)
        Description copied from class: PointField
        Helper method that will only be called for multivalued Point 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
        Specified by:
        getSingleValueSource in class PointField
        Parameters:
        choice - the selector Type to use, will never be null
        field - the field to use, guaranteed to be multivalued.
        See Also:
        PointField.getSingleValueSource(MultiValueSelector,SchemaField,QParser)

      • createField

        public org.apache.lucene.index.IndexableField createField​(SchemaField field,
                                                          Object value)
        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)