org.modeshape.jcr.index.lucene

Class LuceneIndex

java.lang.Object

org.modeshape.jcr.index.lucene.LuceneIndex

All Implemented Interfaces:

Costable, Filter, Lifecycle, ProvidedIndex<Object>, Reindexable

@ThreadSafe
 @Immutable
public abstract class LuceneIndex
extends Object
implements ProvidedIndex<Object>

Bases class for indexes stored in Lucene

Since:

4.5

Nested Class Summary

Nested classes/interfaces inherited from interface org.modeshape.jcr.spi.index.provider.Filter

Filter.Results

Field Summary

Fields

Modifier and Type	Field and Description
protected LuceneConfig	config
protected ExecutionContext	context
protected Logger	logger
protected String	name
protected Map<String,PropertyType>	propertyTypesByName
protected Searcher	searcher
protected StringFactory	stringFactory
protected org.apache.lucene.index.IndexWriter	writer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LuceneIndex(String name, String workspaceName, LuceneConfig config, Map<String,PropertyType> propertyTypesByName, ExecutionContext context)

Method Summary

Modifier and Type	Method and Description
void	add(String nodeKey, String propertyName, Object value) Adds a single value to this index for the given node.
protected void	addBinaryField(String propertyName, Object value, List<org.apache.lucene.document.Field> fields)
protected void	addBooleanField(String propertyName, Boolean value, List<org.apache.lucene.document.Field> fields)
protected void	addDateField(String propertyName, DateTime value, List<org.apache.lucene.document.Field> fields)
protected void	addDecimalField(String propertyName, BigDecimal value, List<org.apache.lucene.document.Field> fields)
protected void	addDoubleField(String propertyName, Double value, List<org.apache.lucene.document.Field> fields)
protected void	addLongField(String propertyName, Long value, List<org.apache.lucene.document.Field> fields)
protected void	addProperty(String nodeKey, org.apache.lucene.document.Document document, String property, Object... values)
protected void	addStringField(String propertyName, String value, List<org.apache.lucene.document.Field> fields)
void	clearAllData() Remove all of the index entries from the index.
void	commit() Commits any potential changes made by the add/remove/update operations to this index.
long	estimateCardinality(List<Constraint> andedConstraints, Map<String,Object> variables) Compute the cost applying the given constraints joined together conceptually using AND.
long	estimateTotalCount() Get the estimated number of entries within this index.
Filter.Results	filter(IndexConstraints constraints) Return a Filter.Results instance from which ModeShape can obtain the nodes that satisfy the supplied constraints.
String	getName() Get the name of the index.
protected void	postCommit()
protected void	preCommit(Map<String,String> commitData)
protected abstract LuceneQueryFactory	queryFactory(Map<String,Object> variables)
void	remove(String nodeKey) Removes the given node from the index.
protected abstract void	remove(String nodeKey, String propertyName)
void	remove(String nodeKey, String propertyName, Object value) Removes a value for the given node from the index.
void	remove(String nodeKey, String propertyName, Object[] values) Removes multiple values from the index for the given node.
boolean	requiresReindexing() Return whether this index is newly created and requires reindexing, or false if the index already exists.
void	shutdown(boolean destroyed) Shut down this index and release all runtime resources.
protected List<org.apache.lucene.document.Field>	valuesToFields(String propertyName, Object... values)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.modeshape.jcr.spi.index.provider.ProvidedIndex

add

Field Detail

logger

protected final Logger logger

name

protected final String name

context

protected final ExecutionContext context

writer

protected final org.apache.lucene.index.IndexWriter writer

propertyTypesByName

protected final Map<String,PropertyType> propertyTypesByName

config

protected final LuceneConfig config

stringFactory

protected final StringFactory stringFactory

searcher

protected final Searcher searcher

Constructor Detail

LuceneIndex

protected LuceneIndex(String name,
                      String workspaceName,
                      LuceneConfig config,
                      Map<String,PropertyType> propertyTypesByName,
                      ExecutionContext context)

Method Detail

add

public void add(String nodeKey,
                String propertyName,
                Object value)

Description copied from interface: ProvidedIndex

Adds a single value to this index for the given node.

Specified by:

add in interface ProvidedIndex<Object>

Parameters:

nodeKey - a NodeKey instance, never null

propertyName - the name for which the value is removed, never null but certain providers may ignore the value. Most of the times this is the real JCR property name, but for some index types (e.g. node types index) this may be something else (e.g. the name of the index)

value - an Object instance, never null

remove

public void remove(String nodeKey)

Description copied from interface: ProvidedIndex

Removes the given node from the index.

Specified by:

remove in interface ProvidedIndex<Object>

Parameters:

nodeKey - a NodeKey instance, never null

remove

public void remove(String nodeKey,
                   String propertyName,
                   Object value)

Description copied from interface: ProvidedIndex

Removes a value for the given node from the index.

