lux.index.field

Class FieldDefinition

java.lang.Object

lux.index.field.FieldDefinition

Direct Known Subclasses:

AttributeQNameField, AttributeTextField, DocumentField, ElementQNameField, ElementTextField, IDField, PathField, PathOccurrenceField, PathValueField, QNameValueField, TinyBinaryField, URIField, XmlTextField, XPathField

public abstract class FieldDefinition
extends Object

represents a field in the index corresponding to some XML content. An XmlField has a name, which may be configured, but must remain the same for all uses of a single index. XmlField provides methods for retrieving Lucene field configuration, and for retrieving values from the XmlIndexer to be passed to Lucene. see IndexConfiguration for a list of current built-in fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldDefinition.Type Represents the type of data fed to the index for a given field.

Constructor Summary

Constructors

Constructor and Description
FieldDefinition(org.apache.lucene.analysis.Analyzer analyzer, org.apache.lucene.document.Field.Store isStored, FieldDefinition.Type type) creates a field definition without any special role
FieldDefinition(FieldRole role, org.apache.lucene.analysis.Analyzer analyzer, org.apache.lucene.document.Field.Store isStored, FieldDefinition.Type type) construct a field definition fulfilling a specific role known to the indexer and optimizer
FieldDefinition(FieldRole role, org.apache.lucene.analysis.Analyzer analyzer, org.apache.lucene.document.Field.Store isStored, FieldDefinition.Type type, boolean renameable) Represents a Solr/Lucene field

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.lucene.analysis.Analyzer	getAnalyzer()
FieldRole	getFieldRole()
Iterable<? extends org.apache.lucene.index.IndexableField>	getFieldValues(XmlIndexer indexer) Wraps the values as Field, which includes the values and the Lucene indexing options.
String	getName()
int	getSolrFieldProperties() Attempts to guess the Solr field properties (see FieldProperties) based on the available information.
FieldDefinition.Type	getType()
Iterable<?>	getValues(XmlIndexer indexer) The Solr XmlUpdateProcessor calls this.
boolean	isRenameable()
boolean	isSingleValued()
org.apache.lucene.document.Field.Store	isStored()
void	setAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)
void	setName(String luceneFieldName)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldDefinition

public FieldDefinition(FieldRole role,
               org.apache.lucene.analysis.Analyzer analyzer,
               org.apache.lucene.document.Field.Store isStored,
               FieldDefinition.Type type,
               boolean renameable)

Represents a Solr/Lucene field

Parameters:

role - the role of the field; may be null if the field has no special role.

analyzer - the analyzer associated with the field. This will be used to analyze string field values, and to analyze queries. If the field values are not strings (eg if they are a TokenStream), the analyzer is used only for queries.

isStored - whether the field values are to be stored

type - the type of the field values: STRING, TOKENS, INT.

renameable - whether the field is allowed to be renamed

FieldDefinition

public FieldDefinition(FieldRole role,
               org.apache.lucene.analysis.Analyzer analyzer,
               org.apache.lucene.document.Field.Store isStored,
               FieldDefinition.Type type)

construct a field definition fulfilling a specific role known to the indexer and optimizer

Parameters:

role - the role of the field

analyzer - the analyzer associated with the field. This will be used to analyze string field values, and to analyze queries.

isStored - whether the field values are to be stored

type - the type of the field values: STRING, TOKENS, INT.

FieldDefinition

public FieldDefinition(org.apache.lucene.analysis.Analyzer analyzer,
               org.apache.lucene.document.Field.Store isStored,
               FieldDefinition.Type type)

creates a field definition without any special role

Parameters:

analyzer -

isStored -

type -

Method Detail

isRenameable

public boolean isRenameable()

getFieldValues

public Iterable<? extends org.apache.lucene.index.IndexableField> getFieldValues(XmlIndexer indexer)

Wraps the values as Field, which includes the values and the Lucene indexing options. Subclasses must implement getValues() or override this method

Parameters:

indexer - the indexer that holds the field values

Returns:

the accumulated values of the field, as IndexableFields

getValues

public Iterable<?> getValues(XmlIndexer indexer)

The Solr XmlUpdateProcessor calls this. If it returns null, the caller should use the values from getFieldValues() instead.

Parameters:

indexer - the indexer that holds the field values

Returns:

the accumulated values of the field, as primitive objects (String or Integer). If

getType

public FieldDefinition.Type getType()

Returns:

The type of data stored in the field.

setAnalyzer

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

getAnalyzer

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

isStored

public org.apache.lucene.document.Field.Store isStored()

isSingleValued

public boolean isSingleValued()

getSolrFieldProperties

public int getSolrFieldProperties()

Attempts to guess the Solr field properties (see FieldProperties) based on the available information. Subclasses may need to override to get the correct behavior. Norms are omitted from all fields; all fields except uri are assumed to be multi-valued.

Returns:

the Solr field properties to use when creating a Solr Schema field dynamically

toString

public String toString()

Overrides:

toString in class Object

getFieldRole

public FieldRole getFieldRole()

Returns:

An immutable identifier for the field used to refer to it in code

getName

public String getName()

Returns:

The field name as it appears in queries, and in the index. Defaults to the FieldName. the XmlIndexer maintains a list of field names so that these intrinsic names can be overridden by configuration

setName

public void setName(String luceneFieldName)

Parameters:

luceneFieldName - the name of the Lucene field to associate with this definition

See Also:

getName()