|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.service.datacollection.DataCollectorService atg.service.datacollection.GenericSummarizer
public class GenericSummarizer
This is a data collector that summarizes data items into summary items which in turn can be queued or summarized further. How often the summarizer emits summary events can be controlled through the Schedulable interface, or by a maximum data item count threshhold, or both. For the convenience of users of LogListeners, a GenericSummarizer is also a LogListener. In practical terms, since most everything running in Dynamo is a GenericService, most everything has logListeners.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
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 | |
---|---|
GenericSummarizer()
|
Method Summary | |
---|---|
void |
addDataItem(java.lang.Object pDataItem)
Add a data item to the aggregate |
void |
addDataListener(DataListener pListener)
Adds a listener to the list of data listeners |
void |
doStartService()
Perform any necessary initializations to startup service. If a schedule is provided, then it is started. |
void |
doStopService()
Performs tasks required to shutdown service. |
int |
getBatchItemCount()
Returns property BatchItemCount |
int |
getDataItemThreshold()
Returns property DataItemThreshold |
int |
getDataListenerCount()
Returns the number of data listeners |
DataListener[] |
getDataListeners()
Returns the list of data listeners as an array property |
java.lang.String[] |
getGroupBy()
Returns property GroupBy |
java.lang.String |
getJobDescription()
Returns property JobDescription |
java.lang.String |
getJobName()
Returns property JobName |
Schedule |
getSchedule()
Returns property Schedule |
Scheduler |
getScheduler()
Returns property Scheduler |
int |
getTotalItemCount()
Returns property TotalItemCount |
void |
localFlush()
Flush summarized data to our listeners |
void |
logEvent(LogEvent pLogEvent)
Log an event. |
void |
performScheduledTask(Scheduler pScheduler,
ScheduledJob pJob)
Callback method for the scheduler. |
void |
removeDataListener(DataListener pListener)
Removes a listener from the list of data listeners |
void |
sendDataItem(java.lang.Object pDataItem)
Sends a data item to all of the listeners |
void |
setDataItemThreshold(int pDataItemThreshold)
Sets property DataItemThreshold |
void |
setGroupBy(java.lang.String[] pGroupBy)
Sets property GroupBy |
void |
setJobDescription(java.lang.String pJobDescription)
Sets property JobDescription |
void |
setJobName(java.lang.String pJobName)
Sets property JobName |
void |
setSchedule(Schedule pSchedule)
Sets property Schedule |
void |
setScheduler(Scheduler pScheduler)
Sets property Scheduler |
void |
setTotalItemCount(int pTotalItemCount)
Sets property TotalItemCount |
Methods inherited from class atg.service.datacollection.DataCollectorService |
---|
flush, flushListeners, isPropagateFlush, setPropagateFlush |
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 |
Methods inherited from interface atg.service.datacollection.DataCollector |
---|
flush |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public GenericSummarizer()
Method Detail |
---|
public void setTotalItemCount(int pTotalItemCount)
public int getTotalItemCount()
public int getBatchItemCount()
public void setGroupBy(java.lang.String[] pGroupBy)
public java.lang.String[] getGroupBy()
public void setScheduler(Scheduler pScheduler)
public Scheduler getScheduler()
public void setSchedule(Schedule pSchedule)
public Schedule getSchedule()
public void setJobName(java.lang.String pJobName)
public java.lang.String getJobName()
public void setJobDescription(java.lang.String pJobDescription)
public java.lang.String getJobDescription()
public void setDataItemThreshold(int pDataItemThreshold)
public int getDataItemThreshold()
public void sendDataItem(java.lang.Object pDataItem)
public void addDataListener(DataListener pListener)
public void removeDataListener(DataListener pListener)
public DataListener[] getDataListeners()
public int getDataListenerCount()
public void logEvent(LogEvent pLogEvent)
logEvent
in interface LogListener
pLogEvent
- the log eventpublic void addDataItem(java.lang.Object pDataItem)
addDataItem
in interface DataListener
pDataItem
- item to addpublic void performScheduledTask(Scheduler pScheduler, ScheduledJob pJob)
performScheduledTask
in interface Schedulable
pScheduler
- calling the jobpJob
- the ScheduledJobpublic void localFlush()
localFlush
in class DataCollectorService
public void doStartService() throws ServiceException
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting uppublic void doStopService() throws ServiceException
doStopService
in class DataCollectorService
ServiceException
- if the Service had a problem shutting down
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |