org.apache.solr.schema

Class LongPointField

java.lang.Object

org.apache.solr.schema.FieldProperties

org.apache.solr.schema.FieldType

org.apache.solr.schema.PrimitiveFieldType

org.apache.solr.schema.NumericFieldType

org.apache.solr.schema.PointField

org.apache.solr.schema.LongPointField

All Implemented Interfaces:

LongValueFieldType, NumericValueFieldType

public class LongPointField
extends PointField
implements LongValueFieldType

PointField implementation for Long values.

See Also:

PointField, LongPoint

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.schema.FieldType

FieldType.DefaultAnalyzer, FieldType.MultiValueSelector

Field Summary

Fields inherited from class org.apache.solr.schema.NumericFieldType

type

Fields inherited from class org.apache.solr.schema.FieldType

ANALYZER, 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, typeName

Fields inherited from class org.apache.solr.schema.FieldProperties

BINARY, 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 Summary

Constructors

Constructor and Description
LongPointField()

Method Summary

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> externalVal)
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 qparser) 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)

Methods inherited from class org.apache.solr.schema.PointField

createFields, getFieldQuery, getRangeQuery, getSingleValueSource, indexedToReadable, indexedToReadable, isFieldUsed, isPointField, isTokenized, multiValuedFieldCache, storedToIndexed, storedToReadable, toInternal, toInternalByteRef, write

Methods inherited from class org.apache.solr.schema.NumericFieldType

getDocValuesRangeQuery, getNumberType, getRangeQueryForFloatDoubleDocValues, getRangeQueryForMultiValuedDoubleDocValues, getRangeQueryForMultiValuedFloatDocValues, numericDocValuesRangeQuery

Methods inherited from class org.apache.solr.schema.PrimitiveFieldType

checkSupportsDocValues, init

Methods inherited from class org.apache.solr.schema.FieldType

checkSchemaField, 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, useDocValuesAsStored

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LongPointField

public LongPointField()

Method Detail

toNativeType

public Object toNativeType(Object val)

Description copied from class: FieldType

Converts any Object to a java Object native to this field type

Overrides:

toNativeType in class FieldType

getPointRangeQuery

public Query getPointRangeQuery(QParser parser,
                                SchemaField field,
                                String min,
                                String max,
                                boolean minInclusive,
                                boolean maxInclusive)

Specified by:

getPointRangeQuery in class PointField

toObject

public Object toObject(SchemaField sf,
                       BytesRef term)

Overrides:

toObject in class FieldType

toObject

public Object toObject(IndexableField f)

Description copied from class: FieldType

Convert the stored-field format to an external object.

Overrides:

toObject in class FieldType

See Also:

FieldType.toInternal(java.lang.String)

getExactQuery

protected Query getExactQuery(SchemaField field,
                              String externalVal)

Specified by:

getExactQuery in class PointField

getSetQuery

public Query getSetQuery(QParser parser,
                         SchemaField field,
                         Collection<String> externalVal)

Overrides:

getSetQuery in class PointField

indexedToReadable

protected String indexedToReadable(BytesRef indexedForm)

Specified by:

indexedToReadable in class PointField

readableToIndexed

public void readableToIndexed(CharSequence val,
                              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

getSortField

public SortField getSortField(SchemaField field,
                              boolean top)

Description copied from class: FieldType

Returns the SortField instance that should be used to sort fields of this type.

Specified by:

getSortField in class FieldType

See Also:

SchemaField.checkSortability()

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.

Specified by:

getUninversionType in class FieldType

Parameters:

sf - field instance

Returns:

type to uninvert, or null (to disallow uninversion for the field)

getValueSource

public ValueSource getValueSource(SchemaField field,
                                  QParser qparser)

Description copied from class: FieldType

called to get the default value source (normally, from the Lucene FieldCache.)

Overrides:

getValueSource in class FieldType

getSingleValueSource

protected ValueSource getSingleValueSource(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:

FieldType.getSingleValueSource(MultiValueSelector,SchemaField,QParser)

getNumericType

public FieldType.LegacyNumericType getNumericType()

Description copied from class: FieldType

Return the numeric type of this field, or null if this field is not a numeric field.

Overrides:

getNumericType in class FieldType

createField

public IndexableField createField(SchemaField field,
                                  Object value,
                                  float boost)

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)

getStoredField

protected StoredField getStoredField(SchemaField sf,
                                     Object value)

Specified by:

getStoredField in class PointField