Docs For Class ArchiveBundleIterator

array nextPages(
int
$num, [bool
$no_process = false])

Gets the next $num many docs from the iterator

Tags:

return:	associative arrays for $num pages
abstract:

Overridden in child classes as:

DatabaseBundleIterator::nextPages(): Gets the next at most $num many docs from the iterator. It might return less than $num many documents if the partition changes or the end of the bundle is reached.

MixArchiveBundleIterator::nextPages(): Gets the next $num many docs from the iterator

TextArchiveBundleIterator::nextPages(): Gets the next at most $num many docs from the iterator. It might return less than $num many documents if the partition changes or the end of the bundle is reached.

WebArchiveBundleIterator::nextPages(): Gets the next $num many docs from the iterator

Parameters:

int	$num	number of docs to get
bool	$no_process	do not do any processing on page data

[ Top ]

void reset(
)

Resets the iterator to the start of the archive bundle

Tags:

abstract:

Overridden in child classes as:

DatabaseBundleIterator::reset(): Resets the iterator to the start of the archive bundle

MixArchiveBundleIterator::reset(): Resets the iterator to the start of the archive bundle

TextArchiveBundleIterator::reset(): Resets the iterator to the start of the archive bundle

WebArchiveBundleIterator::reset(): Resets the iterator to the start of the archive bundle

[ Top ]

array restoreCheckpoint(
)

Restores the internal state from the file iterate_status.txt in the

result dir such that the next call to nextPages will pick up from just after the last checkpoint. Each iterator should make a call to restoreCheckpoint at the end of the constructor method after the instance members have been initialized.

Tags:

return:

the data serialized when saveCheckpoint was called

Overridden in child classes as:

MixArchiveBundleIterator::restoreCheckpoint(): Restores state from a previous instantiation, after the last batch of pages extracted.

WebArchiveBundleIterator::restoreCheckpoint(): Restores state from a previous instantiation, after the last batch of pages extracted.

[ Top ]

void saveCheckpoint(
[array
$info = array()])

Stores the current progress to the file iterate_status.txt in the result

dir such that a new instance of the iterator could be constructed and return the next set of pages without having to process all of the pages that came before. Each iterator should make a call to saveCheckpoint after extracting a batch of pages.

Overridden in child classes as:

MixArchiveBundleIterator::saveCheckpoint(): Saves the current state so that a new instantiation can pick up just after the last batch of pages extracted.

WebArchiveBundleIterator::saveCheckpoint(): Saves the current state so that a new instantiation can pick up just after the last batch of pages extracted.

Parameters:

array

$info

any extra info a subclass wants to save

[ Top ]

void seekPage(
$limit
$limit)

Advances the iterator to the $limit page, with as little additional processing as possible

Overridden in child classes as:

DatabaseBundleIterator::seekPage(): Advances the iterator to the $limit page, with as little additional processing as possible

Parameters:

$limit

$limit

page to advance to

[ Top ]

mixed weight(
$site
&$site)

Estimates the important of the site according to the weighting of

the particular archive iterator

Tags:

return:	a 4-bit number or false if iterator doesn't uses default ranking method
abstract:

Overridden in child classes as:

DatabaseBundleIterator::weight(): Estimates the important of the site according to the weighting of

MixArchiveBundleIterator::weight(): Estimates the importance of the site according to the weighting of

TextArchiveBundleIterator::weight(): Estimates the important of the site according to the weighting of

MediaWikiArchiveBundleIterator::weight(): Estimates the important of the site according to the weighting of

OdpRdfArchiveBundleIterator::weight(): Estimates the important of the site according to the weighting of

WebArchiveBundleIterator::weight(): Estimates the importance of the site according to the weighting of

Parameters:

$site

&$site

an associative array containing info about a web page

[ Top ]

Class: ArchiveBundleIterator

Class Overview

Author(s):

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$end_of_iterator =

$iterate_timestamp =

$result_dir =

$result_timestamp =

Class Methods

method nextPages [line 138]

Tags:

Parameters:

method reset [line 143]

Tags:

method restoreCheckpoint [line 98]

Tags:

method saveCheckpoint [line 80]

Parameters:

method seekPage [line 115]

Parameters:

method weight [line 130]

Tags:

Parameters: