org.apache.solr.schema
Class BoolField

java.lang.Object
  org.apache.solr.schema.FieldType
      org.apache.solr.schema.BoolField

public class BoolField
extends FieldType

Version:

$Id: BoolField.java 555343 2007-07-11 17:46:25Z hossman $

Nested Class Summary

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

FieldType.DefaultAnalyzer

Field Summary

protected static org.apache.lucene.analysis.Analyzer	boolAnalyzer
protected static org.apache.lucene.analysis.Token	FALSE_TOKEN
protected static org.apache.lucene.analysis.Token	TRUE_TOKEN

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

analyzer, args, falseProperties, log, queryAnalyzer, trueProperties, typeName

Constructor Summary

BoolField()

Method Summary

org.apache.lucene.analysis.Analyzer	getAnalyzer() Returns the Analyzer to be used when indexing fields of this type.
org.apache.lucene.analysis.Analyzer	getQueryAnalyzer() Returns the Analyzer to be used when searching fields of this type.
org.apache.lucene.search.SortField	getSortField(SchemaField field, boolean reverse) Returns the SortField instance that should be used to sort fields of this type.
ValueSource	getValueSource(SchemaField field)
String	indexedToReadable(String indexedForm) :TODO: document this method
protected void	init(IndexSchema schema, Map<String,String> args) subclasses should initialize themselves with the args provided and remove valid arguments.
String	toExternal(org.apache.lucene.document.Fieldable 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.
Boolean	toObject(org.apache.lucene.document.Fieldable f) Convert the stored-field format to an external object.
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, getArg, getFieldIndex, getFieldStore, getFieldTermVec, getStringSort, getTypeName, getValueSource, isTokenized, restrictProps, setAnalyzer, setQueryAnalyzer, storedToIndexed, storedToReadable, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TRUE_TOKEN

protected static final org.apache.lucene.analysis.Token TRUE_TOKEN

FALSE_TOKEN

protected static final org.apache.lucene.analysis.Token FALSE_TOKEN

boolAnalyzer

protected static final org.apache.lucene.analysis.Analyzer boolAnalyzer

Constructor Detail

BoolField

public BoolField()

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

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

getValueSource

public ValueSource getValueSource(SchemaField field)

Overrides:

getValueSource in class FieldType

getAnalyzer

public org.apache.lucene.analysis.Analyzer getAnalyzer()

Description copied from class: FieldType

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

This method may be called many times, at any time.

Overrides:

getAnalyzer in class FieldType

See Also:

FieldType.getQueryAnalyzer()

getQueryAnalyzer

public org.apache.lucene.analysis.Analyzer getQueryAnalyzer()

Description copied from class: FieldType

Returns the Analyzer to be used when searching fields of this type.

This method may be called many times, at any time.

Overrides:

getQueryAnalyzer in class FieldType

See Also:

FieldType.getAnalyzer()

toInternal

public String toInternal(String val)

Description copied from class: FieldType

Convert an external value (from XML update command or from query string) into the internal format.

Overrides:

toInternal in class FieldType

See Also:

FieldType.toExternal(org.apache.lucene.document.Fieldable)

toExternal

public String toExternal(org.apache.lucene.document.Fieldable f)

Description copied from class: FieldType

Convert the stored-field format to an external (string, human readable) value

Overrides:

toExternal in class FieldType

See Also:

FieldType.toInternal(java.lang.String)

toObject

public Boolean toObject(org.apache.lucene.document.Fieldable f)

Description copied from class: FieldType

Convert the stored-field format to an external object.

Overrides:

toObject in class FieldType

See Also:

FieldType.toInternal(java.lang.String)

indexedToReadable

public String indexedToReadable(String indexedForm)

Description copied from class: FieldType

:TODO: document this method

Overrides:

indexedToReadable in class FieldType

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