org.apache.solr.schema
Class PreAnalyzedField

java.lang.Object
  extended by org.apache.solr.schema.FieldProperties
      extended by org.apache.solr.schema.FieldType
          extended by org.apache.solr.schema.PreAnalyzedField

public class PreAnalyzedField
extends FieldType

Pre-analyzed field type provides a way to index a serialized token stream, optionally with an independent stored value of a field.


Nested Class Summary
static class PreAnalyzedField.ParseResult
          This is a simple holder of a stored part and the collected states (tokens with attributes).
static interface PreAnalyzedField.PreAnalyzedParser
          Parse the input and return the stored part and the tokens with attributes.
 
Nested classes/interfaces inherited from class org.apache.solr.schema.FieldType
FieldType.DefaultAnalyzer
 
Field Summary
static String PARSER_IMPL
          Init argument name.
 
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
PreAnalyzedField()
           
 
Method Summary
 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.
static FieldType createFieldType(SchemaField field)
          Utility method to create a FieldType based on the SchemaField
 IndexableField fromString(SchemaField field, String val, float boost)
           
 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.
 SortField getSortField(SchemaField field, boolean top)
          Returns the SortField instance that should be used to sort fields of this type.
 void init(IndexSchema schema, Map<String,String> args)
          subclasses should initialize themselves with the args provided and remove valid arguments.
 String toFormattedString(Field f)
          Utility method to convert a field to a string that is parse-able by this class.
 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, createFields, getAnalyzerProperties, getClassArg, getDocValuesFormat, getFieldQuery, getIndexOptions, getNamedPropertyValues, getNonFieldPropertyArgs, getNumericType, getPostingsFormat, getRangeQuery, getRewriteMethod, getSimilarity, getSimilarityFactory, getStringSort, getTypeName, getValueSource, hasProperty, indexedToReadable, indexedToReadable, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isPolyField, isTokenized, multiValuedFieldCache, readableToIndexed, readableToIndexed, restrictProps, setAnalyzer, setArgs, setIsExplicitAnalyzer, setIsExplicitQueryAnalyzer, setQueryAnalyzer, setSimilarity, storedToIndexed, storedToReadable, toExternal, toInternal, toObject, toObject, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PARSER_IMPL

public static final String PARSER_IMPL
Init argument name. Value is a fully-qualified class name of the parser that implements PreAnalyzedField.PreAnalyzedParser.

See Also:
Constant Field Values
Constructor Detail

PreAnalyzedField

public PreAnalyzedField()
Method Detail

init

public 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

getAnalyzer

public 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 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()

createField

public IndexableField createField(SchemaField field,
                                  Object value,
                                  float boost)
Description copied from class: FieldType
Used for adding a document when a field needs to be created from a type and a string.

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.

Overrides:
createField in class FieldType
See Also:
FieldType.toInternal(java.lang.String)

getSortField

public SortField getSortField(SchemaField field,
                              boolean top)
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(TextResponseWriter writer,
                  String name,
                  IndexableField 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

toFormattedString

public String toFormattedString(Field f)
                         throws IOException
Utility method to convert a field to a string that is parse-able by this class.

Parameters:
f - field to convert
Returns:
string that is compatible with the serialization format
Throws:
IOException - If there is a low-level I/O error.

createFieldType

public static FieldType createFieldType(SchemaField field)
Utility method to create a FieldType based on the SchemaField


fromString

public IndexableField fromString(SchemaField field,
                                 String val,
                                 float boost)
                          throws Exception
Throws:
Exception


Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.