com.metasolv.nm.processor.MXAggregator

Class MXNarReader

java.lang.Object

com.metasolv.nm.processor.MXAggregator.MXNarReader

All Implemented Interfaces:

Callback, StateBufferSaveable

public class MXNarReader
extends java.lang.Object
implements StateBufferSaveable, Callback

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	InputFileProp
static java.lang.String	NAROffsetProp
static java.lang.String	NARsInFileProp

Constructor Summary

Constructors

Constructor and Description
MXNarReader(java.io.File inputdir, LoggerIfc inLogger, java.io.File backupdir, DCNode node, CheckpointManager cpm, InputStatisticsMonitorIfc inCount, MXNarInputTracker inTracker) Creates a NarReader with backup capabilities, and state recovery capabilities.

Method Summary

Modifier and Type	Method and Description
void	callback() This callback is made when the NarReader's call to saveState() has successfully saved the state of the system to disk.
boolean	checkInput() This method checks for an empty input directory.
protected boolean	deleteOrRemoveFiles() This implmentation is not thread-safe.
boolean	isDataAvailable() Returns whether there are more records available for processing.
NAR	readNAR() Returns the next NAR.
NAR[]	readNARs()
boolean	removeInputFile(java.io.File removeFile)
void	restoreState(StateBuffer buffer) Restores the runtime state of the Reader from a StateBuffer.
void	saveState(StateBuffer buffer) Saves the state of the NarReader to a buffer.
void	shutdown() Tells the NarReader it is time to shut down.

Methods inherited from class java.lang.Object

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

Field Detail

InputFileProp

public static final java.lang.String InputFileProp

NAROffsetProp

public static final java.lang.String NAROffsetProp

NARsInFileProp

public static final java.lang.String NARsInFileProp

Constructor Detail

MXNarReader

public MXNarReader(java.io.File inputdir,
                   LoggerIfc inLogger,
                   java.io.File backupdir,
                   DCNode node,
                   CheckpointManager cpm,
                   InputStatisticsMonitorIfc inCount,
                   MXNarInputTracker inTracker)

Creates a NarReader with backup capabilities, and state recovery capabilities.

Parameters:

inputdir - Node input directory

inLogger - Node logger

backupdir - Node backup directory

node - Used to signal state backups.

Method Detail

shutdown

public void shutdown()

Tells the NarReader it is time to shut down. Don't forget to remember which file and which offset we were working on...

readNAR

public NAR readNAR()

Returns the next NAR. Will automatically go to the next file if necessary.

Returns:

readNARs

public NAR[] readNARs()

removeInputFile

public boolean removeInputFile(java.io.File removeFile)

deleteOrRemoveFiles

protected boolean deleteOrRemoveFiles()

This implmentation is not thread-safe.

Parameters:

removeFile -

Returns:

callback

public void callback()

This callback is made when the NarReader's call to saveState() has successfully saved the state of the system to disk. This method can then clean up the input files.

Specified by:

callback in interface Callback

saveState

public void saveState(StateBuffer buffer)

Saves the state of the NarReader to a buffer.

Specified by:

saveState in interface StateBufferSaveable

Parameters:

buffer - Buffer containing state data

restoreState

public void restoreState(StateBuffer buffer)
                  throws StateException

Restores the runtime state of the Reader from a StateBuffer.

Specified by:

restoreState in interface StateBufferSaveable

Parameters:

buffer - Buffer, holding the Reader data

Throws:

StateException

checkInput

public boolean checkInput()

This method checks for an empty input directory.

Returns:

true, if directory contains files

isDataAvailable

public boolean isDataAvailable()

Returns whether there are more records available for processing.

Returns:

true, if data is available