Package org.sindice.siren.index

Abstraction over the encoding and decoding of the node-based inverted index data structure.

See: Description

Interface Summary

Interface	Description
DocsAndNodesIterator	Interface that defines methods to iterate over a set of increasing doc identifiers and node labels.
PositionsIterator	This interface defines methods to iterate over a set of increasing positions.

Class Summary

Class	Description
ConstrainedNodesEnum	Abstraction of a DocsNodesAndPositionsEnum that filters nodes that do not satisfy some constraints.
DocsNodesAndPositionsEnum	Iterates through documents, node frequencies, nodes, term frequencies and positions.
IntervalConstrainedNodesEnum	Implementation of ConstrainedNodesEnum to apply a level constraint and a stack of interval constraints over the retrieved node labels.
LevelConstrainedNodesEnum	Implementation of ConstrainedNodesEnum to apply a level constraint over the retrieved node labels.
MappingMultiDocsNodesAndPositionsEnum	Exposes SIREn API, merged from SIREn API of sub-segments, remapping docIDs (this is used for segment merging).
MultiDocsNodesAndPositionsEnum	Exposes SIREn API, merged from SIREn API of sub-segments.
SingleIntervalConstrainedNodesEnum	Implementation of ConstrainedNodesEnum to apply a level constraint and an interval constraint over the retrieved node labels.
SirenDocsEnum	This DocsAndPositionsEnum extension acts as a decorator over a DocsNodesAndPositionsEnum.

Package org.sindice.siren.index Description

Abstraction over the encoding and decoding of the node-based inverted index data structure.

Introduction

This package contains the low-level API for encoding and decoding node information from the inverted index data structure. For an introduction to Lucene's index API, see the org.apache.lucene.index package documentation.

Overview of the API

This package defines the interface DocsNodesAndPositionsEnum to iterates over the list of document identifiers, node frequencies, node labels, term frequencies and term positions for a term.

It also provides a number of extensions that are used:

• to filter entries based on node constraints (level or interval constraints);
• to iterate over multiple segments during query processing or merging.

The SIREn's index API is composed of two sub-packages:

• org.sindice.siren.index.codecs.block defines the abstract API for encoding and decoding block-based posting formats.
• org.sindice.siren.index.codecs.siren10 contains the implementation of the SIREn block-based posting format.