org.archive.wayback.resourceindex.cdx

Class CDXIndex

java.lang.Object

org.archive.wayback.util.flatfile.FlatFile

org.archive.wayback.resourceindex.cdx.CDXIndex

All Implemented Interfaces:

SearchResultSource

Direct Known Subclasses:

CDXFormatIndex

public class CDXIndex
extends FlatFile
implements SearchResultSource

Version:

$Date$, $Revision$

Author:

brad

Field Summary

Fields inherited from class org.archive.wayback.util.flatfile.FlatFile

file

Constructor Summary

Constructors

Constructor and Description
CDXIndex()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.archive.util.iterator.CloseableIterator<CaptureSearchResult>	adaptIterator(Iterator<String> itr)
void	cleanup(org.archive.util.iterator.CloseableIterator<CaptureSearchResult> c)
Iterator<CaptureSearchResult>	getClosestIterator(String prefix, Date wantDate)
org.archive.util.iterator.CloseableIterator<CaptureSearchResult>	getPrefixIterator(String prefix)
org.archive.util.iterator.CloseableIterator<CaptureSearchResult>	getPrefixReverseIterator(String prefix)
Iterator<CaptureSearchResult>	getUrlIterator(String prefix)
void	shutdown()

Methods inherited from class org.archive.wayback.util.flatfile.FlatFile

findKeyOffset, findKeyOffsetLT, getLastMatchOffset, getPath, getRecordIterator, getRecordIteratorLT, getReverseRecordIterator, getSequentialIterator, main, setPath, store

Methods inherited from class java.lang.Object

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

Constructor Detail

CDXIndex

public CDXIndex()

Method Detail

adaptIterator

protected org.archive.util.iterator.CloseableIterator<CaptureSearchResult> adaptIterator(Iterator<String> itr)
                                                                                  throws IOException

Throws:

IOException

getPrefixIterator

public org.archive.util.iterator.CloseableIterator<CaptureSearchResult> getPrefixIterator(String prefix)
                                                                                   throws ResourceIndexNotAvailableException

Specified by:

getPrefixIterator in interface SearchResultSource

Returns:

CleanableIterator that will return SearchResults beginning with prefix argument, with subsequent next() calls returning subsequent results.

Throws:

ResourceIndexNotAvailableException

getPrefixReverseIterator

public org.archive.util.iterator.CloseableIterator<CaptureSearchResult> getPrefixReverseIterator(String prefix)
                                                                                          throws ResourceIndexNotAvailableException

Specified by:

getPrefixReverseIterator in interface SearchResultSource

Returns:

CleanableIterator that will return SearchResults starting *before* prefix argument, with subsequent next() calls returning previous results.

Throws:

ResourceIndexNotAvailableException

getUrlIterator

public Iterator<CaptureSearchResult> getUrlIterator(String prefix)
                                             throws IOException

Parameters:

prefix -

Returns:

Iterator of CaptureSearchResult of records starting with prefix

Throws:

IOException

getClosestIterator

public Iterator<CaptureSearchResult> getClosestIterator(String prefix,
                                               Date wantDate)
                                                 throws IOException

Parameters:

prefix -

wantDate -

Returns:

Iterator of results in closest order to wantDate

Throws:

IOException

cleanup

public void cleanup(org.archive.util.iterator.CloseableIterator<CaptureSearchResult> c)
             throws IOException

Specified by:

cleanup in interface SearchResultSource

Throws:

IOException

shutdown

public void shutdown()
              throws IOException

Specified by:

shutdown in interface SearchResultSource

Throws:

IOException