BatchProcessing (Toxtree 3.1.0 API)

java.lang.Object
- java.util.Observable
- - toxTree.io.batch.BatchProcessing

All Implemented Interfaces:

Serializable, IBatchProcessing

Direct Known Subclasses:

ChemObjectBatchProcessing
```
public abstract class BatchProcessing
extends Observable
implements IBatchProcessing
```
Accessing & serializing Array: Throwing exception in jre6 while it works in jre5 http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6554519 An abstract class to support Batch processing with several fail safe options

Author:

Nina jeliazkova Modified 2005-9-4

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected File`	`configFile`
`protected Date`	`dateCreated`
`protected Date`	`dateLastSaved`
`protected boolean`	`deleteConfigOnSuccess`
`protected FileState`	`inputFile`
`protected static Logger`	`logger`
`protected static String`	`MSG_CANTCREATEFILE`
`protected static String`	`MSG_ERRORCOUNTING`
`protected static String`	`MSG_ERRORSAVE`
`protected static String`	`MSG_FILEDONOTEXISTS`
`protected static String`	`MSG_OPEN`
`protected static String`	`MSG_UNSUPPORTEDFORMAT`
`protected FileState`	`outputFile`
`protected int`	`saveStateFrequency`
`int`	`status`
`static int`	`STATUS_ABORTED`
`static int`	`STATUS_FINISHED`
`static int`	`STATUS_NOTINITIALIZED`
`static int`	`STATUS_NOTSTARTED`
`static int`	`STATUS_PAUSED`
`static int`	`STATUS_RUNNING`
`protected static String[]`	`statusMsg`
`protected String`	`tmpDir`

Constructor Summary

Constructors
Constructor and Description
`BatchProcessing()` Creates empty BatchProcessing it should be configured prior to use
`BatchProcessing(File input, File output)` Creates BatchProcessing given input and output file names
`BatchProcessing(String input, String output)` Creates BatchProcessing given input and output file names

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()`
`void`	`close()`
`File`	`createConfigFile()`
`void`	`createOutputFile()`
`boolean`	`equals(Object obj)`
`File`	`getConfigFile()` Where to store batchprocessing configuration itself
`Date`	`getDateCreated()`
`Date`	`getDateLastProcessed()`
`FileState`	`getInputFile()`
`FileState`	`getOutputFile()`
`long`	`getReadRecordsCount()` Returns the number of records read from the input file
`int`	`getSaveStateFrequency()` BatchProcessing saves its state on each saveStateFrequency records
`int`	`getStatus()`
`String`	`getTempDir()`
`long`	`getWrittenRecordsCount()` Returns the number of records written to the output file
`boolean`	`isCancelled()`
`boolean`	`isPaused()`
`boolean`	`isRunning()`
`boolean`	`isStatus(int status)`
`void`	`loadConfig()`
`void`	`openInputFile()`
`void`	`pause()`
`void`	`saveConfig()`
`void`	`saveConfig(OutputStream out)`
`void`	`setConfigFile(File configFile)`
`void`	`setSaveStateFrequency(int saveStateFrequency)` BatchProcessing saves its state on each saveStateFrequency records
`protected void`	`setStatus(int status)`
`void`	`start()`
`String`	`toString()`

Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface toxTree.io.batch.IBatchProcessing
closeInputFile, closeOutputFile, hasNextRecord, processRecord, readRecord, writeRecord

- Field Detail
  - saveStateFrequency
```
protected int saveStateFrequency
```
  - inputFile
```
protected FileState inputFile
```
  - outputFile
```
protected FileState outputFile
```
  - dateCreated
```
protected Date dateCreated
```
  - dateLastSaved
```
protected Date dateLastSaved
```
  - configFile
```
protected transient File configFile
```
  - tmpDir
```
protected transient String tmpDir
```
  - deleteConfigOnSuccess
```
protected transient boolean deleteConfigOnSuccess
```
  - MSG_FILEDONOTEXISTS
