|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.able.AbleObject | +--com.ibm.able.beans.AbleExport
This class writes data out to external text files.
Field Summary | |
---|---|
static java.lang.String |
defaultName
|
Fields inherited from class com.ibm.able.AbleObject |
---|
changed, chgSupport, comment, dataFlowEnabled, destBufferConnections, eventQueue, fileName, inputBuffer, listeners, logger, name, outputBuffer, parent, propertyConnectionMgr, sourceBufferConnections, state, stateChgSupport, trace |
Constructor Summary | |
---|---|
AbleExport()
Construct a default AbleExport object |
|
AbleExport(java.lang.String name)
Construct an AbleExport object with specified name. |
|
AbleExport(java.lang.String name,
java.lang.String dataFileName)
Construct an AbleExport object with specified name and file. |
Method Summary | |
---|---|
void |
close()
Close the output file, disable data flow, and set its state to Unititiated. |
static java.lang.String |
Copyright()
Determine the copyright of this class. |
void |
erase()
Erase the current file and close the current writer. |
void |
flush()
Flush the output buffer. |
java.lang.String |
getDataFileName()
Get the current output file name. |
java.lang.String |
getDelimiter()
Return the current delimiter String. |
int |
getNumberOfInputFields()
Returns the number of inputs provided to this output device. |
void |
init()
Open the output datafile. |
boolean |
isReady()
Indicate whether the export is ready to write data. |
void |
process()
Write out the contents of inputBuffer to file using specified delimiter. |
java.lang.Object |
process(java.lang.Object theArg)
Write out the contents of the parameter to the data file. |
void |
processAbleEvent(AbleEvent theEvent)
Extract the argument object from an AbleEvent and output it to the data file. |
void |
quitAll()
Close any open file. |
void |
reset()
re-initialize the bean close and reopen the output file |
void |
setDataFileName(java.lang.String newName)
Set the current output file name. |
void |
setDelimiter(java.lang.String newDelims)
Set the current delimiter. |
void |
setNumberOfInputs(int inputs)
Sets the number of inputs to be provided to this output device. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.able.AbleBean |
---|
getComment, getLogger, getName, getParent, getState, getTraceLogger, init, isChanged, removeAllConnections, resumeAll, setChanged, setComment, setLogger, setName, setParent, setState, setTraceLogger, suspendAll |
Methods inherited from interface com.ibm.able.AbleEventListener |
---|
handleAbleEvent |
Methods inherited from interface com.ibm.able.AbleEventListenerManager |
---|
addAbleEventListener, dataChanged, getAbleEventListeners, notifyAbleEventListeners, removeAbleEventListener |
Methods inherited from interface com.ibm.able.AbleEventQueueProcessor |
---|
processNoEventProcessingEnabledSituation, processTimerEvent |
Methods inherited from interface com.ibm.able.AblePropertyChangeManager |
---|
addPropertyChangeListener, addPropertyConnection, getPropertyConnectionManager, removeAllPropertyConnections, removePropertyChangeListener, removePropertyConnection |
Methods inherited from interface com.ibm.able.AbleSerializable |
---|
getFileName, restoreFromFile, restoreFromFile, saveToFile, saveToFile, setFileName |
Field Detail |
public static final java.lang.String defaultName
Constructor Detail |
public AbleExport() throws AbleException
public AbleExport(java.lang.String name) throws AbleException
public AbleExport(java.lang.String name, java.lang.String dataFileName) throws AbleException
name
- A String containing the name used to identify this bean.dataFileName
- A String containing the name of the file with no file extension.Method Detail |
public void init() throws AbleException
init
in interface AbleBean
init
in class AbleObject
com.ibm.able.AbleBean
AbleException
- If an error occurs.public void setDataFileName(java.lang.String newName)
public java.lang.String getDataFileName()
public void setDelimiter(java.lang.String newDelims)
public java.lang.String getDelimiter()
public void setNumberOfInputs(int inputs)
AbleDataSink
setNumberOfInputs
in interface AbleDataSink
com.ibm.able.AbleDataSink
count
- The number of inputs required by this output device.public int getNumberOfInputFields()
AbleDataSink
getNumberOfInputFields
in interface AbleDataSink
com.ibm.able.AbleDataSink
public void process() throws AbleException
process
in interface AbleBean
process
in class AbleObject
com.ibm.able.AbleBean
AbleException
- If an error occurs.public java.lang.Object process(java.lang.Object theArg) throws AbleException
process
in interface AbleBean
process
in class AbleObject
com.ibm.able.AbleBean
theArg
- An Object used to provide data for the bean derive a result.AbleException
- If an error occurs.public void quitAll() throws AbleException
quitAll
in interface AbleBean
quitAll
in class AbleObject
close()
public void close()
public void flush() throws AbleException
public void erase() throws AbleException
public void reset() throws AbleException
reset
in interface AbleBean
reset
in class AbleObject
com.ibm.able.AbleBean
AbleException
- If an error occurs.public boolean isReady() throws AbleException
isReady
in interface AbleDataSink
public void processAbleEvent(AbleEvent theEvent) throws AbleException
processAbleEvent
in interface AbleEventQueueProcessor
processAbleEvent
in class AbleObject
theEvent
- An AbleEvent containing the data to be written to file.public static java.lang.String Copyright()
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |