|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.solr.schema.FieldProperties org.apache.solr.schema.FieldType org.apache.solr.schema.PrimitiveFieldType org.apache.solr.schema.TrieField
public class TrieField
Provides field types to support for Lucene's IntField
, LongField
, FloatField
and
DoubleField
.
See NumericRangeQuery
for more details.
It supports integer, float, long, double and date types.
NumericRangeQuery
Nested Class Summary | |
---|---|
static class |
TrieField.TrieTypes
|
Nested classes/interfaces inherited from class org.apache.solr.schema.FieldType |
---|
FieldType.DefaultAnalyzer |
Field Summary | |
---|---|
static int |
DEFAULT_PRECISION_STEP
|
protected Object |
missingValue
|
protected int |
precisionStep
|
protected int |
precisionStepArg
|
protected TrieField.TrieTypes |
type
|
Fields inherited from class org.apache.solr.schema.FieldType |
---|
analyzer, 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, queryAnalyzer, similarity, SIMILARITY, similarityFactory, TOKENIZER, trueProperties, TYPE, TYPE_NAME, typeName |
Fields inherited from class org.apache.solr.schema.FieldProperties |
---|
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 Summary | |
---|---|
TrieField()
|
Method Summary | |
---|---|
void |
checkSchemaField(SchemaField field)
Check's SchemaField instances constructed
using this field type to ensure that they are valid. |
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. |
List<IndexableField> |
createFields(SchemaField sf,
Object value,
float boost)
Given a SchemaField , create one or more IndexableField instances |
Query |
getFieldQuery(QParser parser,
SchemaField field,
String externalVal)
Returns a Query instance for doing searches against a field. |
static String |
getMainValuePrefix(FieldType ft)
expert internal use, subject to change. |
FieldType.NumericType |
getNumericType()
Return the numeric type of this field, or null if this field is not a numeric field. |
int |
getPrecisionStep()
|
Query |
getRangeQuery(QParser parser,
SchemaField field,
String min,
String max,
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. |
TrieField.TrieTypes |
getType()
|
ValueSource |
getValueSource(SchemaField field,
QParser qparser)
called to get the default value source (normally, from the Lucene FieldCache.) |
CharsRef |
indexedToReadable(BytesRef indexedForm,
CharsRef charsRef)
Given an indexed term, append the human readable representation |
String |
indexedToReadable(String _indexedForm)
Given an indexed term, return the human readable representation |
protected void |
init(IndexSchema schema,
Map<String,String> args)
subclasses should initialize themselves with the args provided and remove valid arguments. |
boolean |
isTokenized()
Returns true if fields of this type should be tokenized |
boolean |
multiValuedFieldCache()
Returns true if a single field value of this type has multiple logical values for the purposes of faceting, sorting, etc. |
void |
readableToIndexed(CharSequence val,
BytesRef result)
Given the readable value, return the term value that will match it. |
String |
readableToIndexed(String val)
Given the readable value, return the term value that will match it. |
String |
storedToIndexed(IndexableField f)
Given the stored field, return the indexed form |
String |
storedToReadable(IndexableField f)
Given the stored field, return the human readable representation |
String |
toExternal(IndexableField f)
Convert the stored-field format to an external (string, human readable) value |
String |
toInternal(String val)
Convert an external value (from XML update command or from query string) into the internal format for both storing and indexing (which can be modified by any analyzers). |
Object |
toObject(IndexableField f)
Convert the stored-field format to an external object. |
Object |
toObject(SchemaField sf,
BytesRef term)
|
void |
write(TextResponseWriter writer,
String name,
IndexableField f)
calls back to TextResponseWriter to write the field value |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_PRECISION_STEP
protected int precisionStepArg
protected int precisionStep
protected TrieField.TrieTypes type
protected Object missingValue
Constructor Detail |
---|
public TrieField()
Method Detail |
---|
protected void init(IndexSchema schema, Map<String,String> args)
FieldType
init
in class PrimitiveFieldType
public Object toObject(IndexableField f)
FieldType
toObject
in class FieldType
FieldType.toInternal(java.lang.String)
public SortField getSortField(SchemaField field, boolean top)
FieldType
getSortField
in class FieldType
SchemaField.checkSortability()
public ValueSource getValueSource(SchemaField field, QParser qparser)
FieldType
getValueSource
in class FieldType
public void write(TextResponseWriter writer, String name, IndexableField f) throws IOException
FieldType
write
in class FieldType
IOException
public boolean isTokenized()
FieldType
isTokenized
in class FieldType
public boolean multiValuedFieldCache()
FieldType
multiValuedFieldCache
in class FieldType
public int getPrecisionStep()
public TrieField.TrieTypes getType()
public FieldType.NumericType getNumericType()
FieldType
getNumericType
in class FieldType
public Query getRangeQuery(QParser parser, SchemaField field, String min, String max, 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 fieldmin
- the lower boundary of the range, nulls are allowed.max
- 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 not
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 search
Query
instance. This implementation returns a TermQuery
but overriding queries may notpublic String storedToReadable(IndexableField f)
FieldType
storedToReadable
in class FieldType
public String readableToIndexed(String val)
FieldType
readableToIndexed
in class FieldType
public void readableToIndexed(CharSequence val, BytesRef result)
FieldType
readableToIndexed
in class FieldType
public String toInternal(String val)
FieldType
toInternal
in class FieldType
FieldType.toExternal(org.apache.lucene.index.IndexableField)
public String toExternal(IndexableField f)
FieldType
toExternal
in class FieldType
FieldType.toInternal(java.lang.String)
public String indexedToReadable(String _indexedForm)
FieldType
indexedToReadable
in class FieldType
public CharsRef indexedToReadable(BytesRef indexedForm, CharsRef charsRef)
FieldType
indexedToReadable
in class FieldType
public Object toObject(SchemaField sf, BytesRef term)
toObject
in class FieldType
public String storedToIndexed(IndexableField f)
FieldType
storedToIndexed
in class FieldType
public IndexableField createField(SchemaField field, Object value, 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 sf, Object value, float boost)
FieldType
SchemaField
, create one or more IndexableField
instances
createFields
in class FieldType
sf
- the SchemaField
value
- The value to add to the fieldboost
- The boost to apply
IndexableField
FieldType.createField(SchemaField, Object, float)
,
FieldType.isPolyField()
public static String getMainValuePrefix(FieldType ft)
public void checkSchemaField(SchemaField field)
FieldType
SchemaField
instances constructed
using this field type to ensure that they are valid.
This method is called by the SchemaField
constructor to
check that it's initialization does not violate any fundemental
requirements of the FieldType
. The default implementation
does nothing, but subclasses may chose to throw a SolrException
if invariants are violated by the SchemaField.
checkSchemaField
in class FieldType
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |