org.sindice.siren.solr.schema

Class SirenField

java.lang.Object

org.apache.solr.schema.FieldProperties

org.apache.solr.schema.FieldType

org.apache.solr.schema.TextField

org.sindice.siren.solr.schema.SirenField

All Implemented Interfaces:

org.apache.solr.schema.SchemaAware

public class SirenField
extends org.apache.solr.schema.TextField
implements org.apache.solr.schema.SchemaAware

SirenField is the basic type for configurable tree-based data analysis.

This field type relies on:

• an index analyzer configuration (no query analyzer is required)
• a datatype analyzers configuration using the parameter datatypeConfig

This field type enforces certain field properties by throwing a SolrException if the field type does not set properly the properties. By default all the properties are set properly, i.e., a user should not modify these properties. This field type enforces also the postingsFormat to Siren10Afor. The list of enforced field properties are:

• indexed = true
• tokenized = true
• omitNorm = true
• multiValued = false
• omitTermFreqAndPositions = false
• omitPositions = false
• termVectors = false

A SchemaField can overwrite these properties, however an exception will be thrown when converting it to a Lucene's FieldType in createField(SchemaField, Object, float).

This field type extends TextField to have the FieldProperties.OMIT_TF_POSITIONS set to false by default.

Nested Class Summary

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

org.apache.solr.schema.FieldType.DefaultAnalyzer

Field Summary

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

autoGeneratePhraseQueries, multiTermAnalyzer

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

Constructors

Constructor and Description
SirenField()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.lucene.index.IndexableField	createField(org.apache.solr.schema.SchemaField field, Object value, float boost)
protected org.apache.lucene.index.IndexableField	createField(String name, String val, org.apache.lucene.document.FieldType type, float boost)
boolean	getAutoGeneratePhraseQueries()
Map<String,Datatype>	getDatatypes()
org.apache.lucene.search.Query	getFieldQuery(org.apache.solr.search.QParser parser, org.apache.solr.schema.SchemaField field, String externalVal)
org.apache.lucene.analysis.Analyzer	getMultiTermAnalyzer()
org.apache.lucene.search.Query	getRangeQuery(org.apache.solr.search.QParser parser, org.apache.solr.schema.SchemaField field, String part1, String part2, boolean minInclusive, boolean maxInclusive)
org.apache.lucene.search.SortField	getSortField(org.apache.solr.schema.SchemaField field, boolean reverse)
void	inform(org.apache.solr.schema.IndexSchema schema) When index schema is informed, load the datatype config and append the SIREn's filters to the tokenizer chain.
protected void	init(org.apache.solr.schema.IndexSchema schema, Map<String,String> args)
void	setAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)
void	setQueryAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)
void	write(org.apache.solr.response.TextResponseWriter writer, String name, org.apache.lucene.index.IndexableField f)

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

analyzeMultiTerm, setMultiTermAnalyzer, toObject

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

checkSchemaField, 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

Constructor Detail

SirenField

public SirenField()

Method Detail

init

protected void init(org.apache.solr.schema.IndexSchema schema,
        Map<String,String> args)

Overrides:

init in class org.apache.solr.schema.TextField

createField

public org.apache.lucene.index.IndexableField createField(org.apache.solr.schema.SchemaField field,
                                                 Object value,
                                                 float boost)

Overrides:

createField in class org.apache.solr.schema.FieldType

createField

protected org.apache.lucene.index.IndexableField createField(String name,
                                                 String val,
                                                 org.apache.lucene.document.FieldType type,
                                                 float boost)

Overrides:

createField in class org.apache.solr.schema.FieldType

getSortField

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

Overrides:

getSortField in class org.apache.solr.schema.TextField

write

public void write(org.apache.solr.response.TextResponseWriter writer,
         String name,
         org.apache.lucene.index.IndexableField f)
           throws IOException

Overrides:

write in class org.apache.solr.schema.TextField

Throws:

IOException

getFieldQuery

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

Overrides:

getFieldQuery in class org.apache.solr.schema.TextField

getRangeQuery

public org.apache.lucene.search.Query getRangeQuery(org.apache.solr.search.QParser parser,
                                           org.apache.solr.schema.SchemaField field,
                                           String part1,
                                           String part2,
                                           boolean minInclusive,
                                           boolean maxInclusive)

Overrides:

getRangeQuery in class org.apache.solr.schema.TextField

getMultiTermAnalyzer

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

Overrides:

getMultiTermAnalyzer in class org.apache.solr.schema.TextField

getAutoGeneratePhraseQueries

public boolean getAutoGeneratePhraseQueries()

Overrides:

getAutoGeneratePhraseQueries in class org.apache.solr.schema.TextField

setAnalyzer

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

Overrides:

setAnalyzer in class org.apache.solr.schema.TextField

setQueryAnalyzer

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

Overrides:

setQueryAnalyzer in class org.apache.solr.schema.TextField

getDatatypes

public Map<String,Datatype> getDatatypes()

inform

public void inform(org.apache.solr.schema.IndexSchema schema)

When index schema is informed, load the datatype config and append the SIREn's filters to the tokenizer chain.

Specified by:

inform in interface org.apache.solr.schema.SchemaAware