org.archive.format.gzip.zipnum

Class ZipNumIndex

java.lang.Object

org.archive.format.gzip.zipnum.ZipNumIndex

All Implemented Interfaces:

CDXInputSource

Direct Known Subclasses:

ZipNumCluster

public class ZipNumIndex
extends java.lang.Object
implements CDXInputSource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZipNumIndex.PageResult

Field Summary

Fields

Modifier and Type	Field and Description
protected int	binsearchBlockSize
protected ZipNumBlockLoader	blockLoader
protected int	cdxLinesPerBlock
protected long	cdxLinesTotalCount
protected static boolean	DEFAULT_USE_NIO
protected java.lang.String	pathRoot
protected int	readaheadSize
protected boolean	required
protected SortedTextFile	summary
protected java.lang.String	summaryFile
protected boolean	useNio

Constructor Summary

Constructors

Constructor and Description
ZipNumIndex()

Method Summary

Modifier and Type	Method and Description
static ZipNumIndex	createIndexWithBasePath(java.lang.String pathRoot)
static ZipNumIndex	createIndexWithSummaryPath(java.lang.String summaryFile)
static java.lang.String	endKey(java.lang.String key)
static int	extractLineCount(java.lang.String line)
protected static long	extractLongField(java.lang.String line, int index)
int	getBinsearchBlockSize()
ZipNumBlockLoader	getBlockLoader()
CloseableIterator<java.lang.String>	getCDXIterator(CloseableIterator<java.lang.String> summaryIterator)
CloseableIterator<java.lang.String>	getCDXIterator(CloseableIterator<java.lang.String> summaryIterator, java.lang.String start, java.lang.String end, int split, int numSplits)
CloseableIterator<java.lang.String>	getCDXIterator(CloseableIterator<java.lang.String> summaryIterator, java.lang.String start, java.lang.String end, int split, int numSplits, ZipNumParams params)
CloseableIterator<java.lang.String>	getCDXIterator(CloseableIterator<java.lang.String> summaryIterator, ZipNumParams params)
CloseableIterator<java.lang.String>	getCDXIterator(java.lang.String key, java.lang.String start, boolean exact, ZipNumParams params)
CloseableIterator<java.lang.String>	getCDXIterator(java.lang.String key, java.lang.String start, java.lang.String end, ZipNumParams params)
CloseableIterator<java.lang.String>	getCDXIterator(java.lang.String key, ZipNumParams params)
int	getCdxLinesPerBlock()
CloseableIterator<java.lang.String>	getClusterRange(java.lang.String start, java.lang.String end, boolean inclusive, boolean includePrevLine)
long	getEstimateSplitSize(java.lang.String[] blocks)
CloseableIterator<java.lang.String>	getLastBlockCDXLineIterator(java.lang.String key)
java.lang.String	getNthLine(java.lang.String lineNumber, int lineField)
ZipNumIndex.PageResult	getNthPage(java.lang.String[] startEnd, int page, int pageSize, boolean numPagesOnly)
int	getNumLines(java.lang.String[] blocks)
int	getNumLines(java.lang.String start, java.lang.String end)
java.lang.String	getPathRoot()
int	getReadaheadSize()
SortedTextFile	getSummary()
java.lang.String	getSummaryFile()
long	getTotalLength(java.lang.String[] blocks)
long	getTotalLines()
void	init()
boolean	isRequired()
boolean	isUseNio()
void	setBinsearchBlockSize(int binsearchBlockSize)
void	setBlockLoader(ZipNumBlockLoader blockLoader)
void	setCdxLinesPerBlock(int cdxLinesPerBlock)
void	setPathRoot(java.lang.String pathRoot)
void	setReadaheadSize(int readaheadSize)
void	setRequired(boolean required)
void	setSummaryFile(java.lang.String summaryFile)
void	setUseNio(boolean useNio)
static CloseableIterator<java.lang.String>	wrapEndIterator(CloseableIterator<java.lang.String> iter, java.lang.String end, boolean inclusive)
static CloseableIterator<java.lang.String>	wrapPrefix(CloseableIterator<java.lang.String> source, java.lang.String prefix, boolean exact)
static CloseableIterator<java.lang.String>	wrapReverseIterator(CloseableIterator<java.lang.String> iter, java.lang.String start, java.lang.String end)
static CloseableIterator<java.lang.String>	wrapStartEndIterator(CloseableIterator<java.lang.String> iter, java.lang.String start, java.lang.String end, boolean inclusive)
static CloseableIterator<java.lang.String>	wrapStartIterator(CloseableIterator<java.lang.String> iter, java.lang.String start)

Methods inherited from class java.lang.Object

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

Field Detail

pathRoot

protected java.lang.String pathRoot

summaryFile

protected java.lang.String summaryFile

binsearchBlockSize

protected int binsearchBlockSize

readaheadSize

protected int readaheadSize

summary

protected SortedTextFile summary

required

protected boolean required

blockLoader

protected ZipNumBlockLoader blockLoader

cdxLinesPerBlock

protected int cdxLinesPerBlock

cdxLinesTotalCount

protected long cdxLinesTotalCount

DEFAULT_USE_NIO

protected static final boolean DEFAULT_USE_NIO

See Also:

Constant Field Values

useNio

protected boolean useNio

Constructor Detail

ZipNumIndex

public ZipNumIndex()

Method Detail

init

public void init()
          throws java.io.IOException

Throws:

java.io.IOException

createIndexWithSummaryPath

public static ZipNumIndex createIndexWithSummaryPath(java.lang.String summaryFile)
                                              throws java.io.IOException

