|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.solr.schema.FieldProperties
org.apache.solr.schema.FieldType
org.apache.solr.schema.TextField
public class TextField
TextField is the basic type for configurable text analysis.
Analyzers for field types using this implementation should be defined in the schema.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.solr.schema.FieldType |
|---|
FieldType.DefaultAnalyzer |
| Field Summary | |
|---|---|
protected boolean |
autoGeneratePhraseQueries
|
protected Analyzer |
multiTermAnalyzer
Analyzer set by schema for text types to use when searching fields of this type, subclasses can set analyzer themselves or override getAnalyzer() This analyzer is used to process wildcard, prefix, regex and other multiterm queries. |
| Fields inherited from class org.apache.solr.schema.FieldType |
|---|
analyzer, args, falseProperties, log, POLY_FIELD_SEPARATOR, postingsFormat, queryAnalyzer, similarity, trueProperties, typeName |
| Fields inherited from class org.apache.solr.schema.FieldProperties |
|---|
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 Summary | |
|---|---|
TextField()
|
|
| Method Summary | |
|---|---|
static BytesRef |
analyzeMultiTerm(String field,
String part,
Analyzer analyzerIn)
|
boolean |
getAutoGeneratePhraseQueries()
|
Query |
getFieldQuery(QParser parser,
SchemaField field,
String externalVal)
Returns a Query instance for doing searches against a field. |
Analyzer |
getMultiTermAnalyzer()
Returns the Analyzer to be used when searching fields of this type when mult-term queries are specified. |
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 reverse)
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. |
void |
setAnalyzer(Analyzer analyzer)
Sets the Analyzer to be used when indexing fields of this type. |
void |
setMultiTermAnalyzer(Analyzer analyzer)
|
void |
setQueryAnalyzer(Analyzer analyzer)
Sets the Analyzer to be used when querying fields of this type. |
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 org.apache.solr.schema.FieldType |
|---|
checkSchemaField, createField, createField, createFields, getAnalyzer, getArg, getIndexOptions, getPostingsFormat, getQueryAnalyzer, getSimilarity, getStringSort, getTypeName, getValueSource, hasProperty, indexedToReadable, indexedToReadable, isMultiValued, isPolyField, isTokenized, multiValuedFieldCache, readableToIndexed, readableToIndexed, restrictProps, setSimilarity, storedToIndexed, storedToReadable, toExternal, toInternal, toObject, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected boolean autoGeneratePhraseQueries
protected Analyzer multiTermAnalyzer
getMultiTermAnalyzer(),
setMultiTermAnalyzer(org.apache.lucene.analysis.Analyzer)| Constructor Detail |
|---|
public TextField()
| Method Detail |
|---|
protected void init(IndexSchema schema,
Map<String,String> args)
FieldType
init in class FieldTypepublic Analyzer getMultiTermAnalyzer()
This method may be called many times, at any time.
FieldType.getAnalyzer()public void setMultiTermAnalyzer(Analyzer analyzer)
public boolean getAutoGeneratePhraseQueries()
public SortField getSortField(SchemaField field,
boolean reverse)
FieldType
getSortField in class FieldTypeSchemaField.checkSortability()
public void write(TextResponseWriter writer,
String name,
IndexableField f)
throws IOException
FieldType
write in class FieldTypeIOException
public Query getFieldQuery(QParser parser,
SchemaField field,
String externalVal)
FieldType
getFieldQuery in class FieldTypeparser - 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 not
public Object toObject(SchemaField sf,
BytesRef term)
toObject in class FieldTypepublic void setAnalyzer(Analyzer analyzer)
FieldTypeThe default implementation throws a SolrException. Subclasses that override this method need to ensure the behavior of the analyzer is consistent with the implementation of toInternal.
setAnalyzer in class FieldTypeFieldType.toInternal(java.lang.String),
FieldType.setQueryAnalyzer(org.apache.lucene.analysis.Analyzer),
FieldType.getAnalyzer()public void setQueryAnalyzer(Analyzer analyzer)
FieldTypeThe default implementation throws a SolrException. Subclasses that override this method need to ensure the behavior of the analyzer is consistent with the implementation of toInternal.
setQueryAnalyzer in class FieldTypeFieldType.toInternal(java.lang.String),
FieldType.setAnalyzer(org.apache.lucene.analysis.Analyzer),
FieldType.getQueryAnalyzer()
public Query getRangeQuery(QParser parser,
SchemaField field,
String part1,
String part2,
boolean minInclusive,
boolean maxInclusive)
FieldTypeSolrQueryParser
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 FieldTypefield - 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 static BytesRef analyzeMultiTerm(String field,
String part,
Analyzer analyzerIn)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||