lux.index

Class IndexConfiguration

java.lang.Object

lux.index.IndexConfiguration

public class IndexConfiguration
extends Object

Maintains a list of field definitions and index options that inform indexing and search. The configuration options and core indexing setup are immutable, but new fields may be added, fields may be renamed, and namespace mappings may be defined.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUILD_DOCUMENT causes a document node to be built during indexing.
static int	COMPUTE_OFFSETS enables the computation and storage of term offsets in the index.
static int	DEFAULT_OPTIONS the default indexing options
static int	INDEX_EACH_PATH experimental: index each occurrence of each path as an unparsed string, rather than indexing unique paths and tokenizing
static int	INDEX_FULLTEXT enables the lux_text, lux_elt_text, and lux_att_text fields, causing element and attribute text to be indexed.
static int	INDEX_PATHS enables the lux_path field, causing element and attribute QName paths to be indexed.
static int	INDEX_QNAMES enables the lux_elt_name and lux_att_name fields, causing element and attribute QNames to be indexed.
static int	INDEX_VALUES enables the lux_path_value field (if INDEX_PATHS is set), and the lux_qname_value field (if INDEX_QNAMES is set), causing values to be indexed.
static int	INDEXES mask covering all of the indexing options
static org.apache.lucene.util.Version	LUCENE_VERSION
static int	NAMESPACE_AWARE causes QNames indexes to include the full namespace uri.
static int	SOLR Configure for use in solr; eg TinyBinarySolrField instead of TinyBinaryField
static int	STORE_DOCUMENT causes a document to be stored in the index.
static int	STORE_TINY_BINARY indicates that documents are to be stored in TinyBinary format.
static int	STRIP_NAMESPACES causes all namespace information to be stripped from incoming documents
FieldDefinition	URI unique identifier field that identifies a document

Constructor Summary

Constructors

Constructor and Description
IndexConfiguration()
IndexConfiguration(long options)

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(FieldDefinition field) adds a new field
void	configureElementVisibility(XmlTokenStreamBase tokens)
void	defineNamespaceMapping(String prefix, String namespaceURI)
String	getAttributeTextFieldName()
String	getDefaultFieldName()
ElementVisibility	getDefaultVisibility()
String	getElementTextFieldName()
ElementVisibility	getElementVisibility(String clarkName)
FieldDefinition	getField(FieldRole fieldName)
FieldDefinition	getField(String fieldName)
MultiFieldAnalyzer	getFieldAnalyzers()
String	getFieldName(FieldRole role) Get the effective name of a field, given its canonical name.
Collection<FieldDefinition>	getFields()
Map<String,String>	getNamespaceMap()
String	getTextFieldName()
String	getUriFieldName()
String	getXmlFieldName()
boolean	isIndexingEnabled()
boolean	isOption(int option)
void	renameField(FieldDefinition field, String name) rename an existing field; the new name is used in the index.
void	setElementVisibility(String clarkName, ElementVisibility vis) sets the visibility of elements with the given name

Methods inherited from class java.lang.Object

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

Field Detail

LUCENE_VERSION

public static final org.apache.lucene.util.Version LUCENE_VERSION

BUILD_DOCUMENT

public static final int BUILD_DOCUMENT

causes a document node to be built during indexing. Must be set if any XPathFields are to be defined.

See Also:

Constant Field Values

SOLR

public static final int SOLR

Configure for use in solr; eg TinyBinarySolrField instead of TinyBinaryField

See Also:

Constant Field Values

NAMESPACE_AWARE

public static final int NAMESPACE_AWARE

causes QNames indexes to include the full namespace uri. If not set, QNames are indexed lexically, as {prefix}:{localname} without regard for any prefix mappings. Currently namespace-unaware indexing and search is not fully supported.

See Also:

Constant Field Values

STORE_DOCUMENT

public static final int STORE_DOCUMENT

causes a document to be stored in the index. This should generally always be enabled

See Also:

Constant Field Values

STORE_TINY_BINARY

public static final int STORE_TINY_BINARY

indicates that documents are to be stored in TinyBinary format. If this is not set, documents are stored as serialized XML.

See Also:

Constant Field Values

INDEX_QNAMES

public static final int INDEX_QNAMES

