public class DatePointField extends PointField 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 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."
TrieDateField,
PointFieldFieldType.DefaultAnalyzer, FieldType.MultiValueSelectortypeANALYZER, args, AUTO_GENERATE_PHRASE_QUERIES, CHAR_FILTER, CHAR_FILTERS, CLASS_NAME, docValuesFormat, ENABLE_GRAPH_QUERIES, falseProperties, FILTER, FILTERS, INDEX, INDEX_ANALYZER, 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, LARGE_FIELD, MULTIVALUED, OMIT_NORMS, OMIT_POSITIONS, OMIT_TF_POSITIONS, REQUIRED, SORT_MISSING_FIRST, SORT_MISSING_LAST, STORE_OFFSETS, STORE_TERMOFFSETS, STORE_TERMPAYLOADS, STORE_TERMPOSITIONS, STORE_TERMVECTORS, STORED, TOKENIZED, USE_DOCVALUES_AS_STORED| Constructor and Description |
|---|
DatePointField() |
| Modifier and Type | Method and Description |
|---|---|
IndexableField |
createField(SchemaField field,
Object value,
float boost)
Used for adding a document when a field needs to be created from a
type and a string.
|
protected Query |
getExactQuery(SchemaField field,
String externalVal) |
FieldType.LegacyNumericType |
getNumericType()
Return the numeric type of this field, or null if this field is not a
numeric field.
|
Query |
getPointRangeQuery(QParser parser,
SchemaField field,
String min,
String max,
boolean minInclusive,
boolean maxInclusive) |
Query |
getSetQuery(QParser parser,
SchemaField field,
Collection<String> externalVals) |
protected ValueSource |
getSingleValueSource(SortedNumericSelector.Type choice,
SchemaField field)
Helper method that will only be called for multivalued Point fields that have doc values.
|
SortField |
getSortField(SchemaField field,
boolean top)
Returns the SortField instance that should be used to sort fields
of this type.
|
protected StoredField |
getStoredField(SchemaField sf,
Object value) |
UninvertingReader.Type |
getUninversionType(SchemaField sf)
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.
|
ValueSource |
getValueSource(SchemaField field,
QParser parser)
called to get the default value source (normally, from the
Lucene FieldCache.)
|
protected String |
indexedToReadable(BytesRef indexedForm) |
void |
readableToIndexed(CharSequence val,
BytesRefBuilder result)
Given the readable value, return the term value that will match it.
|
Object |
toNativeType(Object val)
Converts any Object to a java Object native to this field type
|
Object |
toObject(IndexableField f)
Convert the stored-field format to an external object.
|
Object |
toObject(SchemaField sf,
BytesRef term) |
createFields, getFieldQuery, getRangeQuery, getSingleValueSource, indexedToReadable, indexedToReadable, isFieldUsed, isPointField, isTokenized, multiValuedFieldCache, storedToIndexed, storedToReadable, toInternal, toInternalByteRef, writegetDocValuesRangeQuery, getNumberType, getRangeQueryForFloatDoubleDocValues, getRangeQueryForMultiValuedDoubleDocValues, getRangeQueryForMultiValuedFloatDocValues, numericDocValuesRangeQuerycheckSupportsDocValues, initcheckSchemaField, createField, getAnalyzerProperties, getClassArg, getDocValuesFormat, getIndexAnalyzer, getIndexOptions, getNamedPropertyValues, getNonFieldPropertyArgs, getPostingsFormat, getPrefixQuery, getQueryAnalyzer, getRewriteMethod, getSimilarity, getSimilarityFactory, getStringSort, getTypeName, hasProperty, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isPolyField, marshalBase64SortValue, marshalSortValue, marshalStringSortValue, readableToIndexed, restrictProps, setArgs, setIndexAnalyzer, setIsExplicitAnalyzer, setIsExplicitQueryAnalyzer, setQueryAnalyzer, setSimilarity, supportsAnalyzers, toExternal, toString, unmarshalBase64SortValue, unmarshalSortValue, unmarshalStringSortValue, useDocValuesAsStoredpublic Object toNativeType(Object val)
FieldTypetoNativeType in class FieldTypepublic Query getPointRangeQuery(QParser parser, SchemaField field, String min, String max, boolean minInclusive, boolean maxInclusive)
getPointRangeQuery in class PointFieldpublic Object toObject(SchemaField sf, BytesRef term)
public Object toObject(IndexableField f)
FieldTypetoObject in class FieldTypeFieldType.toInternal(java.lang.String)protected Query getExactQuery(SchemaField field, String externalVal)
getExactQuery in class PointFieldpublic Query getSetQuery(QParser parser, SchemaField field, Collection<String> externalVals)
getSetQuery in class PointFieldprotected String indexedToReadable(BytesRef indexedForm)
indexedToReadable in class PointFieldpublic void readableToIndexed(CharSequence val, BytesRefBuilder result)
FieldTyperesult
parameter and write from offset 0readableToIndexed in class FieldTypepublic SortField getSortField(SchemaField field, boolean top)
FieldTypegetSortField in class FieldTypeSchemaField.checkSortability()public UninvertingReader.Type getUninversionType(SchemaField sf)
FieldTypegetUninversionType in class FieldTypesf - field instancenull (to disallow uninversion for the field)public ValueSource getValueSource(SchemaField field, QParser parser)
FieldTypegetValueSource in class FieldTypeprotected ValueSource getSingleValueSource(SortedNumericSelector.Type choice, SchemaField field)
PointFieldgetSingleValueSource in class PointFieldchoice - the selector Type to use, will never be nullfield - the field to use, guaranteed to be multivalued.FieldType.getSingleValueSource(MultiValueSelector,SchemaField,QParser)public FieldType.LegacyNumericType getNumericType()
FieldTypegetNumericType in class FieldTypepublic IndexableField createField(SchemaField field, Object value, float boost)
FieldTypeBy 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.createField in class FieldTypeFieldType.toInternal(java.lang.String)protected StoredField getStoredField(SchemaField sf, Object value)
getStoredField in class PointFieldCopyright © 2000-2017 Apache Software Foundation. All Rights Reserved.