net.sf.logdistiller.plugins
Class FreqPlugin

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SamplingPlugin

public class FreqPlugin
extends LogDistillation.Plugin

Counts the frequency of each attribute's value.

Parameters:

• value (deprecated since 1.1): definition of the value that will be taken into account
  • attribute (mandatory): the attribute's name
  • regexp: use a regexp to extract value taken in account for the first attribute
  • regexp.group (default: -1): which group to extract? If negative, all groups will be concatenated
  • attribute2 (default: none): second attribute to append
  • attribute3 (default: none): third attribute to append
• value: definition of the value that will be taken into account
  • attributes (mandatory): the attributes' names, comma separated (no count limit)
• sorting options
  • sortItem (default: count): sort on which item? count, value, valueLength
  • reverseOrder (default: false): by default, most frequent value are displayed first
• reporting
  • valueDescriptions: description to insert in the report instead of corresponding value (in java properties format)
  • maxGlobalReport (default: 5): maximum number of values inserted in global report
  • maxGroupReport (default: 25): maximum number of values inserted in group report

Since:

0.6

See Also:

SamplingPlugin, Serialized Form

Nested Class Summary

static class

FreqPlugin.Freq

Field Summary

protected String[]	attributes
protected LogType.AttributeInfo[]	attributesInfo
static String	ID
protected SortedSet	sorted
static Plugin	TYPE

Fields inherited from class net.sf.logdistiller.LogDistillation.Plugin

definition, group

Constructor Summary

	FreqPlugin(LogDistiller.Plugin definition)
protected	FreqPlugin(LogDistiller.Plugin definition, boolean checkSampling)

Method Summary

void	addLogEvent(LogEvent logEvent) Add a log event to this plugin instance.
protected void	addLogEventToFreq(LogEvent logEvent, FreqPlugin.Freq freq)
void	appendGlobalReport(ReportFormat.PluginReport report) Append a summary of this plugin instance results to the global report.
void	appendGroupReport(ReportFormat.PluginReport report) Append a summary of this plugin instance results to the group report.
protected void	appendLinkToFreqReport(ReportFormat.PluginReport report) Append links to freq reports, for freq extensions.
void	begin(File destinationDirectory) Begin the log distillation for this plugin instance.
void	end() End the log distillation for this plugin instance.

Methods inherited from class net.sf.logdistiller.LogDistillation.Plugin

addLogEvent, getDefinition, getGroup, getId

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

TYPE

public static final Plugin TYPE

sorted

protected SortedSet sorted

attributes

protected final String[] attributes

Since:

1.1

attributesInfo

protected transient LogType.AttributeInfo[] attributesInfo

Constructor Detail

FreqPlugin

public FreqPlugin(LogDistiller.Plugin definition)

FreqPlugin

protected FreqPlugin(LogDistiller.Plugin definition,
                     boolean checkSampling)

Method Detail

begin

public void begin(File destinationDirectory)
           throws FileNotFoundException

Description copied from class: LogDistillation.Plugin

Begin the log distillation for this plugin instance.

Specified by:

begin in class LogDistillation.Plugin

Parameters:

destinationDirectory - the directory where reports will be stored.

Throws:

FileNotFoundException

addLogEvent

public void addLogEvent(LogEvent logEvent)
                 throws IOException

Description copied from class: LogDistillation.Plugin

Add a log event to this plugin instance.

Specified by:

addLogEvent in class LogDistillation.Plugin

Parameters:

logEvent - the log event.

Throws:

IOException

addLogEventToFreq

protected void addLogEventToFreq(LogEvent logEvent,
                                 FreqPlugin.Freq freq)
                          throws IOException

Throws:

IOException

Since:

1.1

end

public void end()
         throws IOException

Description copied from class: LogDistillation.Plugin

End the log distillation for this plugin instance.

Specified by:

end in class LogDistillation.Plugin

Throws:

IOException

appendGroupReport

public void appendGroupReport(ReportFormat.PluginReport report)

Description copied from class: LogDistillation.Plugin

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

Specified by:

appendGroupReport in class LogDistillation.Plugin

Parameters:

report - the plugin report formatter

appendGlobalReport

public void appendGlobalReport(ReportFormat.PluginReport report)

Description copied from class: LogDistillation.Plugin

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

Specified by:

appendGlobalReport in class LogDistillation.Plugin

Parameters:

report - the plugin report formatter

appendLinkToFreqReport

protected void appendLinkToFreqReport(ReportFormat.PluginReport report)

Append links to freq reports, for freq extensions.

Parameters:

report - the report formatter