|
|||||||||
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.CollationField
public class CollationField
Field for collated sort keys. These can be used for locale-sensitive sort and range queries.
This field can be created in two ways:
Using a System collator:
Using a Tailored ruleset:
Collator
,
Locale
,
RuleBasedCollator
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.solr.schema.FieldType |
---|
FieldType.DefaultAnalyzer |
Field Summary |
---|
Fields inherited from class org.apache.solr.schema.FieldType |
---|
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 | |
---|---|
CollationField()
|
Method Summary | |
---|---|
void |
checkSchemaField(SchemaField field)
Check's SchemaField instances constructed
using this field type to ensure that they are valid. |
List<IndexableField> |
createFields(SchemaField field,
Object value,
float boost)
Given a SchemaField , create one or more IndexableField instances |
Analyzer |
getAnalyzer()
Returns the Analyzer to be used when indexing fields of this type. |
Analyzer |
getQueryAnalyzer()
Returns the Analyzer to be used when searching fields of this type. |
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. |
protected void |
init(IndexSchema schema,
Map<String,String> args)
subclasses should initialize themselves with the args provided and remove valid arguments. |
Object |
marshalSortValue(Object value)
Convert a value used by the FieldComparator for this FieldType's SortField into a marshalable value for distributed sorting. |
Object |
unmarshalSortValue(Object value)
Convert a value marshaled via FieldType.marshalSortValue(java.lang.Object) back
into a value usable by the FieldComparator for this FieldType's SortField |
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 |
Constructor Detail |
---|
public CollationField()
Method Detail |
---|
protected void init(IndexSchema schema, Map<String,String> args)
FieldType
init
in class FieldType
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 Analyzer getAnalyzer()
FieldType
This method may be called many times, at any time.
getAnalyzer
in class FieldType
FieldType.getQueryAnalyzer()
public Analyzer getQueryAnalyzer()
FieldType
This method may be called many times, at any time.
getQueryAnalyzer
in class FieldType
FieldType.getAnalyzer()
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 not
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
public List<IndexableField> createFields(SchemaField field, Object value, float boost)
FieldType
SchemaField
, create one or more IndexableField
instances
createFields
in class FieldType
field
- the SchemaField
value
- The value to add to the fieldboost
- The boost to apply
IndexableField
FieldType.createField(SchemaField, Object, float)
,
FieldType.isPolyField()
public Object marshalSortValue(Object value)
FieldType
marshalSortValue
in class FieldType
public Object unmarshalSortValue(Object value)
FieldType
FieldType.marshalSortValue(java.lang.Object)
back
into a value usable by the FieldComparator for this FieldType's SortField
unmarshalSortValue
in class FieldType
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |