org.sindice.siren.index

Class DocsNodesAndPositionsEnum

java.lang.Object

org.sindice.siren.index.DocsNodesAndPositionsEnum

All Implemented Interfaces:

DocsAndNodesIterator, PositionsIterator

Direct Known Subclasses:

ConstrainedNodesEnum, MappingMultiDocsNodesAndPositionsEnum, MultiDocsNodesAndPositionsEnum

public abstract class DocsNodesAndPositionsEnum
extends Object
implements DocsAndNodesIterator, PositionsIterator

Iterates through documents, node frequencies, nodes, term frequencies and positions.

Field Summary

Fields inherited from interface org.sindice.siren.index.DocsAndNodesIterator

NO_MORE_DOC, NO_MORE_NOD

Fields inherited from interface org.sindice.siren.index.PositionsIterator

NO_MORE_POS

Constructor Summary

Constructors

Constructor and Description
DocsNodesAndPositionsEnum()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.lucene.util.AttributeSource	attributes() Returns the related attributes.
abstract int	nodeFreqInDoc() Returns node frequency in the current document.
abstract int	termFreqInNode() Returns term frequency in the current node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sindice.siren.index.DocsAndNodesIterator

doc, nextDocument, nextNode, node, skipTo

Methods inherited from interface org.sindice.siren.index.PositionsIterator

nextPosition, pos

Constructor Detail

DocsNodesAndPositionsEnum

public DocsNodesAndPositionsEnum()

Method Detail

attributes

public org.apache.lucene.util.AttributeSource attributes()

Returns the related attributes.

termFreqInNode

public abstract int termFreqInNode()
                            throws IOException

Returns term frequency in the current node. Do not call this before DocsAndNodesIterator.nextNode() is first called, nor after DocsAndNodesIterator.nextNode() returns false or DocsAndNodesIterator.node() returns DocsAndNodesIterator.NO_MORE_NOD.

Throws:

IOException

nodeFreqInDoc

public abstract int nodeFreqInDoc()
                           throws IOException

Returns node frequency in the current document. Do not call this before #nextDoc is first called, nor after #nextDoc returns false or DocsAndNodesIterator.doc() returns DocsAndNodesIterator.NO_MORE_DOC.

Throws:

IOException