com.nt.udc.nar

Class NarWriter

java.lang.Object

com.nt.udc.nar.NarWriter

All Implemented Interfaces:

CheckpointUserIfc, Callback, StateBufferSaveable, StateFreezable, java.awt.event.ActionListener, java.util.EventListener

public class NarWriter
extends java.lang.Object
implements java.awt.event.ActionListener, StateBufferSaveable, StateFreezable, Callback, CheckpointUserIfc

The NarWriter class is responsible for managing a single output NAR cache file.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NARWRITE

Constructor Summary

Constructors

Constructor and Description
NarWriter(java.io.File outputdir, java.io.File scratchdir, ConfigIfc config, LoggerIfc logger, java.lang.String nodeid, java.lang.String chan, FilenameGenerator filenameGen, DCNode node, int externalId, CheckpointManager checkpointMgr, boolean fileLevelTrans) Creates a NarWriter object with the given parameters.
NarWriter(java.io.File outputdir, java.io.File scratchdir, ConfigIfc config, LoggerIfc logger, java.lang.String nodeid, java.lang.String chan, FilenameGenerator filenameGen, DCNode node, int externalId, CheckpointManager checkpointMgr, boolean isMultiThreaded, int threadCount, int currThread, boolean isOrdered, boolean fileLevelTrans) Creates a NarWriter object with the given parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) This method is called by the NarWriter timer.
void	callback() This callback is used only when the saveState() call is made by this Object.
void	clearCheckpointData()
void	createNewCacheFile()
void	flushCheckpoint(BaseCheckpointData cp)
void	freezeState(Callback freezeCallback) Used by another Thread to request the timer to freeze, and halt its processing.
BaseCheckpointData	generateEmptyCheckpointData()
java.io.File	getActiveOutputFile() Returns the current active output cache file.
BaseCheckpointData	getCheckpointData()
java.lang.String	getIdentifier()
int	getRecordCount() Returns the number of records written to the current cache file.
int	getTotalRecordCount() Returns the total number of records written by this writer.
boolean	moveCacheToReadyToOut(boolean initNew)
boolean	moveToArchive() This method renames the currently active NAR cache file to an archive file.
void	moveToReadyToOut(boolean initNew)
boolean	processEndOfFileData()
boolean	processRejectFile()
boolean	processStartOfFileData(java.lang.String originalFileName)
void	restoreCheckpoint(BaseCheckpointData bcp)
void	restoreState(StateBuffer buffer) Restores the state of the NarWriter from the state buffer.
void	saveState(StateBuffer buffer) Saves the state of the NarWriter to the state buffer.
void	shutdown() Shuts down the NarWriter in a graceful manner.
void	start() Starts the NarWriter.
void	unfreezeState() Used by another Thread to request the timer to unfreeze, and resume its processing.
boolean	writeNAR(NAR osar) The writeNAR() method stores an NAR in the current cache file.

Methods inherited from class java.lang.Object

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

Field Detail

NARWRITE

public static final java.lang.String NARWRITE

Constructor Detail

NarWriter

public NarWriter(java.io.File outputdir,
         java.io.File scratchdir,
         ConfigIfc config,
         LoggerIfc logger,
         java.lang.String nodeid,
         java.lang.String chan,
         FilenameGenerator filenameGen,
         DCNode node,
         int externalId,
         CheckpointManager checkpointMgr,
         boolean fileLevelTrans)

Creates a NarWriter object with the given parameters.

Parameters:

outputdir - Node output dir

scratchdir - Node scratch dir

config - Node config file

logger - Node logger

nodeid - Node's ID

chan - Channel Value

filenameGen - Filename generator

fileLevelTrans - Used to indicate if the node is used in file level transaction

NarWriter

public NarWriter(java.io.File outputdir,
         java.io.File scratchdir,
         ConfigIfc config,
         LoggerIfc logger,
         java.lang.String nodeid,
         java.lang.String chan,
         FilenameGenerator filenameGen,
         DCNode node,
         int externalId,
         CheckpointManager checkpointMgr,
         boolean isMultiThreaded,
         int threadCount,
         int currThread,
         boolean isOrdered,
         boolean fileLevelTrans)

