public abstract class AbstractSpatialFieldType<T extends SpatialStrategy> extends FieldType implements SpatialQueryable
SpatialStrategy
.FieldType.DefaultAnalyzer
Modifier and Type | Field and Description |
---|---|
protected SpatialArgsParser |
argsParser |
protected com.spatial4j.core.context.SpatialContext |
ctx |
static String |
FILTER_PARAM
A local-param boolean that can be set to false to only return the
FunctionQuery (score), and thus not do filtering.
|
protected org.slf4j.Logger |
log |
static String |
SCORE_PARAM
A local-param with one of "none" (default), "distance", or "recipDistance".
|
ANALYZER, args, CHAR_FILTER, CHAR_FILTERS, CLASS_NAME, docValuesFormat, 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
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 |
---|
AbstractSpatialFieldType() |
Modifier and Type | Method and Description |
---|---|
Field |
createField(SchemaField field,
Object val,
float boost)
Used for adding a document when a field needs to be created from a
type and a string.
|
List<IndexableField> |
createFields(SchemaField field,
Object val,
float boost)
Given a
SchemaField , create one or more IndexableField instances |
Query |
createSpatialQuery(QParser parser,
SpatialOptions options)
Implemented for compatibility with geofilt & bbox query parsers:
SpatialQueryable . |
Query |
getFieldQuery(QParser parser,
SchemaField field,
String externalVal)
Returns a Query instance for doing searches against a field.
|
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.
|
T |
getStrategy(String fieldName)
Gets the cached strategy for this field, creating it if necessary
via
newSpatialStrategy(String) . |
ValueSource |
getValueSource(SchemaField field,
QParser parser)
called to get the default value source (normally, from the
Lucene FieldCache.)
|
protected ValueSource |
getValueSourceFromSpatialArgs(QParser parser,
SchemaField field,
SpatialArgs spatialArgs,
String score,
T strategy) |
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. |
protected SpatialArgsParser |
newSpatialArgsParser() |
protected abstract T |
newSpatialStrategy(String fieldName)
Called from
getStrategy(String) upon first use by fieldName. |
protected com.spatial4j.core.shape.Shape |
parseShape(String str) |
protected SpatialArgs |
parseSpatialArgs(String externalVal) |
protected String |
shapeToString(com.spatial4j.core.shape.Shape shape)
Returns a String version of a shape to be used for the stored value.
|
void |
write(TextResponseWriter writer,
String name,
IndexableField f)
calls back to TextResponseWriter to write the field value
|
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
public static final String SCORE_PARAM
public static final String FILTER_PARAM
protected final org.slf4j.Logger log
protected com.spatial4j.core.context.SpatialContext ctx
protected SpatialArgsParser argsParser
protected void init(IndexSchema schema, Map<String,String> args)
FieldType
protected SpatialArgsParser newSpatialArgsParser()
public final Field createField(SchemaField field, Object val, float boost)
FieldType
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.createField
in class FieldType
FieldType.toInternal(java.lang.String)
public List<IndexableField> createFields(SchemaField field, Object val, float boost)
FieldType
SchemaField
, create one or more IndexableField
instancescreateFields
in class FieldType
field
- the SchemaField
val
- The value to add to the fieldboost
- The boost to applyIndexableField
FieldType.createField(SchemaField, Object, float)
,
FieldType.isPolyField()
protected com.spatial4j.core.shape.Shape parseShape(String str)
protected String shapeToString(com.spatial4j.core.shape.Shape shape)
protected abstract T newSpatialStrategy(String fieldName)
getStrategy(String)
upon first use by fieldName. }public final 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 Query createSpatialQuery(QParser parser, SpatialOptions options)
SpatialQueryable
.createSpatialQuery
in interface SpatialQueryable
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 ValueSource getValueSource(SchemaField field, QParser parser)
FieldType
getValueSource
in class FieldType
public Query getFieldQuery(QParser parser, SchemaField field, String externalVal)
FieldType
getFieldQuery
in class FieldType
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 notprotected SpatialArgs parseSpatialArgs(String externalVal)
protected ValueSource getValueSourceFromSpatialArgs(QParser parser, SchemaField field, SpatialArgs spatialArgs, String score, T strategy)
public T getStrategy(String fieldName)
newSpatialStrategy(String)
.fieldName
- Mandatory reference to the field namepublic 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()
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.