Throws:

java.io.IOException

createIndexWithBasePath

public static ZipNumIndex createIndexWithBasePath(java.lang.String pathRoot)
                                           throws java.io.IOException

Throws:

java.io.IOException

extractLineCount

public static int extractLineCount(java.lang.String line)

extractLongField

protected static long extractLongField(java.lang.String line,
                                       int index)

getNumLines

public int getNumLines(java.lang.String[] blocks)

getTotalLength

public long getTotalLength(java.lang.String[] blocks)

getNumLines

public int getNumLines(java.lang.String start,
                       java.lang.String end)
                throws java.io.IOException

Throws:

java.io.IOException

getNthPage

public ZipNumIndex.PageResult getNthPage(java.lang.String[] startEnd,
                                         int page,
                                         int pageSize,
                                         boolean numPagesOnly)
                                  throws java.io.IOException

Throws:

java.io.IOException

getNthLine

public java.lang.String getNthLine(java.lang.String lineNumber,
                                   int lineField)
                            throws java.io.IOException

Throws:

java.io.IOException

getEstimateSplitSize

public long getEstimateSplitSize(java.lang.String[] blocks)

getClusterRange

public CloseableIterator<java.lang.String> getClusterRange(java.lang.String start,
                                                           java.lang.String end,
                                                           boolean inclusive,
                                                           boolean includePrevLine)
                                                    throws java.io.IOException

Throws:

java.io.IOException

wrapStartEndIterator

public static CloseableIterator<java.lang.String> wrapStartEndIterator(CloseableIterator<java.lang.String> iter,
                                                                       java.lang.String start,
                                                                       java.lang.String end,
                                                                       boolean inclusive)

wrapReverseIterator

public static CloseableIterator<java.lang.String> wrapReverseIterator(CloseableIterator<java.lang.String> iter,
                                                                      java.lang.String start,
                                                                      java.lang.String end)

wrapStartIterator

public static CloseableIterator<java.lang.String> wrapStartIterator(CloseableIterator<java.lang.String> iter,
                                                                    java.lang.String start)

wrapEndIterator

public static CloseableIterator<java.lang.String> wrapEndIterator(CloseableIterator<java.lang.String> iter,
                                                                  java.lang.String end,
                                                                  boolean inclusive)

getCDXIterator

public CloseableIterator<java.lang.String> getCDXIterator(CloseableIterator<java.lang.String> summaryIterator,
                                                          java.lang.String start,
                                                          java.lang.String end,
                                                          int split,
                                                          int numSplits)

getCDXIterator

public CloseableIterator<java.lang.String> getCDXIterator(CloseableIterator<java.lang.String> summaryIterator,
                                                          java.lang.String start,
                                                          java.lang.String end,
                                                          int split,
                                                          int numSplits,
                                                          ZipNumParams params)

endKey

public static java.lang.String endKey(java.lang.String key)

getLastBlockCDXLineIterator

public CloseableIterator<java.lang.String> getLastBlockCDXLineIterator(java.lang.String key)
                                                                throws java.io.IOException

Throws:

java.io.IOException

wrapPrefix

public static CloseableIterator<java.lang.String> wrapPrefix(CloseableIterator<java.lang.String> source,
                                                             java.lang.String prefix,
                                                             boolean exact)

getCDXIterator

public CloseableIterator<java.lang.String> getCDXIterator(java.lang.String key,
                                                          java.lang.String start,
                                                          java.lang.String end,
                                                          ZipNumParams params)
                                                   throws java.io.IOException

Specified by:

getCDXIterator in interface CDXInputSource

Throws:

java.io.IOException

getCDXIterator

public CloseableIterator<java.lang.String> getCDXIterator(java.lang.String key,
                                                          java.lang.String start,
                                                          boolean exact,
                                                          ZipNumParams params)
                                                   throws java.io.IOException

Specified by:

getCDXIterator in interface CDXInputSource

Throws:

java.io.IOException

getCDXIterator

public CloseableIterator<java.lang.String> getCDXIterator(java.lang.String key,
                                                          ZipNumParams params)
                                                   throws java.io.IOException

Throws:

java.io.IOException

getCDXIterator

public CloseableIterator<java.lang.String> getCDXIterator(CloseableIterator<java.lang.String> summaryIterator,
                                                          ZipNumParams params)

getCDXIterator

public CloseableIterator<java.lang.String> getCDXIterator(CloseableIterator<java.lang.String> summaryIterator)

setSummaryFile

public void setSummaryFile(java.lang.String summaryFile)

getSummaryFile

public java.lang.String getSummaryFile()

getSummary

public SortedTextFile getSummary()

getBlockLoader

public ZipNumBlockLoader getBlockLoader()

getBinsearchBlockSize

public int getBinsearchBlockSize()

setBinsearchBlockSize

public void setBinsearchBlockSize(int binsearchBlockSize)

getReadaheadSize

public int getReadaheadSize()

setReadaheadSize

public void setReadaheadSize(int readaheadSize)

setBlockLoader

public void setBlockLoader(ZipNumBlockLoader blockLoader)

isUseNio

public boolean isUseNio()

setUseNio

public void setUseNio(boolean useNio)

getCdxLinesPerBlock

public int getCdxLinesPerBlock()

setCdxLinesPerBlock

public void setCdxLinesPerBlock(int cdxLinesPerBlock)

getPathRoot

public java.lang.String getPathRoot()

setPathRoot

public void setPathRoot(java.lang.String pathRoot)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

getTotalLines

public long getTotalLines()

Specified by:

getTotalLines in interface CDXInputSource