Creates a NarWriter object with the given parameters.

Parameters:

outputdir - Node output dir

scratchdir - Node scratch dir

config - Node config file

logger - Node logger

nodeid - Node's ID

chan - Channel Value

filenameGen - Filename generator

isMultiThreaded - Used to signal multi threaded node.

threadCount - Total number of threads.

currThread - Current thread.

isOrdered - Used to check if ordering is required.

fileLevelTrans - Used to indicate if the node is used in file level transaction

Method Detail

start

public void start()

Starts the NarWriter.

shutdown

public void shutdown()

Shuts down the NarWriter in a graceful manner.

writeNAR

public boolean writeNAR(NAR osar)

The writeNAR() method stores an NAR in the current cache file. When the cache file reaches the maximum number of NARs, it is renamed to the node output directory, which makes it available to the LDM and RDM.

Parameters:

osar - NAR to write

moveToArchive

public boolean moveToArchive()

This method renames the currently active NAR cache file to an archive file.

Returns:

true, if move succeeded

moveCacheToReadyToOut

public boolean moveCacheToReadyToOut(boolean initNew)

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

This method is called by the NarWriter timer.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

callback

public void callback()

This callback is used only when the saveState() call is made by this Object. The StateManager will tell this Object that the state has been saved, and then we can do post-saveState() operations.

Specified by:

callback in interface Callback

getActiveOutputFile

public java.io.File getActiveOutputFile()

Returns the current active output cache file.

Returns:

current active output file

getRecordCount

public int getRecordCount()

Returns the number of records written to the current cache file.

Returns:

number of records

getTotalRecordCount

public int getTotalRecordCount()

Returns the total number of records written by this writer.

Returns:

number of records

saveState

public void saveState(StateBuffer buffer)

Saves the state of the NarWriter to the state buffer.

Specified by:

saveState in interface StateBufferSaveable

Parameters:

buffer - State Buffer object

restoreState

public void restoreState(StateBuffer buffer)

Restores the state of the NarWriter from the state buffer.

Specified by:

restoreState in interface StateBufferSaveable

Parameters:

buffer - State Buffer object

freezeState

public void freezeState(Callback freezeCallback)

Used by another Thread to request the timer to freeze, and halt its processing.

Specified by:

freezeState in interface StateFreezable

Parameters:

freezeCallback - Notification Object. When the timer has been frozen, use this Object to notify the caller.

unfreezeState

public void unfreezeState()

Used by another Thread to request the timer to unfreeze, and resume its processing.

Specified by:

unfreezeState in interface StateFreezable

processStartOfFileData

public boolean processStartOfFileData(java.lang.String originalFileName)

processEndOfFileData

public boolean processEndOfFileData()

processRejectFile

public boolean processRejectFile()

getIdentifier

public java.lang.String getIdentifier()

Specified by:

getIdentifier in interface CheckpointUserIfc

generateEmptyCheckpointData

public BaseCheckpointData generateEmptyCheckpointData()

Specified by:

generateEmptyCheckpointData in interface CheckpointUserIfc

getCheckpointData

public BaseCheckpointData getCheckpointData()

Specified by:

getCheckpointData in interface CheckpointUserIfc

clearCheckpointData

public void clearCheckpointData()

Specified by:

clearCheckpointData in interface CheckpointUserIfc

flushCheckpoint

public void flushCheckpoint(BaseCheckpointData cp)

Specified by:

flushCheckpoint in interface CheckpointUserIfc

restoreCheckpoint

public void restoreCheckpoint(BaseCheckpointData bcp)

Specified by:

restoreCheckpoint in interface CheckpointUserIfc

moveToReadyToOut

public void moveToReadyToOut(boolean initNew)

createNewCacheFile

public void createNewCacheFile()