Specified by:

remove in interface ProvidedIndex<Object>

Parameters:

nodeKey - a NodeKey instance, never null

propertyName - the name for which the value is removed, never null but certain providers may ignore the value. Most of the times this is the real JCR property name, but for some index types (e.g. node types index) this may be something else (e.g. the name of the index)

value - the value to remove from the index for this node, never null

remove

public void remove(String nodeKey,
                   String propertyName,
                   Object[] values)

Description copied from interface: ProvidedIndex

Removes multiple values from the index for the given node.

Specified by:

remove in interface ProvidedIndex<Object>

Parameters:

nodeKey - a NodeKey instance, never null

propertyName - the name for which the value is removed, never null but certain providers may ignore the value. Most of the times this is the real JCR property name, but for some index types (e.g. node types index) this may be something else (e.g. the name of the index)

values - the values to remove, never null or empty

getName

public String getName()

Description copied from interface: ProvidedIndex

Get the name of the index.

Specified by:

getName in interface ProvidedIndex<Object>

Returns:

the index name; never null

estimateCardinality

public long estimateCardinality(List<Constraint> andedConstraints,
                                Map<String,Object> variables)

Description copied from interface: Costable

Compute the cost applying the given constraints joined together conceptually using AND.

Specified by:

estimateCardinality in interface Costable

Parameters:

andedConstraints - the constraints; never null

variables - the bound variables for the query that is being costed; never null

Returns:

the approximate number of records that will be returned

estimateTotalCount

public long estimateTotalCount()

Description copied from interface: Costable

Get the estimated number of entries within this index.

Specified by:

estimateTotalCount in interface Costable

Returns:

the number of entries, or -1 if not known

filter

public Filter.Results filter(IndexConstraints constraints)

Description copied from interface: Filter

Return a Filter.Results instance from which ModeShape can obtain the nodes that satisfy the supplied constraints. This method should return quickly, since no work (or at least very little work) should be done. All of the work should be performed when the Filter.Results.getNextBatch(ResultWriter, int) method is called on the results.

Specified by:

filter in interface Filter

Parameters:

constraints - the constraints to be applied by this index; never null

Returns:

the batched node keys; never null

requiresReindexing

public boolean requiresReindexing()

Description copied from interface: Reindexable

Return whether this index is newly created and requires reindexing, or false if the index already exists.

Specified by:

requiresReindexing in interface Reindexable

Returns:

true if the index is new and needs to be rebuilt, or false otherwise.

commit

public void commit()

Description copied from interface: ProvidedIndex

Commits any potential changes made by the add/remove/update operations to this index.

Specified by:

commit in interface ProvidedIndex<Object>

postCommit

protected void postCommit()

preCommit

protected void preCommit(Map<String,String> commitData)

shutdown

public void shutdown(boolean destroyed)

Description copied from interface: Lifecycle

Shut down this index and release all runtime resources. If destroyed is true, then this index has been removed from the repository and will not be reused; thus all persistent resources should also be released. If destroyed is false, then this repository is merely shutting down and the index's persistent resources should be kept so that they are available when the repository is restarted.

Specified by:

shutdown in interface Lifecycle

Parameters:

destroyed - true if this index is being permanently removed from the repository and all runtime and persistent resources can/should be released and cleaned up, or false if the repository is being shutdown and this index will be needed the next time the repository is started

clearAllData

public void clearAllData()

Description copied from interface: Reindexable

Remove all of the index entries from the index. This is typically called prior to reindexing.

Specified by:

clearAllData in interface Reindexable

addProperty

protected void addProperty(String nodeKey,
                           org.apache.lucene.document.Document document,
                           String property,
                           Object... values)

remove

protected abstract void remove(String nodeKey,
                               String propertyName)

queryFactory

protected abstract LuceneQueryFactory queryFactory(Map<String,Object> variables)

valuesToFields

protected List<org.apache.lucene.document.Field> valuesToFields(String propertyName,
                                                                Object... values)

addStringField

protected void addStringField(String propertyName,
                              String value,
                              List<org.apache.lucene.document.Field> fields)

addBooleanField

protected void addBooleanField(String propertyName,
                               Boolean value,
                               List<org.apache.lucene.document.Field> fields)

addDateField

protected void addDateField(String propertyName,
                            DateTime value,
                            List<org.apache.lucene.document.Field> fields)

addBinaryField

protected void addBinaryField(String propertyName,
                              Object value,
                              List<org.apache.lucene.document.Field> fields)

addDecimalField

protected void addDecimalField(String propertyName,
                               BigDecimal value,
                               List<org.apache.lucene.document.Field> fields)

addDoubleField

protected void addDoubleField(String propertyName,
                              Double value,
                              List<org.apache.lucene.document.Field> fields)

addLongField

protected void addLongField(String propertyName,
                            Long value,
                            List<org.apache.lucene.document.Field> fields)