atg.projects.store.io
Class StoreFileWriter

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.projects.store.io.StoreFileWriter

All Implemented Interfaces:

atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, java.util.EventListener

Direct Known Subclasses:

EmailListWriter, InventoryDiscrepancyFileWriter

public abstract class StoreFileWriter
extends atg.nucleus.GenericService

Abstract class for Store FileWriters. This class just creates the common getters and setters that all file writers will need. As a result there is very little Javadoc here. All subclasses should override/implement the "write" method.

See Also:

EmailListWriter, InventoryDiscrepancyFileWriter

Field Summary

static java.lang.String	CLASS_VERSION Class version string.
protected java.lang.Character	mDelimiter Delimiter.
protected java.lang.String	mFileDirectory File directory.
protected java.lang.String	mFileName File name.

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

StoreFileWriter()

Method Summary

java.lang.Character	getDelimiter()
java.lang.String	getFileDirectory()
java.lang.String	getFileName()
void	setDelimiter(java.lang.Character pDelimiter)
void	setFileDirectory(java.lang.String pFileDirectory)
void	setFileName(java.lang.String pFileName)
void	write(java.util.List pList) This is the method that is responsible for writing to a file.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string.

mDelimiter

protected java.lang.Character mDelimiter

Delimiter.

mFileDirectory

protected java.lang.String mFileDirectory

File directory.

mFileName

protected java.lang.String mFileName

File name.

Constructor Detail

StoreFileWriter

public StoreFileWriter()

Method Detail

getDelimiter

public java.lang.Character getDelimiter()

Returns:

the delimiter.

setDelimiter

public void setDelimiter(java.lang.Character pDelimiter)

Parameters:

pDelimiter - - the delimiter to set.

getFileDirectory

public java.lang.String getFileDirectory()

Returns:

the file directory.

setFileDirectory

public void setFileDirectory(java.lang.String pFileDirectory)

Parameters:

pFileDirectory - - the file directory to set.

getFileName

public java.lang.String getFileName()

Returns:

the file name.

setFileName

public void setFileName(java.lang.String pFileName)

Parameters:

pFileName - - the file name to set.

write

public void write(java.util.List pList)
           throws java.io.IOException

This is the method that is responsible for writing to a file. The list can contain any object type that is written to file.

Parameters:

pList - - list of items to write

Throws:

java.io.IOException - i/o exception