org.apache.jackrabbit.core.query.lucene
Interface AggregateRule

public interface AggregateRule

AggregateRule defines a configuration for a node index aggregate. It defines rules for items that should be included in the node scope index of an ancestor. Per default the values of properties are only added to the node scope index of the parent node.

Method Summary

NodeState[]	getAggregatedNodeStates(NodeState nodeState) Returns the node states that are part of the indexing aggregate of the nodeState.
PropertyState[]	getAggregatedPropertyStates(NodeState nodeState) Returns the property states that are part of the indexing aggregate of the nodeState.
NodeState	getAggregateRoot(NodeState nodeState) Returns root node state for the indexing aggregate where nodeState belongs to.
long	getRecursiveAggregationLimit() recursive aggregation (for same type nodes) limit.

Method Detail

getAggregateRoot

NodeState getAggregateRoot(NodeState nodeState)
                           throws ItemStateException,
                                  RepositoryException

Returns root node state for the indexing aggregate where nodeState belongs to.

Parameters:

nodeState -

Returns:

the root node state of the indexing aggregate or null if nodeState does not belong to an indexing aggregate.

Throws:

ItemStateException - if an error occurs.

RepositoryException - if an error occurs.

getRecursiveAggregationLimit

long getRecursiveAggregationLimit()

recursive aggregation (for same type nodes) limit. embedded aggregation of nodes that have the same type can go only this levels up. A value eq to 0 gives unlimited aggregation.

getAggregatedNodeStates

NodeState[] getAggregatedNodeStates(NodeState nodeState)
                                    throws ItemStateException

Returns the node states that are part of the indexing aggregate of the nodeState.

Parameters:

nodeState - a node state

Returns:

the node states that are part of the indexing aggregate of nodeState. Returns null if this aggregate does not apply to nodeState.

Throws:

ItemStateException - if an error occurs.

getAggregatedPropertyStates

PropertyState[] getAggregatedPropertyStates(NodeState nodeState)
                                            throws ItemStateException

Returns the property states that are part of the indexing aggregate of the nodeState.

Parameters:

nodeState - a node state

Returns:

the property states that are part of the indexing aggregate of nodeState. Returns null if this aggregate does not apply to nodeState.

Throws:

ItemStateException - if an error occurs.