com.nt.udc.nar

Class NarReader

java.lang.Object

com.nt.udc.nar.NarReader

All Implemented Interfaces:

CheckpointUserIfc, CheckpointUserSourceIfc, Callback, StateBufferSaveable

public class NarReader
extends java.lang.Object
implements StateBufferSaveable, Callback, CheckpointUserSourceIfc

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
NarReader(java.io.File inputdir, LoggerIfc inLogger) Creates a NarReader without backup capabilities.
NarReader(java.io.File inputdir, LoggerIfc inLogger, DCNode node) Creates a NarReader with state recovery capabilities, but without backup capabilities.
NarReader(java.io.File inputdir, LoggerIfc inLogger, java.io.File backupdir) Creates a NarReader with backup capabilities.
NarReader(java.io.File inputdir, LoggerIfc inLogger, java.io.File backupdir, DCNode node, CheckpointManager cpm, InputStatisticsMonitorIfc inCount, boolean fileLevelTrans) Creates a NarReader with backup capabilities, and state recovery capabilities.
NarReader(java.io.File inputdir, LoggerIfc inLogger, java.io.File backupdir, DCNode node, CheckpointManager cpm, InputStatisticsMonitorIfc inCount, boolean isMultiThreaded, int threadCount, boolean mtOrderChecked, int currThread, boolean fileLevelTrans) Creates a NarReader with backup capabilities, and state recovery capabilities.

Method Summary

Methods

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.
void	clearCheckpointData()
void	continueFromCheckpoint()
void	flushCheckpoint(BaseCheckpointData cp)
BaseCheckpointData	generateEmptyCheckpointData()
BaseCheckpointData	getCheckpointData()
java.lang.String	getIdentifier()
protected void	getLastInputInfo() Check and get the private checkpoint data.
void	handleRejectOfFile()
boolean	isBulkDataAvailable() Returns whether there are more files available for processing.
boolean	isDataAvailable() Returns whether there are more records available for processing.
boolean	isEndOfFile() Method indicates if the file is opened for file level transaction
boolean	isFileDataAvailable()
boolean	isFileOpen() Method indicates if the file is opened for file level transaction
boolean	isStartOfFile() Method indicates if the file is opened for file level transaction
java.lang.String	openInputFile()
void	pauseForCheckpoint()
NAR[]	readAllNARs()
NAR	readNAR() Returns the next NAR.
NAR[]	readNARs()
boolean	rejectFile() Method to reject input file
void	restoreCheckpoint(BaseCheckpointData bcp)
void	restoreState(StateBuffer buffer) Restores the runtime state of the Reader from a StateBuffer.
protected void	saveCurrentInputInfo() Re-save checkpoint data into private file in scratch directory, for proper recovery at next startup.
void	saveState(StateBuffer buffer) Saves the state of the NarReader to a buffer.
boolean	setFilesForFileLevelTransaction()
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

NARREAD

public static final java.lang.String NARREAD

NARDELETE

public static final java.lang.String NARDELETE

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

NarReader

public NarReader(java.io.File inputdir,
         LoggerIfc inLogger)

Creates a NarReader without backup capabilities.

Parameters:

inputdir - Node input directory

inLogger - Node logger

NarReader

public NarReader(java.io.File inputdir,
         LoggerIfc inLogger,
         java.io.File backupdir)

Creates a NarReader with backup capabilities.

Parameters:

inputdir - Node input directory

inLogger - Node logger

backupdir - Node backup directory

NarReader

public NarReader(java.io.File inputdir,
         LoggerIfc inLogger,
         DCNode node)

Creates a NarReader with state recovery capabilities, but without backup capabilities.

Parameters:

inputdir - Node input directory

inLogger - Node logger

node - Used to signal state backups.

NarReader

public NarReader(java.io.File inputdir,
         LoggerIfc inLogger,
         java.io.File backupdir,
         DCNode node,
         CheckpointManager cpm,
         InputStatisticsMonitorIfc inCount,
         boolean fileLevelTrans)

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.

NarReader

public NarReader(java.io.File inputdir,
         LoggerIfc inLogger,
         java.io.File backupdir,
         DCNode node,
         CheckpointManager cpm,
         InputStatisticsMonitorIfc inCount,
         boolean isMultiThreaded,
         int threadCount,
         boolean mtOrderChecked,
         int currThread,
         boolean fileLevelTrans)

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.

isMultiThreaded - Used to signal multi threaded node.

threadCount - Total number of threads.

currThread - Current thread.

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()

handleRejectOfFile

public void handleRejectOfFile()

setFilesForFileLevelTransaction

public boolean setFilesForFileLevelTransaction()

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

isFileOpen

public boolean isFileOpen()
                   throws java.lang.Exception

Method indicates if the file is opened for file level transaction

Returns:

Throws:

java.lang.Exception

isStartOfFile

public boolean isStartOfFile()
                      throws java.lang.Exception

Method indicates if the file is opened for file level transaction

Returns:

Throws:

java.lang.Exception

rejectFile

public boolean rejectFile()
                   throws java.lang.Exception

Method to reject input file

Returns:

Throws:

java.lang.Exception

isEndOfFile

public boolean isEndOfFile()
                    throws java.lang.Exception

Method indicates if the file is opened for file level transaction

Returns:

Throws:

java.lang.Exception

isDataAvailable

public boolean isDataAvailable()

Returns whether there are more records available for processing.

Returns:

true, if data is available

isFileDataAvailable

public boolean isFileDataAvailable()
                            throws java.lang.Exception

Throws:

java.lang.Exception

openInputFile

public java.lang.String openInputFile()
                               throws java.lang.Exception

Throws:

java.lang.Exception

isBulkDataAvailable

public boolean isBulkDataAvailable()

Returns whether there are more files available for processing.

Returns:

true, if data is available

readAllNARs

public NAR[] readAllNARs()

getIdentifier

public java.lang.String getIdentifier()

Specified by:

getIdentifier in interface CheckpointUserIfc

generateEmptyCheckpointData

public BaseCheckpointData generateEmptyCheckpointData()

Specified by:

generateEmptyCheckpointData in interface CheckpointUserIfc

pauseForCheckpoint

public void pauseForCheckpoint()

Specified by:

pauseForCheckpoint in interface CheckpointUserSourceIfc

getCheckpointData

public BaseCheckpointData getCheckpointData()

Specified by:

getCheckpointData in interface CheckpointUserIfc

clearCheckpointData

public void clearCheckpointData()

Specified by:

clearCheckpointData in interface CheckpointUserIfc

continueFromCheckpoint

public void continueFromCheckpoint()

Specified by:

continueFromCheckpoint in interface CheckpointUserSourceIfc

flushCheckpoint

public void flushCheckpoint(BaseCheckpointData cp)

Specified by:

flushCheckpoint in interface CheckpointUserIfc

restoreCheckpoint

public void restoreCheckpoint(BaseCheckpointData bcp)

Specified by:

restoreCheckpoint in interface CheckpointUserIfc

saveCurrentInputInfo

protected void saveCurrentInputInfo()

Re-save checkpoint data into private file in scratch directory, for proper recovery at next startup. This is useful for non-PartitionedDCNode. Note that if there is no current arch file, then there will be no checkpoint file either.

getLastInputInfo

protected void getLastInputInfo()

Check and get the private checkpoint data. Checkpoint Manager will overwrite this data later, at restoreCheckpoint(). But if there is no checkpoint manager, then the data in this file will be used. Note: At the end of this method, it will leave an empty private checkpoint file behind, so that an improper shutdown can be detected.