public class PointType extends CoordinateFieldType implements SpatialQueryable
LatLonType
for geo-spatial queries.FieldType.DefaultAnalyzer
DEFAULT_DIMENSION, dimension, DIMENSION
dynFieldProps, schema, SUB_FIELD_SUFFIX, SUB_FIELD_TYPE, subFieldType, subSuffix, subType, suffix, suffixes
ANALYZER, 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, typeName
BINARY, 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 |
---|
PointType() |
Modifier and Type | Method and Description |
---|---|
IndexableField |
createField(SchemaField field,
Object value,
float boost)
It never makes sense to create a single field, so make it impossible to happen by
throwing UnsupportedOperationException
|
List<IndexableField> |
createFields(SchemaField field,
Object value,
float boost)
Given a
SchemaField , create one or more IndexableField instances |
Query |
createSpatialQuery(QParser parser,
SpatialOptions options)
Calculates the range and creates a RangeQuery (bounding box) wrapped in a BooleanQuery (unless the dimension is
1, one range for every dimension, AND'd together by a Boolean
|
Query |
getFieldQuery(QParser parser,
SchemaField field,
String externalVal)
Throws UnsupportedOperationException()
|
Query |
getRangeQuery(QParser parser,
SchemaField field,
String part1,
String part2,
boolean minInclusive,
boolean maxInclusive)
Returns a Query instance for doing range searches on this field type.
|
SortField |
getSortField(SchemaField field,
boolean top)
Returns the SortField instance that should be used to sort fields
of this type.
|
ValueSource |
getValueSource(SchemaField field,
QParser parser)
called to get the default value source (normally, from the
Lucene FieldCache.)
|
protected void |
init(IndexSchema schema,
Map<String,String> args)
subclasses should initialize themselves with the args provided
and remove valid arguments.
|
boolean |
isPolyField()
A "polyField" is a FieldType that can produce more than one IndexableField instance for a single value, via the
FieldType.createFields(org.apache.solr.schema.SchemaField, Object, float) method. |
static String[] |
parseCommaSeparatedList(String externalVal,
int dimension)
Given a string containing dimension values encoded in it, separated by commas,
return a String array of length dimension containing the values.
|
static double[] |
vectorBoxCorner(double[] center,
double[] result,
double distance,
boolean upperRight)
Return the coordinates of a vector that is the corner of a box (upper right or lower left), assuming a Rectangular
coordinate system.
|
void |
write(TextResponseWriter writer,
String name,
IndexableField f)
calls back to TextResponseWriter to write the field value
|
getDimension
createSuffixCache, getSubType, inform, subField
checkSchemaField, createField, getAnalyzer, getAnalyzerProperties, getClassArg, getDocValuesFormat, getIndexAnalyzer, getIndexOptions, getNamedPropertyValues, getNonFieldPropertyArgs, getNumericType, getPostingsFormat, getPrefixQuery, getQueryAnalyzer, getRewriteMethod, getSimilarity, getSimilarityFactory, getStringSort, getTypeName, hasProperty, indexedToReadable, indexedToReadable, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isTokenized, marshalBase64SortValue, marshalSortValue, marshalStringSortValue, multiValuedFieldCache, readableToIndexed, readableToIndexed, restrictProps, setAnalyzer, setArgs, setIndexAnalyzer, setIsExplicitAnalyzer, setIsExplicitQueryAnalyzer, setQueryAnalyzer, setSimilarity, storedToIndexed, storedToReadable, supportsAnalyzers, toExternal, toInternal, toObject, toObject, toString, unmarshalBase64SortValue, unmarshalSortValue, unmarshalStringSortValue
protected void init(IndexSchema schema, Map<String,String> args)
FieldType
init
in class AbstractSubTypeFieldType
public boolean isPolyField()
FieldType
FieldType.createFields(org.apache.solr.schema.SchemaField, Object, float)
method. This is useful
when hiding the implementation details of a field from the Solr end user. For instance, a spatial point may be represented by multiple different fields.isPolyField
in class FieldType
FieldType.createFields(org.apache.solr.schema.SchemaField, Object, float)
method may return more than one fieldpublic List<IndexableField> createFields(SchemaField field, Object value, float boost)
FieldType
SchemaField
, create one or more IndexableField
instancescreateFields
in class FieldType
field
- the SchemaField
value
- The value to add to the fieldboost
- The boost to applyIndexableField
FieldType.createField(SchemaField, Object, float)
,
FieldType.isPolyField()
public ValueSource getValueSource(SchemaField field, QParser parser)
FieldType
getValueSource
in class FieldType
public IndexableField createField(SchemaField field, Object value, float boost)
createField
in class FieldType
FieldType.toInternal(java.lang.String)
public void write(TextResponseWriter writer, String name, IndexableField f) throws IOException
FieldType
write
in class FieldType
IOException
public SortField getSortField(SchemaField field, boolean top)
FieldType
getSortField
in class FieldType
SchemaField.checkSortability()
public Query getRangeQuery(QParser parser, SchemaField field, String part1, String part2, boolean minInclusive, boolean maxInclusive)
FieldType
SolrQueryParser
currently passes part1 and part2 as null if they are '*' respectively. minInclusive and maxInclusive are both true
currently by SolrQueryParser but that may change in the future. Also, other QueryParser implementations may have
different semantics.
Sub-classes should override this method to provide their own range query implementation. They should strive to
handle nulls in part1 and/or part2 as well as unequal minInclusive and maxInclusive parameters gracefully.getRangeQuery
in class FieldType
parser
- the QParser
calling the methodfield
- the schema fieldpart1
- the lower boundary of the range, nulls are allowed.part2
- the upper boundary of the range, nulls are allowedminInclusive
- whether the minimum of the range is inclusive or notmaxInclusive
- whether the maximum of the range is inclusive or notpublic Query getFieldQuery(QParser parser, SchemaField field, String externalVal)
AbstractSubTypeFieldType
getFieldQuery
in class AbstractSubTypeFieldType
parser
- The QParser
calling the methodfield
- The SchemaField
of the field to searchexternalVal
- The String representation of the value to searchQuery
instance. This implementation returns a TermQuery
but overriding queries may notpublic Query createSpatialQuery(QParser parser, SpatialOptions options)
createSpatialQuery
in interface SpatialQueryable
parser
- The parseroptions
- The SpatialOptions
for this filter.public static double[] vectorBoxCorner(double[] center, double[] result, double distance, boolean upperRight)
center
- The center pointresult
- Holds the result, potentially resizing if needed.distance
- The d from the center to the cornerupperRight
- If true, return the coords for the upper right corner, else return the lower left.public static String[] parseCommaSeparatedList(String externalVal, int dimension) throws SolrException
externalVal
- The value to parsedimension
- The expected number of values for the pointSolrException
- if the dimension specified does not match the number foundCopyright © 2000-2014 Apache Software Foundation. All Rights Reserved.