org.apache.solr.schema
Class TextField

java.lang.Object
  org.apache.solr.schema.FieldProperties
      org.apache.solr.schema.FieldType
          org.apache.solr.schema.TextField

public class TextField
extends FieldType

TextField is the basic type for configurable text analysis. Analyzers for field types using this implementation should be defined in the schema.

Version:

$Id: TextField.java 1128859 2011-05-29 10:39:43Z mikemccand $

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.schema.FieldType

FieldType.DefaultAnalyzer

Field Summary

protected boolean

autoGeneratePhraseQueries

Fields inherited from class org.apache.solr.schema.FieldType

analyzer, args, falseProperties, log, POLY_FIELD_SEPARATOR, queryAnalyzer, 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

boolean	getAutoGeneratePhraseQueries()
org.apache.lucene.search.Query	getFieldQuery(QParser parser, SchemaField field, String externalVal) Returns a Query instance for doing searches against a field.
org.apache.lucene.search.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(org.apache.lucene.analysis.Analyzer analyzer) Sets the Analyzer to be used when indexing fields of this type.
void	setQueryAnalyzer(org.apache.lucene.analysis.Analyzer analyzer) Sets the Analyzer to be used when querying fields of this type.
void	write(TextResponseWriter writer, String name, org.apache.lucene.document.Fieldable f) calls back to TextResponseWriter to write the field value
void	write(XMLWriter xmlWriter, String name, org.apache.lucene.document.Fieldable f) Renders the specified field as XML

Methods inherited from class org.apache.solr.schema.FieldType

createField, createField, createFields, getAnalyzer, getArg, getFieldIndex, getFieldStore, getFieldTermVec, getIndexOptions, getQueryAnalyzer, getRangeQuery, getStringSort, getTypeName, getValueSource, getValueSource, hasProperty, indexedToReadable, isMultiValued, isPolyField, isTokenized, multiValuedFieldCache, readableToIndexed, restrictProps, 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

autoGeneratePhraseQueries

protected boolean autoGeneratePhraseQueries

Constructor Detail

TextField

public TextField()

Method Detail

init

protected void init(IndexSchema schema,
                    Map<String,String> args)

Description copied from class: FieldType

subclasses should initialize themselves with the args provided and remove valid arguments. leftover arguments will cause an exception. Common boolean properties have already been handled.

Overrides:

init in class FieldType

getAutoGeneratePhraseQueries

public boolean getAutoGeneratePhraseQueries()

getSortField

public org.apache.lucene.search.SortField getSortField(SchemaField field,
                                                       boolean reverse)

Description copied from class: FieldType

Returns the SortField instance that should be used to sort fields of this type.

Specified by:

getSortField in class FieldType

See Also:

SchemaField.checkSortability()

write

public void write(XMLWriter xmlWriter,
                  String name,
                  org.apache.lucene.document.Fieldable f)
           throws IOException

Description copied from class: FieldType

Renders the specified field as XML

Specified by:

write in class FieldType

Throws:

IOException

write

public void write(TextResponseWriter writer,
                  String name,
                  org.apache.lucene.document.Fieldable f)
           throws IOException

Description copied from class: FieldType

calls back to TextResponseWriter to write the field value

Specified by:

write in class FieldType

Throws:

IOException

getFieldQuery

public org.apache.lucene.search.Query getFieldQuery(QParser parser,
                                                    SchemaField field,
                                                    String externalVal)

Description copied from class: FieldType

Returns a Query instance for doing searches against a field.

Overrides:

getFieldQuery in class FieldType

Parameters:

parser - The QParser calling the method

field - The SchemaField of the field to search

externalVal - The String representation of the value to search

Returns:

The Query instance. This implementation returns a TermQuery but overriding queries may not

setAnalyzer

public void setAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)

Description copied from class: FieldType

Sets the Analyzer to be used when indexing fields of this type.

The 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.

Overrides:

setAnalyzer in class FieldType

See Also:

FieldType.toInternal(java.lang.String), FieldType.setQueryAnalyzer(org.apache.lucene.analysis.Analyzer), FieldType.getAnalyzer()

setQueryAnalyzer

public void setQueryAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)

Description copied from class: FieldType

Sets the Analyzer to be used when querying fields of this type.

The 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.

Overrides:

setQueryAnalyzer in class FieldType

See Also:

FieldType.toInternal(java.lang.String), FieldType.setAnalyzer(org.apache.lucene.analysis.Analyzer), FieldType.getQueryAnalyzer()