enables the lux_elt_name and lux_att_name fields, causing element and attribute QNames to be indexed. If paths are indexed, this isn't really needed.

See Also:

Constant Field Values

INDEX_PATHS

public static final int INDEX_PATHS

enables the lux_path field, causing element and attribute QName paths to be indexed.

See Also:

Constant Field Values

INDEX_FULLTEXT

public static final int INDEX_FULLTEXT

enables the lux_text, lux_elt_text, and lux_att_text fields, causing element and attribute text to be indexed.

See Also:

Constant Field Values

INDEX_VALUES

public static final int INDEX_VALUES

enables the lux_path_value field (if INDEX_PATHS is set), and the lux_qname_value field (if INDEX_QNAMES is set), causing values to be indexed. This is an experimental feature that is not fully supported.

See Also:

Constant Field Values

COMPUTE_OFFSETS

public static final int COMPUTE_OFFSETS

enables the computation and storage of term offsets in the index. Currently there is no reason to enable this flag. In the future term offsets may be used to accelerate highlighting.

See Also:

Constant Field Values

STRIP_NAMESPACES

public static final int STRIP_NAMESPACES

causes all namespace information to be stripped from incoming documents

See Also:

Constant Field Values

INDEX_EACH_PATH

public static final int INDEX_EACH_PATH

experimental: index each occurrence of each path as an unparsed string, rather than indexing unique paths and tokenizing

See Also:

Constant Field Values

INDEXES

public static final int INDEXES

mask covering all of the indexing options

See Also:

Constant Field Values

DEFAULT_OPTIONS

public static final int DEFAULT_OPTIONS

the default indexing options

See Also:

Constant Field Values

URI

public final FieldDefinition URI

unique identifier field that identifies a document

Constructor Detail

IndexConfiguration

public IndexConfiguration(long options)

IndexConfiguration

public IndexConfiguration()

Method Detail

getFieldAnalyzers

public MultiFieldAnalyzer getFieldAnalyzers()

Returns:

the analyzers associated with the fields to be indexed

addField

public void addField(FieldDefinition field)

adds a new field

Parameters:

field - the field to add

getFieldName

public String getFieldName(FieldRole role)

Get the effective name of a field, given its canonical name. Fields may be renamed, or aliased, for compatibility with existing schemas.

Parameters:

role -

Returns:

the effective name of the field

renameField

public void renameField(FieldDefinition field,
               String name)

rename an existing field; the new name is used in the index.

Parameters:

field - the definition of a field

name - the new name to use

getFields

public Collection<FieldDefinition> getFields()

Returns:

a list of all the fields whose values are to provided by this indexer.

getField

public FieldDefinition getField(FieldRole fieldName)

getField

public FieldDefinition getField(String fieldName)

getDefaultFieldName

public String getDefaultFieldName()

isOption

public boolean isOption(int option)

Parameters:

option - an option bit constant

Returns:

whether the option is set

isIndexingEnabled

public boolean isIndexingEnabled()

getNamespaceMap

public Map<String,String> getNamespaceMap()

defineNamespaceMapping

public void defineNamespaceMapping(String prefix,
                          String namespaceURI)

getUriFieldName

public String getUriFieldName()

getXmlFieldName

public String getXmlFieldName()

getTextFieldName

public String getTextFieldName()

getElementTextFieldName

public String getElementTextFieldName()

getAttributeTextFieldName

public String getAttributeTextFieldName()

getElementVisibility

public ElementVisibility getElementVisibility(String clarkName)

Parameters:

clarkName - the name of an element in clark-notation: {namespace}local-name, or simply local-name if the element name is in no namespace.

Returns:

the explicitly-specified visibility of the element name, or null if the element has the default visibility.

setElementVisibility

public void setElementVisibility(String clarkName,
                        ElementVisibility vis)

sets the visibility of elements with the given name

Parameters:

clarkName - the name of an element in clark-notation: {namespace}local-name, or simply local-name if the element name is in no namespace.

vis - the visibility of the element's content from the perspective of containing elements. visibility.

getDefaultVisibility

public ElementVisibility getDefaultVisibility()

Returns:

the visibility of elements not explicitly specified using setElementVisibility. Always ElementVisibility.OPAQUE.

configureElementVisibility

public void configureElementVisibility(XmlTokenStreamBase tokens)