net.sf.logdistiller
Class LogDistillation.Plugin

java.lang.Object
  net.sf.logdistiller.LogDistillation.Plugin

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FreqPlugin

Enclosing class:

LogDistillation

public abstract static class LogDistillation.Plugin
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

protected LogDistiller.Plugin	definition
protected LogDistillation.Group	group

Constructor Summary

LogDistillation.Plugin(LogDistiller.Plugin definition)

Method Summary

abstract void	addLogEvent(LogEvent le) Add a log event to this plugin instance.
void	addLogEvent(LogEvent le, Condition condition) Add a log event to this plugin instance, with information on which condition was matched.
abstract void	appendGlobalReport(ReportFormat.PluginReport report) Append a summary of this plugin instance results to the global report.
abstract void	appendGroupReport(ReportFormat.PluginReport report) Append a summary of this plugin instance results to the group report.
abstract void	begin(File destinationDirectory) Begin the log distillation for this plugin instance.
abstract void	end() End the log distillation for this plugin instance.
LogDistiller.Plugin	getDefinition()
LogDistillation.Group	getGroup()
String	getId()

Methods inherited from class java.lang.Object

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

Field Detail

definition

protected final LogDistiller.Plugin definition

group

protected transient LogDistillation.Group group

Constructor Detail

LogDistillation.Plugin

public LogDistillation.Plugin(LogDistiller.Plugin definition)

Method Detail

getGroup

public LogDistillation.Group getGroup()

getDefinition

public LogDistiller.Plugin getDefinition()

getId

public String getId()

begin

public abstract void begin(File destinationDirectory)
                    throws IOException

Begin the log distillation for this plugin instance.

Parameters:

destinationDirectory - the directory where reports will be stored.

Throws:

IOException

addLogEvent

public abstract void addLogEvent(LogEvent le)
                          throws IOException

Add a log event to this plugin instance.

Parameters:

le - the log event.

Throws:

IOException

addLogEvent

public void addLogEvent(LogEvent le,
                        Condition condition)
                 throws IOException

Add a log event to this plugin instance, with information on which condition was matched.

Parameters:

le - the log event.

condition - the condition which was matched

Throws:

IOException

Since:

1.1

end

public abstract void end()
                  throws IOException

End the log distillation for this plugin instance.

Throws:

IOException

appendGroupReport

public abstract void appendGroupReport(ReportFormat.PluginReport report)

Append a summary of this plugin instance results to the group report.

Parameters:

report - the plugin report formatter

appendGlobalReport

public abstract void appendGlobalReport(ReportFormat.PluginReport report)

Append a summary of this plugin instance results to the global report.

Parameters:

report - the plugin report formatter