org.apache.maven.index.updater

Class IndexDataReader

java.lang.Object

org.apache.maven.index.updater.IndexDataReader

public class IndexDataReader
extends java.lang.Object

An index data reader used to parse transfer index format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexDataReader.IndexDataReadResult An index data read result holder
static interface	IndexDataReader.IndexDataReadVisitor Visitor of indexed Lucene documents.

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.DataInputStream	dis

Constructor Summary

Constructors

Constructor and Description
IndexDataReader(java.io.InputStream is)

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.document.Document	readDocument()
private org.apache.lucene.document.Field	readField()
long	readHeader()
IndexDataReader.IndexDataReadResult	readIndex(IndexDataReader.IndexDataReadVisitor visitor, IndexingContext context) Reads index content by using a visitor.
IndexDataReader.IndexDataReadResult	readIndex(org.apache.lucene.index.IndexWriter w, IndexingContext context)
private static java.lang.String	readUTF(java.io.DataInput in)

Methods inherited from class java.lang.Object

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

Field Detail

dis

private final java.io.DataInputStream dis

Constructor Detail

IndexDataReader

public IndexDataReader(java.io.InputStream is)
                throws java.io.IOException

Throws:

java.io.IOException

Method Detail

readIndex

public IndexDataReader.IndexDataReadResult readIndex(org.apache.lucene.index.IndexWriter w,
                                                     IndexingContext context)
                                              throws java.io.IOException

Throws:

java.io.IOException

readHeader

public long readHeader()
                throws java.io.IOException

Throws:

java.io.IOException

readDocument

public org.apache.lucene.document.Document readDocument()
                                                 throws java.io.IOException

Throws:

java.io.IOException

readField

private org.apache.lucene.document.Field readField()
                                            throws java.io.IOException

Throws:

java.io.IOException

readUTF

private static java.lang.String readUTF(java.io.DataInput in)
                                 throws java.io.IOException

Throws:

java.io.IOException

readIndex

public IndexDataReader.IndexDataReadResult readIndex(IndexDataReader.IndexDataReadVisitor visitor,
                                                     IndexingContext context)
                                              throws java.io.IOException

Reads index content by using a visitor.
The visitor is called for each read documents after it has been populated with Lucene fields.

Parameters:

visitor - an index data visitor

context - indexing context

Returns:

statistics about read data

Throws:

java.io.IOException - in case of an IO exception during index file access