org.mmbase.module.lucene

Class MMBaseIndexDefinition

java.lang.Object

org.mmbase.bridge.util.xml.query.QueryDefinition

org.mmbase.module.lucene.MMBaseIndexDefinition

All Implemented Interfaces:

IndexDefinition

class MMBaseIndexDefinition
extends QueryDefinition
implements IndexDefinition

An MMBase Lucene Index is configured by an MMBase Queries and 'subqueries' thereof. Also its fields can have extra attributes specific to Lucene searching.

Version:

$Id$

Author:

Pierre van Rooden

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.lucene.analysis.Analyzer	analyzer
protected String	id
protected List<String>	identifierFields
static int	MAX_NODES_IN_QUERY The default maximum number of nodes that are returned by a call to the searchqueryhandler.
protected int	maxNodesInQuery The maximum number of nodes that are returned by a call to the searchqueryhandler.
protected List<IndexDefinition>	subQueries Subqueries for this index.

Fields inherited from class org.mmbase.bridge.util.xml.query.QueryDefinition

elementManager, elementStep, fields, isMultiLevel, query

Constructor Summary

Constructors

Constructor and Description
MMBaseIndexDefinition()

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.analysis.Analyzer	getAnalyzer() Per index a an Analyzer can be defined.
CloseableIterator<MMBaseEntry>	getCursor() Returns an Iterator over all IndexEntry's defined by this index.
protected CloseableIterator<MMBaseEntry>	getCursor(NodeIterator nodeIterator, Collection<? extends FieldDefinition> f) Converts an MMBase Node Iterator to an Iterator of IndexEntry-s.
String	getId()
List<String>	getIdentifierFields()
Node	getNode(Cloud userCloud, org.apache.lucene.document.Document doc) Defines how a Node for this index must be produced.
protected NodeIterator	getNodeIterator(String id) Creates an (Huge)NodeListIterator for this index definition
ChainedReleaseStrategy	getReleaseStrategy()
CloseableIterator<MMBaseEntry>	getSubCursor(String identifier) Returns an Iterator over all IndexEntry's defined by this index, restricted by a certain identifier.
boolean	inIndex(String identifier) Whether the object with given key would be included in this index
void	setAnalyzer(org.apache.lucene.analysis.Analyzer a)
void	setId(String i)
String	toString()

Methods inherited from class org.mmbase.bridge.util.xml.query.QueryDefinition

configure, getVariables, setVariables

Methods inherited from class java.lang.Object

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

Field Detail

MAX_NODES_IN_QUERY

public static final int MAX_NODES_IN_QUERY

The default maximum number of nodes that are returned by a call to the searchqueryhandler.

See Also:

Constant Field Values

maxNodesInQuery

protected int maxNodesInQuery

The maximum number of nodes that are returned by a call to the searchqueryhandler.

subQueries

protected final List<IndexDefinition> subQueries

Subqueries for this index. The subqueries are lists whose starting element is the element node from the current index result.

analyzer

protected org.apache.lucene.analysis.Analyzer analyzer

id

protected String id

identifierFields

protected final List<String> identifierFields

Constructor Detail

MMBaseIndexDefinition

MMBaseIndexDefinition()

Method Detail

getReleaseStrategy

public ChainedReleaseStrategy getReleaseStrategy()

setId

public void setId(String i)

Specified by:

setId in interface IndexDefinition

getId

public String getId()

Specified by:

getId in interface IndexDefinition

setAnalyzer

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

getAnalyzer

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

Description copied from interface: IndexDefinition

Per index a an Analyzer can be defined.

Specified by:

getAnalyzer in interface IndexDefinition

getNode

public Node getNode(Cloud userCloud,
                    org.apache.lucene.document.Document doc)

Description copied from interface: IndexDefinition

Defines how a Node for this index must be produced. For MMBase indices this is of course quite straight-forward, but other indices may create virtual nodes here.

Specified by:

getNode in interface IndexDefinition

getIdentifierFields

public List<String> getIdentifierFields()

inIndex

public boolean inIndex(String identifier)

Description copied from interface: IndexDefinition

Whether the object with given key would be included in this index

Specified by:

inIndex in interface IndexDefinition

getCursor

protected CloseableIterator<MMBaseEntry> getCursor(NodeIterator nodeIterator,
                                                   Collection<? extends FieldDefinition> f)

Converts an MMBase Node Iterator to an Iterator of IndexEntry-s.

getCursor

public CloseableIterator<MMBaseEntry> getCursor()

Description copied from interface: IndexDefinition

Returns an Iterator over all IndexEntry's defined by this index. Only makes sense if this is not a 'sub definition'.

Specified by:

getCursor in interface IndexDefinition

getSubCursor

public CloseableIterator<MMBaseEntry> getSubCursor(String identifier)

Description copied from interface: IndexDefinition

Returns an Iterator over all IndexEntry's defined by this index, restricted by a certain identifier. For a 'top' level index definition, this should normally return only one Entry, and the key must be the identifier of this entry. For 'nested' IndexDefinitions, the key most be the key of the parent.

Specified by:

getSubCursor in interface IndexDefinition

getNodeIterator

protected NodeIterator getNodeIterator(String id)

Creates an (Huge)NodeListIterator for this index definition

Parameters:

id - A node number. If used, the query will be limited. This is used to update the index on change of that node.

Returns:

the query result as a NodeIterator object

toString

public String toString()

Overrides:

toString in class QueryDefinition