org.archive.format.cdx

Class CDXFile

java.lang.Object

org.archive.util.binsearch.SortedTextFile

org.archive.format.cdx.CDXFile

All Implemented Interfaces:

CDXInputSource

public class CDXFile
extends SortedTextFile
implements CDXInputSource

Nested Class Summary

Nested classes/interfaces inherited from class org.archive.util.binsearch.SortedTextFile

SortedTextFile.CachedStringIterator, SortedTextFile.DefaultComparator, SortedTextFile.NumericComparator

Field Summary

Fields inherited from class org.archive.util.binsearch.SortedTextFile

binsearchBlockSize, defaultComparator, factory, numericComparator

Constructor Summary

Constructors

Constructor and Description
CDXFile(SeekableLineReaderFactory factory)
CDXFile(java.lang.String uri)

Method Summary

Modifier and Type	Method and Description
static java.io.BufferedReader	createStreamingLineReader(java.lang.String uri, boolean gzipped)
static java.io.File	decodeGZToTemp(java.lang.String uriGZ)
CloseableIterator<java.lang.String>	getCDXIterator(java.lang.String key, java.lang.String prefix, boolean exact, ZipNumParams params)
CloseableIterator<java.lang.String>	getCDXIterator(java.lang.String key, java.lang.String start, java.lang.String end, ZipNumParams params)
long	getTotalLines()
static SeekableLineReaderFactory	getUriFactory(java.lang.String uri, boolean decodeToTemp)

Methods inherited from class org.archive.util.binsearch.SortedTextFile

binaryFindOffset, getBinsearchBlockSize, getLastLine, getNthSplit, getRange, getRecordIterator, getRecordIterator, getRecordIterator, getRecordIteratorLT, getSLR, getSplitIterator, getStartEndOffsets, reloadFactory, setBinsearchBlockSize, setFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

CDXFile

public CDXFile(java.lang.String uri)
        throws java.io.IOException

Throws:

java.io.IOException

CDXFile

public CDXFile(SeekableLineReaderFactory factory)

Method Detail

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 prefix,
                                                          boolean exact,
                                                          ZipNumParams params)
                                                   throws java.io.IOException

Specified by:

getCDXIterator in interface CDXInputSource

Throws:

java.io.IOException

getUriFactory

public static SeekableLineReaderFactory getUriFactory(java.lang.String uri,
                                                      boolean decodeToTemp)
                                               throws java.io.IOException

Throws:

java.io.IOException

decodeGZToTemp

public static java.io.File decodeGZToTemp(java.lang.String uriGZ)
                                   throws java.io.IOException

Throws:

java.io.IOException

createStreamingLineReader

public static java.io.BufferedReader createStreamingLineReader(java.lang.String uri,
                                                               boolean gzipped)
                                                        throws java.io.IOException

Throws:

java.io.IOException

getTotalLines

public long getTotalLines()

Specified by:

getTotalLines in interface CDXInputSource