atg.projects.store.inventory
Class InventoryDiscrepancyFileWriter

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.projects.store.io.StoreFileWriter
              extended by atg.projects.store.inventory.InventoryDiscrepancyFileWriter
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

public class InventoryDiscrepancyFileWriter
extends StoreFileWriter

This class is used when a "ATPC" inventory file is processed. The "ATPC" (acronym for Ability To Promise Count) files are processed by the DailyInventoryFileReader. If there is a discrepancy between the incoming inventory level, and the inventory level in the ATG inventory repository, then an "InventoryDiscrepancyMessage" is created. This class will take these messages, and create the file, and write it to the NFS-mounted SAP directory.

The SAP team has explained that they never use the existing discrepancy file. This is really just for tracking down an issue if the inventories become wildly out of synch, and is not used in day-to-day operations.


Field Summary
static java.lang.String CLASS_VERSION
          Class version string.
protected  java.lang.String mPrefix
          Default prefix.
 
Fields inherited from class atg.projects.store.io.StoreFileWriter
mDelimiter, mFileDirectory, mFileName
 
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
InventoryDiscrepancyFileWriter()
           
 
Method Summary
 java.lang.String createDiscrepancyLine(InventoryDiscrepancyMessage pMessage)
          Creates a line to add to the discrepancy file.
 java.lang.String getPrefix()
           
 void setPrefix(java.lang.String pPrefix)
           
 void write(java.util.List pList)
           This method iterates through the passed in list of InventoryDiscrepancyMessage beans and writes the bean contents to a flat file on the file system.
 
Methods inherited from class atg.projects.store.io.StoreFileWriter
getDelimiter, getFileDirectory, getFileName, setDelimiter, setFileDirectory, setFileName
 
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.


mPrefix

protected java.lang.String mPrefix
Default prefix.

Constructor Detail

InventoryDiscrepancyFileWriter

public InventoryDiscrepancyFileWriter()
Method Detail

getPrefix

public java.lang.String getPrefix()
Returns:
the prefix.

setPrefix

public void setPrefix(java.lang.String pPrefix)
Parameters:
pPrefix - - the prefix to set.

write

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

This method iterates through the passed in list of InventoryDiscrepancyMessage beans and writes the bean contents to a flat file on the file system.

As with all FileWriters in the system, this one uses the configured "FileDirectory" to determine the location to write the file. Each file has the timestamp appended to it.

Overrides:
write in class StoreFileWriter
Parameters:
pList - - list
Throws:
java.io.IOException - if IO error occurs
See Also:
InventoryDiscrepancyMessage

createDiscrepancyLine

public java.lang.String createDiscrepancyLine(InventoryDiscrepancyMessage pMessage)
Creates a line to add to the discrepancy file.

Parameters:
pMessage - - new message to add
Returns:
resulted string with message