gerlowskija commented on code in PR #3922: URL: https://github.com/apache/solr/pull/3922#discussion_r3096108978
########## solr/core/src/java/org/apache/solr/schema/DateField.java: ########## @@ -0,0 +1,280 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.solr.schema; + +import org.apache.lucene.document.Field; +import org.apache.lucene.document.InvertableType; +import org.apache.lucene.document.LongPoint; +import org.apache.lucene.document.SortedNumericDocValuesField; +import org.apache.lucene.document.StoredField; +import org.apache.lucene.document.StoredValue; +import org.apache.lucene.index.DocValuesType; +import org.apache.lucene.index.IndexOptions; +import org.apache.lucene.index.IndexableField; +import org.apache.lucene.queries.function.ValueSource; +import org.apache.lucene.queries.function.valuesource.MultiValuedLongFieldSource; +import org.apache.lucene.search.MatchNoDocsQuery; +import org.apache.lucene.search.Query; +import org.apache.lucene.search.SortedNumericSelector; +import org.apache.lucene.util.BytesRef; +import org.apache.lucene.util.BytesRefBuilder; +import org.apache.solr.common.SolrException; +import org.apache.solr.search.QParser; +import org.apache.solr.uninverting.UninvertingReader.Type; +import org.apache.solr.update.processor.TimestampUpdateProcessorFactory; +import org.apache.solr.util.DateMathParser; +import java.time.Instant; +import java.util.Collection; +import java.util.Collections; +import java.util.Date; +import java.util.List; + +/** + * An {@code NumericField} implementation of a field for {@code Date} values with millisecond precision using {@code LongPoint}, {@code StringField}, {@code SortedNumericDocValuesField} and {@code StoredField}. + * + * <p>Date Format for the XML, incoming and outgoing: + * + * <blockquote> + * + * 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. + * + * </blockquote> + * + * <p>This format was derived to be standards compliant (ISO 8601) and is a more restricted form of + * the <a href="http://www.w3.org/TR/xmlschema-2/#dateTime-canonical-representation";>canonical + * representation of dateTime</a> from XML schema part 2. Examples... + * + * <ul> + * <li>1995-12-31T23:59:59Z + * <li>1995-12-31T23:59:59.9Z + * <li>1995-12-31T23:59:59.99Z + * <li>1995-12-31T23:59:59.999Z + * </ul> + * + * <p>Note that <code>DatePointField</code> 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. + * + * <p>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 {@link DateMathParser} for more examples. + * + * <p><b>NOTE:</b> Although it is possible to configure a <code>DateField</code> instance with + * a default value of "<code>NOW</code>" 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. {@link TimestampUpdateProcessorFactory} is recommended instead. + * + * <p>Explanation of "UTC"... + * + * <blockquote> + * + * "In 1970 the Coordinated Universal Time system was devised by an international advisory group of Review Comment: 50 years on I don't think "UTC" needs an explainer anymore 😛 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
