public class LatLonType extends AbstractSubTypeFieldType implements SpatialQueryable
FieldType.DefaultAnalyzer
Modifier and Type | Field and Description |
---|---|
protected static int |
LAT |
protected static int |
LONG |
dynFieldProps, schema, SUB_FIELD_SUFFIX, SUB_FIELD_TYPE, subType, suffix, suffixes
analyzer, args, falseProperties, log, POLY_FIELD_SEPARATOR, queryAnalyzer, trueProperties, typeName
BINARY, INDEXED, MULTIVALUED, OMIT_NORMS, OMIT_POSITIONS, OMIT_TF_POSITIONS, REQUIRED, SORT_MISSING_FIRST, SORT_MISSING_LAST, STORE_TERMOFFSETS, STORE_TERMPOSITIONS, STORE_TERMVECTORS, STORED, TOKENIZED
Constructor and Description |
---|
LatLonType() |
Modifier and Type | Method and Description |
---|---|
Fieldable |
createField(SchemaField field,
String externalVal,
float boost)
Used for adding a document when a field needs to be created from a
type and a string.
|
Fieldable[] |
createFields(SchemaField field,
String externalVal,
float boost)
Given a
SchemaField , create one or more Fieldable instances |
Query |
createSpatialQuery(QParser parser,
SpatialOptions options) |
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 Fieldable instance for a single value, via the
FieldType.createFields(org.apache.solr.schema.SchemaField, String, float) method. |
void |
write(TextResponseWriter writer,
String name,
Fieldable f)
calls back to TextResponseWriter to write the field value
|
void |
write(XMLWriter xmlWriter,
String name,
Fieldable f)
Renders the specified field as XML
|
createSuffixCache, getSubType, inform, subField
createField, getAnalyzer, getArg, getFieldIndex, getFieldStore, getFieldTermVec, getIndexOptions, getQueryAnalyzer, getStringSort, getTypeName, getValueSource, hasProperty, indexedToReadable, isMultiValued, isTokenized, multiValuedFieldCache, readableToIndexed, restrictProps, setAnalyzer, setQueryAnalyzer, storedToIndexed, storedToReadable, toExternal, toInternal, toObject, toString
protected static final int LAT
protected static final int LONG
protected void init(IndexSchema schema, Map<String,String> args)
FieldType
init
in class AbstractSubTypeFieldType
public Fieldable[] createFields(SchemaField field, String externalVal, float boost)
FieldType
SchemaField
, create one or more Fieldable
instancescreateFields
in class FieldType
field
- the SchemaField
externalVal
- The value to add to the fieldboost
- The boost to applyFieldable
FieldType.createField(SchemaField, String, float)
,
FieldType.isPolyField()
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
field
- 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 notSolrQueryParser.getRangeQuery(String, String, String, boolean)
public 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
public ValueSource getValueSource(SchemaField field, QParser parser)
FieldType
getValueSource
in class FieldType
public boolean isPolyField()
FieldType
FieldType.createFields(org.apache.solr.schema.SchemaField, String, 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, String, float)
method may return more than one fieldpublic void write(XMLWriter xmlWriter, String name, Fieldable f) throws IOException
FieldType
write
in class FieldType
IOException
public void write(TextResponseWriter writer, String name, Fieldable f) throws IOException
FieldType
write
in class FieldType
IOException
public SortField getSortField(SchemaField field, boolean top)
FieldType
getSortField
in class FieldType
SchemaField.checkSortability()
public Fieldable createField(SchemaField field, String externalVal, 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)