com.nt.udc.oi.node.narxml

Class NARXMLOIFileWriter

java.lang.Object

com.nt.udc.ndk.util.OIFileWriter

com.nt.udc.oi.node.narxml.NARXMLOIFileWriter

All Implemented Interfaces:

StateBufferSaveable

public class NARXMLOIFileWriter
extends OIFileWriter

Field Summary

Fields inherited from class com.nt.udc.ndk.util.OIFileWriter

fileWriter, m_stateManagementIfc, MAXRECSPERFILE, MAXRECSPERFILE_DEFAULT, MAXRECSPERFILE_MAX, MAXRECSPERFILE_MIN

Constructor Summary

Constructors

Constructor and Description
NARXMLOIFileWriter(LoggerIfc lgr, java.lang.String filedir, java.lang.String filename, java.lang.String currext, java.lang.String doneext, java.lang.String timeper, StateManagementIfc stateMgr, int maxrecs, java.lang.String schemaURL) Construct a new OIFileWriter to be used within an OITransport object.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the output file.
boolean	open() Open the output file, creating it if necessary.
void	write(NAR nar)

Methods inherited from class com.nt.udc.ndk.util.OIFileWriter

cycleFile, flush, getActiveExtension, getBufferSize, getCompletedExtension, getCurrentFileExpiryTime, getCycleTime, getFileLevelTransactionConfig, getFilename, getFilePrefix, getFullFilename, getLogger, getMaxRecsPerFile, getNewFilename, getNextCycle, getOutDir, getOutFile, getOutputDirectory, getPosition, getRecordCount, getSystemTime, getTimeAmt, incrementRecordCount, isHealthy, isOpen, moveToReadyToCycle, readyToCycle, removeOutFile, renameActiveFile, resetRecordCount, restoreState, saveState, saveStateNotification, setActiveExtension, setBufferSize, setCompletedExtension, setCycleTime, setFileLevelTransactionConfig, setFilePrefix, setMaxRecsPerFile, setMultiThreadConfiguration, setNextCycle, setNextCycleTime, setOpened, setOriginalFileName, setOutFile, setOutputDirectory, setReadyToCycle, shutdown, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

NARXMLOIFileWriter

public NARXMLOIFileWriter(LoggerIfc lgr,
                  java.lang.String filedir,
                  java.lang.String filename,
                  java.lang.String currext,
                  java.lang.String doneext,
                  java.lang.String timeper,
                  StateManagementIfc stateMgr,
                  int maxrecs,
                  java.lang.String schemaURL)
                   throws NodeStartException

Construct a new OIFileWriter to be used within an OITransport object. Files will be created based upon the provided configuration parameters. The writer can be configured to write the incoming data as Strings or as an array of bytes. Additionally, a simple Thread() is started to periodically check the time period to determine if the output file is ready to be cycled. When the OITransport() is being shutdown, the shutdown() method of this file writer should be called to stop this thread.

Parameters:

logger - Reference to the log methods of the node

filedir - Name of the output directory in which to write files

filename - File name prefix, to be combined with a timestamp to create a unique file name

currext - File name extension which indicates the active file

doneext - File name extension which indicates files that have been completed

timeper - Period of time a file remains active until it is cycled out

stateMgr - An interface used to manage state recovery

maxrecs - Maximum number of records per file.

schemaURL - The XML schema name space location

Throws:

NodeStartException

Method Detail

write

public void write(NAR nar)
           throws java.io.IOException

Overrides:

write in class OIFileWriter

Throws:

java.io.IOException

open

public boolean open()
             throws java.io.IOException

Description copied from class: OIFileWriter

Open the output file, creating it if necessary. The name and location of the file is determined thru configuration parameters at the time of the creation of the OINode.

Overrides:

open in class OIFileWriter

Returns:

true, if it was necessary to create the file.

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Description copied from class: OIFileWriter

Close the output file.

Overrides:

close in class OIFileWriter

Throws:

java.io.IOException