```
protected static transient String MSG_FILEDONOTEXISTS
```
  - MSG_CANTCREATEFILE
```
protected static transient String MSG_CANTCREATEFILE
```
  - MSG_OPEN
```
protected static transient String MSG_OPEN
```
  - MSG_UNSUPPORTEDFORMAT
```
protected static transient String MSG_UNSUPPORTEDFORMAT
```
  - MSG_ERRORSAVE
```
protected static transient String MSG_ERRORSAVE
```
  - MSG_ERRORCOUNTING
```
protected static transient String MSG_ERRORCOUNTING
```
  - logger
```
protected static transient Logger logger
```
  - statusMsg
```
protected static transient String[] statusMsg
```
  - STATUS_NOTSTARTED
```
public static final transient int STATUS_NOTSTARTED
```
    See Also:
    
    Constant Field Values
  - STATUS_RUNNING
```
public static final transient int STATUS_RUNNING
```
    See Also:
    
    Constant Field Values
  - STATUS_FINISHED
```
public static final transient int STATUS_FINISHED
```
    See Also:
    
    Constant Field Values
  - STATUS_PAUSED
```
public static final transient int STATUS_PAUSED
```
    See Also:
    
    Constant Field Values
  - STATUS_ABORTED
```
public static final transient int STATUS_ABORTED
```
    See Also:
    
    Constant Field Values
  - STATUS_NOTINITIALIZED
```
public static final transient int STATUS_NOTINITIALIZED
```
    See Also:
    
    Constant Field Values
  - status
```
public int status
```
- Constructor Detail
  - BatchProcessing
```
public BatchProcessing()
```
    Creates empty BatchProcessing it should be configured prior to use
  - BatchProcessing
```
public BatchProcessing(String input,
                       String output)
                throws BatchProcessingException
```
    Creates BatchProcessing given input and output file names
    
    Parameters:
    
    input - Input filename; should exists
    
    output - Results (output) filename ; deleted if exists
    
    Throws:
    
    BatchProcessingException - - if input file do not exists - if output file can't be deleted and a new one created; - on any IOException
  - BatchProcessing
```
public BatchProcessing(File input,
                       File output)
                throws BatchProcessingException
```
    Creates BatchProcessing given input and output file names
    
    Parameters:
    
    input - Input filename; should exists
    
    output - Results (output) filename ; deleted if exists
    
    Throws:
    
    BatchProcessingException - - if input file do not exists - if output file can't be deleted and a new one created; - on any IOException
- Method Detail
  - openInputFile
```
public void openInputFile()
                   throws BatchProcessingException
```
    Specified by:
    
    openInputFile in interface IBatchProcessing
    
    Throws:
    
    BatchProcessingException
  - createOutputFile
```
public void createOutputFile()
                      throws BatchProcessingException
```
    Specified by:
    
    createOutputFile in interface IBatchProcessing
    
    Throws:
    
    BatchProcessingException
  - start
```
public void start()
           throws BatchProcessingException
```
    Specified by:
    
    start in interface IBatchProcessing
    
    Throws:
    
    BatchProcessingException
  - close
```
public void close()
           throws BatchProcessingException
```
    Specified by:
    
    close in interface IBatchProcessing
    
    Throws:
    
    BatchProcessingException
  - pause
```
public void pause()
           throws BatchProcessingException
```
    Specified by:
    
    pause in interface IBatchProcessing
    
    Throws:
    
    BatchProcessingException
  - cancel
```
public void cancel()
            throws BatchProcessingException
```
    Specified by:
    
    cancel in interface IBatchProcessing
    
    Throws:
    
    BatchProcessingException
  - saveConfig
```
public void saveConfig()
                throws BatchProcessingException
```
    Specified by:
    
    saveConfig in interface IBatchProcessing
    
    Throws:
    
    BatchProcessingException
  - saveConfig
```
public void saveConfig(OutputStream out)
                throws BatchProcessingException
```
    Throws:
    
    BatchProcessingException
  - loadConfig
