public class TrieDateField extends TrieField implements DateValueFieldType
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...
Note that TrieDateField 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 TrieDateField
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."
TrieFieldTrieField.TrieTypesFieldType.DefaultAnalyzer| Modifier and Type | Field and Description |
|---|---|
protected static Locale |
CANONICAL_LOCALE
Fixed Locale needed for parsing/formatting Milliseconds in the
canonical representation.
|
protected static TimeZone |
CANONICAL_TZ
Fixed TimeZone (UTC) needed for parsing/formatting Dates in the
canonical representation.
|
protected static String |
NOW |
static TimeZone |
UTC |
protected static char |
Z |
DEFAULT_PRECISION_STEP, missingValue, precisionStep, precisionStepArg, typeANALYZER, args, CHAR_FILTER, CHAR_FILTERS, CLASS_NAME, docValuesFormat, falseProperties, FILTER, FILTERS, INDEX, INDEX_ANALYZER, log, MULTI_TERM, MULTI_TERM_ANALYZER, POLY_FIELD_SEPARATOR, postingsFormat, properties, QUERY, QUERY_ANALYZER, similarity, SIMILARITY, similarityFactory, TOKENIZER, trueProperties, TYPE, TYPE_NAME, typeNameBINARY, DOC_VALUES, INDEXED, MULTIVALUED, OMIT_NORMS, OMIT_POSITIONS, OMIT_TF_POSITIONS, REQUIRED, SORT_MISSING_FIRST, SORT_MISSING_LAST, STORE_OFFSETS, STORE_TERMOFFSETS, STORE_TERMPOSITIONS, STORE_TERMVECTORS, STORED, TOKENIZED| Constructor and Description |
|---|
TrieDateField() |
| Modifier and Type | Method and Description |
|---|---|
protected String |
formatDate(Date d)
Thread safe method that can be used by subclasses to format a Date
without the trailing 'Z'.
|
static String |
formatExternal(Date d)
Return the standard human readable form of the date
|
Query |
getRangeQuery(QParser parser,
SchemaField sf,
Date min,
Date max,
boolean minInclusive,
boolean maxInclusive)
TrieDateField specific range query
|
static Date |
parseDate(String s)
Thread safe method that can be used by subclasses to parse a Date
without the trailing 'Z'
|
Date |
parseDateLenient(String s,
SolrQueryRequest req)
Parse a date string in the standard format, or any supported by DateUtil.parseDate
|
Date |
parseMath(Date now,
String val)
Parses a String which may be a date (in the standard format)
followed by an optional math expression.
|
Date |
parseMathLenient(Date now,
String val,
SolrQueryRequest req)
Parses a String which may be a date
followed by an optional math expression.
|
String |
toExternal(Date d) |
Object |
toNativeType(Object val)
Converts any Object to a java Object native to this field type
|
Date |
toObject(IndexableField f)
Convert the stored-field format to an external object.
|
checkSchemaField, createField, createFields, getFieldQuery, getMainValuePrefix, getNumericType, getPrecisionStep, getRangeQuery, getSortField, getType, getUninversionType, getValueSource, indexedToReadable, indexedToReadable, init, isTokenized, multiValuedFieldCache, readableToIndexed, readableToIndexed, storedToIndexed, storedToReadable, toExternal, toInternal, toObject, writecreateField, getAnalyzerProperties, getClassArg, getDocValuesFormat, getIndexAnalyzer, getIndexOptions, getNamedPropertyValues, getNonFieldPropertyArgs, getPostingsFormat, getPrefixQuery, getQueryAnalyzer, getRewriteMethod, getSimilarity, getSimilarityFactory, getStringSort, getTypeName, hasProperty, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isPolyField, marshalBase64SortValue, marshalSortValue, marshalStringSortValue, restrictProps, setArgs, setIndexAnalyzer, setIsExplicitAnalyzer, setIsExplicitQueryAnalyzer, setQueryAnalyzer, setSimilarity, supportsAnalyzers, toString, unmarshalBase64SortValue, unmarshalSortValue, unmarshalStringSortValuepublic static final TimeZone UTC
protected static final TimeZone CANONICAL_TZ
protected static final Locale CANONICAL_LOCALE
protected static final String NOW
protected static final char Z
public Date parseMath(Date now, String val)
now - an optional fixed date to use as "NOW" in the DateMathParserval - the string to parseprotected String formatDate(Date d)
public static String formatExternal(Date d)
public String toExternal(Date d)
formatExternal(java.util.Date)public static Date parseDate(String s) throws ParseException
ParseExceptionpublic Date parseDateLenient(String s, SolrQueryRequest req) throws ParseException
ParseExceptionpublic Date parseMathLenient(Date now, String val, SolrQueryRequest req)
now - an optional fixed date to use as "NOW" in the DateMathParserval - the string to parsepublic Date toObject(IndexableField f)
FieldTypetoObject in class TrieFieldFieldType.toInternal(java.lang.String)public Query getRangeQuery(QParser parser, SchemaField sf, Date min, Date max, boolean minInclusive, boolean maxInclusive)
public Object toNativeType(Object val)
FieldTypetoNativeType in class FieldTypeCopyright © 2000-2015 Apache Software Foundation. All Rights Reserved.