org.apache.jackrabbit.core.query.lucene

Class NodeTraversingQueryHits

java.lang.Object

org.apache.jackrabbit.core.query.lucene.AbstractQueryHits

org.apache.jackrabbit.core.query.lucene.NodeTraversingQueryHits

All Implemented Interfaces:

CloseableHits, QueryHits

public class NodeTraversingQueryHits
extends AbstractQueryHits

NodeTraversingQueryHits implements query hits that traverse a node hierarchy.

Constructor Summary

Constructors

Constructor and Description
NodeTraversingQueryHits(javax.jcr.Node start, boolean includeStart) Creates query hits that consist of the nodes that are traversed from a given start node.
NodeTraversingQueryHits(javax.jcr.Node start, boolean includeStart, int maxDepth) Creates query hits that consist of the nodes that are traversed from a given start node.

Method Summary

Methods

Modifier and Type	Method and Description
ScoreNode	nextScoreNode() Returns the next score node in this QueryHits or null if there are no more score nodes.

Methods inherited from class org.apache.jackrabbit.core.query.lucene.AbstractQueryHits

close, getSize, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeTraversingQueryHits

public NodeTraversingQueryHits(javax.jcr.Node start,
                       boolean includeStart)

Creates query hits that consist of the nodes that are traversed from a given start node.

Parameters:

start - the start node of the traversal.

includeStart - whether to include the start node in the result.

NodeTraversingQueryHits

public NodeTraversingQueryHits(javax.jcr.Node start,
                       boolean includeStart,
                       int maxDepth)

Creates query hits that consist of the nodes that are traversed from a given start node.

Parameters:

start - the start node of the traversal.

includeStart - whether to include the start node in the result.

maxDepth - the maximum depth of nodes to traverse.

Method Detail

nextScoreNode

public ScoreNode nextScoreNode()
                        throws IOException

Returns the next score node in this QueryHits or null if there are no more score nodes.

Returns:

the next score node in this QueryHits.

Throws:

IOException - if an error occurs while reading from the index.