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: 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
• 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

Field Summary

static String	ID
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

protected net.sf.logdistiller.plugins.FreqPlugin.Freq	addFreqLogEvent(LogEvent logEvent)
protected void	addLinkIntoReport(ReportFormat.PluginReport report)
void	addLogEvent(LogEvent logEvent)
void	appendGlobalReport(ReportFormat.PluginReport report)
void	appendGroupReport(ReportFormat.PluginReport report)
void	begin(File destinationDirectory)
void	end()

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

addLogEvent, getDefinition, getGroup

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

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

Specified by:

begin in class LogDistillation.Plugin

Throws:

FileNotFoundException

addLogEvent

public void addLogEvent(LogEvent logEvent)
                 throws IOException

Specified by:

addLogEvent in class LogDistillation.Plugin

Throws:

IOException

addFreqLogEvent

protected net.sf.logdistiller.plugins.FreqPlugin.Freq addFreqLogEvent(LogEvent logEvent)
                                                               throws IOException

Throws:

IOException

end

public void end()
         throws IOException

Specified by:

end in class LogDistillation.Plugin

Throws:

IOException

appendGroupReport

public void appendGroupReport(ReportFormat.PluginReport report)

Specified by:

appendGroupReport in class LogDistillation.Plugin

appendGlobalReport

public void appendGlobalReport(ReportFormat.PluginReport report)

Specified by:

appendGlobalReport in class LogDistillation.Plugin

addLinkIntoReport

protected void addLinkIntoReport(ReportFormat.PluginReport report)