```
public void loadConfig()
                throws BatchProcessingException
```
    Specified by:
    
    loadConfig in interface IBatchProcessing
    
    Throws:
    
    BatchProcessingException
  - isStatus
```
public boolean isStatus(int status)
```
    Returns:
    
    Returns the status.
  - setStatus
```
protected void setStatus(int status)
```
    Parameters:
    
    status - The status to set.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getSaveStateFrequency
```
public int getSaveStateFrequency()
```
    BatchProcessing saves its state on each saveStateFrequency records
    
    Returns:
    
    Returns the saveStateFrequency.
  - setSaveStateFrequency
```
public void setSaveStateFrequency(int saveStateFrequency)
```
    BatchProcessing saves its state on each saveStateFrequency records
    
    Parameters:
    
    saveStateFrequency - The saveStateFrequency to set.
  - getTempDir
```
public String getTempDir()
```
  - createConfigFile
```
public File createConfigFile()
```
  - getConfigFile
```
public File getConfigFile()
```
    Where to store batchprocessing configuration itself
    
    Returns:
    
    Returns the configFile.
  - setConfigFile
```
public void setConfigFile(File configFile)
```
    Specified by:
    
    setConfigFile in interface IBatchProcessing
    
    Parameters:
    
    configFile - The configFile to set.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getStatus
```
public int getStatus()
```
    Returns:
    
    Returns the status.
  - getReadRecordsCount
```
public long getReadRecordsCount()
```
    Returns the number of records read from the input file
    
    Specified by:
    
    getReadRecordsCount in interface IBatchProcessing
  - getWrittenRecordsCount
```
public long getWrittenRecordsCount()
```
    Returns the number of records written to the output file
    
    Specified by:
    
    getWrittenRecordsCount in interface IBatchProcessing
  - getInputFile
```
public FileState getInputFile()
```
    Returns:
    
    Returns the inputFile.
  - getOutputFile
```
public FileState getOutputFile()
```
    Returns:
    
    Returns the outputFile.
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface IBatchProcessing
  - isPaused
```
public boolean isPaused()
```
    Specified by:
    
    isPaused in interface IBatchProcessing
  - isCancelled
```
public boolean isCancelled()
```
    Specified by:
    
    isCancelled in interface IBatchProcessing
  - getDateCreated
```
public Date getDateCreated()
```
    Specified by:
    
    getDateCreated in interface IBatchProcessing
    
    Returns:
    
    Date when batch job was first created
  - getDateLastProcessed
```
public Date getDateLastProcessed()
```
    Specified by:
    
    getDateLastProcessed in interface IBatchProcessing
    
    Returns:
    
    Date when batch job was processed last

Class BatchProcessing

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Methods inherited from interface toxTree.io.batch.IBatchProcessing

Field Detail

saveStateFrequency

inputFile

outputFile

dateCreated

dateLastSaved

configFile

tmpDir

deleteConfigOnSuccess

MSG_FILEDONOTEXISTS

MSG_CANTCREATEFILE

MSG_OPEN

MSG_UNSUPPORTEDFORMAT

MSG_ERRORSAVE

MSG_ERRORCOUNTING

logger

statusMsg

STATUS_NOTSTARTED

STATUS_RUNNING

STATUS_FINISHED

STATUS_PAUSED

STATUS_ABORTED

STATUS_NOTINITIALIZED

status

Constructor Detail

BatchProcessing

BatchProcessing

BatchProcessing

Method Detail

openInputFile

createOutputFile

start

close

pause

cancel

saveConfig

saveConfig

loadConfig

isStatus

setStatus

toString

getSaveStateFrequency

setSaveStateFrequency

getTempDir

createConfigFile

getConfigFile

setConfigFile

equals

getStatus

getReadRecordsCount

getWrittenRecordsCount

getInputFile

getOutputFile

isRunning

isPaused

isCancelled

getDateCreated

getDateLastProcessed