org.jbundle.app.program.script.scan

Class BaseScanListener

java.lang.Object

org.jbundle.app.program.script.scan.BaseScanListener

All Implemented Interfaces:

ScanListener, Freeable, PropertyOwner, RecordOwnerParent

Direct Known Subclasses:

CalendarScanListener, ConstantsScanListener, DateOffsetScanListener, DeleteScanListener, ImportXMLScanListener, ReplaceScanListener, SourceHeaderScanListener, XMLScanListener, XslImportScanListener, XslRepositoryScanListener

public class BaseScanListener
extends Object
implements ScanListener

BaseScanListener - .

Field Summary

Fields

Modifier and Type	Field and Description
protected File	m_fileSource
protected RecordOwnerParent	m_parent
protected RecordOwnerCollection	m_recordOwnerCollection
protected String	m_strSourcePrefix
protected PrintWriter	m_writer

Constructor Summary

Constructors

Constructor and Description
BaseScanListener() Default constructor.
BaseScanListener(RecordOwnerParent parent, String strSourcePrefix) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addRecordOwner(RecordOwnerParent recordOwner) Add this record owner to my list.
String	convertString(String string) Do any string conversion on the file text.
boolean	filterDirectory(File file) If this file should be processed, return true.
boolean	filterFile(File file) If this file should be processed, return true.
void	free() Free Method.
Map<String,Object>	getProperties() GetProperties Method.
String	getProperty(String strProperty) Get this property (from my parent ConvertCode class).
Task	getTask() GetTask Method.
void	init(RecordOwnerParent parent, String strSourcePrefix) Init Method.
void	moveSourceToDest(LineNumberReader reader, PrintWriter dataOut) MoveSourceToDest Method.
void	moveThisFile(File fileSource, File fileDestDir, String strDestName) Do whatever processing that needs to be done on this file.
void	moveThisFile(LineNumberReader reader, File fileDestDir, String strDestName) MoveThisFile Method.
void	postProcessThisDirectory(File fileDir, Object objDirID) Do whatever processing that needs to be done on this directory.
Object	processThisDirectory(File fileDir, Object objDirID) Do whatever processing that needs to be done on this directory.
boolean	removeRecordOwner(RecordOwnerParent recordOwner) Remove this record owner to my list.
PropertyOwner	retrieveUserProperties(String strRegistrationKey) RetrieveUserProperties Method.
void	setPrintWriter(PrintWriter writer) SetPrintWriter Method.
void	setProperties(Map<String,Object> properties) SetProperties Method.
void	setProperty(String strProperty, String strValue) SetProperty Method.
void	setSourceFile(File fileSource) SetSourceFile Method.

Methods inherited from class java.lang.Object

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

Field Detail

m_fileSource

protected File m_fileSource

m_parent

protected RecordOwnerParent m_parent

m_strSourcePrefix

protected String m_strSourcePrefix

m_writer

protected PrintWriter m_writer

m_recordOwnerCollection

protected RecordOwnerCollection m_recordOwnerCollection

Constructor Detail

BaseScanListener

public BaseScanListener()

Default constructor.

BaseScanListener

public BaseScanListener(RecordOwnerParent parent,
                String strSourcePrefix)

Constructor.

Method Detail

init

public void init(RecordOwnerParent parent,
        String strSourcePrefix)

Init Method.

free

public void free()

Free Method.

Specified by:

free in interface Freeable

filterDirectory

public boolean filterDirectory(File file)

If this file should be processed, return true.

Specified by:

filterDirectory in interface ScanListener

processThisDirectory

public Object processThisDirectory(File fileDir,
                          Object objDirID)

Do whatever processing that needs to be done on this directory.

Specified by:

processThisDirectory in interface ScanListener

objDirID - The parent object id

Returns:

caller specific information about this directory.

postProcessThisDirectory

public void postProcessThisDirectory(File fileDir,
                            Object objDirID)

Do whatever processing that needs to be done on this directory.

Specified by:

postProcessThisDirectory in interface ScanListener

objDirID - The parent object id

filterFile

public boolean filterFile(File file)

If this file should be processed, return true.

Specified by:

filterFile in interface ScanListener

setSourceFile

public void setSourceFile(File fileSource)

SetSourceFile Method.

moveThisFile

public void moveThisFile(File fileSource,
                File fileDestDir,
                String strDestName)

Do whatever processing that needs to be done on this file.

Specified by:

moveThisFile in interface ScanListener

moveThisFile

public void moveThisFile(LineNumberReader reader,
                File fileDestDir,
                String strDestName)

MoveThisFile Method.

setPrintWriter

public void setPrintWriter(PrintWriter writer)

SetPrintWriter Method.

moveSourceToDest

public void moveSourceToDest(LineNumberReader reader,
                    PrintWriter dataOut)

MoveSourceToDest Method.

convertString

public String convertString(String string)

Do any string conversion on the file text.

getProperty

public String getProperty(String strProperty)

Get this property (from my parent ConvertCode class).

Specified by:

getProperty in interface PropertyOwner

Parameters:

strProperty - the property key

Returns:

The value.

getProperties

public Map<String,Object> getProperties()

GetProperties Method.

Specified by:

getProperties in interface PropertyOwner

retrieveUserProperties

public PropertyOwner retrieveUserProperties(String strRegistrationKey)

RetrieveUserProperties Method.

Specified by:

retrieveUserProperties in interface PropertyOwner

setProperties

public void setProperties(Map<String,Object> properties)

SetProperties Method.

Specified by:

setProperties in interface PropertyOwner

setProperty

public void setProperty(String strProperty,
               String strValue)

SetProperty Method.

Specified by:

setProperty in interface PropertyOwner

getTask

public Task getTask()

GetTask Method.

Specified by:

getTask in interface RecordOwnerParent

addRecordOwner

public boolean addRecordOwner(RecordOwnerParent recordOwner)

Add this record owner to my list.

Specified by:

addRecordOwner in interface RecordOwnerParent

Parameters:

recordOwner - The record owner to add.

removeRecordOwner

public boolean removeRecordOwner(RecordOwnerParent recordOwner)

Remove this record owner to my list.

Specified by:

removeRecordOwner in interface RecordOwnerParent

Parameters:

recordOwner - The record owner to remove.