WorkingMemoryFileLogger (Drools 4.0.0.11754MR2 API) - JBoss RULES 4.0.0.11754MR2 API 英文版文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.drools.audit
Class WorkingMemoryFileLogger

java.lang.Object
  org.drools.audit.WorkingMemoryLogger
      org.drools.audit.WorkingMemoryFileLogger

All Implemented Interfaces:: EventListener, AgendaEventListener, WorkingMemoryEventListener

public class WorkingMemoryFileLogger
extends WorkingMemoryLogger
extends WorkingMemoryLogger

A logger of events generated by a working memory. It stores its information in a file that can be specified. All the events logged are written to the file when the writeToDisk() method is invoked. The log will contain all the events logged serialized to XML using XStream. Every time a new logger is created, the old event log will be overwritten. TODO: make this class more scalable, for example - logging to several files if log becomes too large - automatically write updates to file at certain time intervals - ...

Author:: Kris Verlaenen

Constructor Summary

WorkingMemoryFileLogger(WorkingMemory workingMemory)
          Creates a new WorkingMemoryFileLogger for the given working memory.

Method Summary

void clear()
          Clears all the events in the log.

void finalize()


void logEventCreated(LogEvent logEvent)
          This method is invoked every time a new log event is created.

void setFileName(String fileName)
          Sets the name of the file the events are logged in.

void setMaxEventsInMemory(int maxEventsInMemory)
          Sets the maximum number of log events that are allowed in memory.

void writeToDisk()
          All events in the log are written to file.

Methods inherited from class org.drools.audit.WorkingMemoryLogger

activationCancelled, activationCreated, addFilter, afterActivationFired, agendaGroupPopped, agendaGroupPushed, beforeActivationFired, clearFilters, objectAsserted, objectModified, objectRetracted, removeFilter

Methods inherited from class java.lang.Object

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

Constructor Summary
`WorkingMemoryFileLogger(WorkingMemory workingMemory)` Creates a new WorkingMemoryFileLogger for the given working memory.

Method Summary
`void`	`clear()` Clears all the events in the log.
`void`	`finalize()`
`void`	`logEventCreated(LogEvent logEvent)` This method is invoked every time a new log event is created.
`void`	`setFileName(String fileName)` Sets the name of the file the events are logged in.
`void`	`setMaxEventsInMemory(int maxEventsInMemory)` Sets the maximum number of log events that are allowed in memory.
`void`	`writeToDisk()` All events in the log are written to file.

Methods inherited from class org.drools.audit.WorkingMemoryLogger
`activationCancelled, activationCreated, addFilter, afterActivationFired, agendaGroupPopped, agendaGroupPushed, beforeActivationFired, clearFilters, objectAsserted, objectModified, objectRetracted, removeFilter`

Methods inherited from class java.lang.Object
`clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

WorkingMemoryFileLogger

public WorkingMemoryFileLogger(WorkingMemory workingMemory)

Creates a new WorkingMemoryFileLogger for the given working memory.

Parameters:: workingMemory -

Method Detail

setFileName

public void setFileName(String fileName)

Sets the name of the file the events are logged in. No extensions should be given since .log is automatically appended to the file name. The default is an event.log file in the current working directory. This can be a path relative to the current working directory (e.g. "mydir/subDir/myLogFile"), or an absolute path (e.g. "C:/myLogFile").

Parameters:: fileName - The name of the file the events should be logged in.

writeToDisk

public void writeToDisk()

All events in the log are written to file. The log is automatically cleared afterwards.

clear

public void clear()

Clears all the events in the log.

setMaxEventsInMemory

public void setMaxEventsInMemory(int maxEventsInMemory)

Sets the maximum number of log events that are allowed in memory. If this number is reached, all events are written to file. The default is 1000.

Parameters:: maxEventsInMemory - The maximum number of events in memory.

logEventCreated

public void logEventCreated(LogEvent logEvent)

Description copied from class: WorkingMemoryLogger

This method is invoked every time a new log event is created. Subclasses should implement this method and store the event, like for example log to a file or database.

Specified by:: logEventCreated in class WorkingMemoryLogger

See Also:: WorkingMemoryLogger

finalize

public void finalize()

Overrides:: finalize in class Object