org.openimaj.hadoop.sequencefile

Class ExtractionState

java.lang.Object

org.openimaj.hadoop.sequencefile.ExtractionState

public class ExtractionState
extends Object

The state describing the extraction process from SequenceFile. Basically, this class stores the current state of the extraction and determines whether the next item should be extracted or not.

Author:

Sina Samangooei (ss@ecs.soton.ac.uk), Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
ExtractionState()

Method Summary

Modifier and Type	Method and Description
protected boolean	allowNext()
int	getCount()
boolean	isFinished()
void	setMaxFileExtract(int max) Set the maximum allowed number of records to extract.
void	setRandomSelection(int number, int total) Instruct the state to extract number records from the file randomly.
protected void	tick()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtractionState

public ExtractionState()

Method Detail

getCount

public int getCount()

Returns:

the number of items that have been extracted

allowNext

protected boolean allowNext()

Returns:

true if the next record is allowed; false otherwise

isFinished

public boolean isFinished()

Returns:

true if the extraction is finished; i.e. the maximum number of records has been reached

tick

protected void tick()

setRandomSelection

public void setRandomSelection(int number,
                               int total)

Instruct the state to extract number records from the file randomly.

Parameters:

number - number of records to extract

total - total number of records in the file

setMaxFileExtract

public void setMaxFileExtract(int max)

Set the maximum allowed number of records to extract.

Parameters:

max - the number of records.