org.netpreserve.logtrix

Class CrawlLogIterator

java.lang.Object

org.netpreserve.logtrix.CrawlLogIterator

All Implemented Interfaces:

AutoCloseable, Iterable<CrawlDataItem>, Iterator<CrawlDataItem>

public class CrawlLogIterator
extends Object
implements AutoCloseable, Iterable<CrawlDataItem>, Iterator<CrawlDataItem>

Constructor Summary

Constructors

Constructor and Description
CrawlLogIterator(InputStream stream)
CrawlLogIterator(Path path) Create a new CrawlLogIterator that reads items from a Heritrix crawl.log
CrawlLogIterator(Reader reader)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the crawl.log file.
boolean	hasNext() Returns true if there are more items available.
Iterator<CrawlDataItem>	iterator()
CrawlDataItem	next() Returns the next valid item from the crawl log.
protected CrawlDataItem	parseLine(String line) Parse the a line in the crawl log.
protected void	prepareNext() Ready the next item.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

CrawlLogIterator

public CrawlLogIterator(Path path)
                 throws IOException

Create a new CrawlLogIterator that reads items from a Heritrix crawl.log

Parameters:

path - The path of a Heritrix crawl.log file.

Throws:

IOException - If errors were found reading the log.

CrawlLogIterator

public CrawlLogIterator(Reader reader)

CrawlLogIterator

public CrawlLogIterator(InputStream stream)

Method Detail

hasNext

public boolean hasNext()

Returns true if there are more items available.

Specified by:

hasNext in interface Iterator<CrawlDataItem>

Returns:

True if at least one more item can be fetched with next().

next

public CrawlDataItem next()

Returns the next valid item from the crawl log.

Specified by:

next in interface Iterator<CrawlDataItem>

Returns:

An item from the crawl log. Note that unlike the Iterator interface, this method returns null if there are no more items to fetch.

Throws:

UncheckedIOException - If there is an error reading the item *after* the item to be returned from the crawl.log.

NoSuchElementException - If there are no more items

prepareNext

protected void prepareNext()
                    throws IOException

Ready the next item. This method will skip over items that getNextItem() rejects. When the method returns, either next is non-null or there are no more items in the crawl log.

Note: This method should only be called when next==null

Throws:

IOException

parseLine

protected CrawlDataItem parseLine(String line)
                           throws IOException

Parse the a line in the crawl log.

Override this method to change how individual crawl log items are processed and accepted/rejected. This method is called from within the loop in prepareNext().

Parameters:

line - A line from the crawl log. Must not be null.

Returns:

A CrawlDataItem if the next line in the crawl log yielded a usable item, null otherwise.

Throws:

IOException

close

public void close()
           throws IOException

Closes the crawl.log file.

Specified by:

close in interface AutoCloseable

Throws:

IOException

iterator

public Iterator<CrawlDataItem> iterator()

Specified by:

iterator in interface Iterable<CrawlDataItem>