alma.acs.logging.table.reduction

Class ReductionRule

java.lang.Object

alma.acs.logging.table.reduction.ReductionRule

Direct Known Subclasses:

AntennaRule, SourceAntennaRule

public abstract class ReductionRule
extends java.lang.Object

The objects that implement this interface are those that reduces the logs.

The log passed in the constructor is compared with other logs with applyRule(ILogEntry). The log in the constructor is the base for the reduction that depends on the criteria implemented in a specific reduction rule.

If the rule is able to reduce logs (for example the message contains an antenna name) then other logs are passed to it through applyRule(ILogEntry): the rule keeps track of the logs it reduces in order to generate a new log replacing the log passed in the constructor and all the other logs. Such a log is returned by getReducedLog().

Author:

acaproni

Field Summary

Fields

Modifier and Type	Field and Description
protected ILogEntry	initialLog The log to be compared with other logs for reduction.
protected static java.lang.String	placeHolder The place holder for comparison

Constructor Summary

Constructors

Constructor and Description
ReductionRule(ILogEntry initialLog) Constructor

Method Summary

Modifier and Type	Method and Description
abstract boolean	applyRule(ILogEntry logToReduce) applyRule compares the log and the message and check if the log can be reduced.
abstract ILogEntry	getReducedLog() Return a comma separated list of the reduced items after running the reduction rule over a set of logs.
abstract boolean	isReducible()
abstract boolean	isReducingLogs()

Methods inherited from class java.lang.Object

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

Field Detail

initialLog

protected final ILogEntry initialLog

The log to be compared with other logs for reduction.

placeHolder

protected static final java.lang.String placeHolder

The place holder for comparison

See Also:

Constant Field Values

Constructor Detail

ReductionRule

public ReductionRule(ILogEntry initialLog)

Constructor

Parameters:

initialMessage - The message to be compared with other logs for reduction

Method Detail

isReducible

public abstract boolean isReducible()

Returns:

the reducible

applyRule

public abstract boolean applyRule(ILogEntry logToReduce)

applyRule compares the log and the message and check if the log can be reduced. If it is the case, the method returns a String representing the relevant part of the message to reduce

Parameters:

logToReduce - The log to reduce

Returns:

true if the logs is reduced by this rule false otherwise

getReducedLog

public abstract ILogEntry getReducedLog()

Return a comma separated list of the reduced items after running the reduction rule over a set of logs.

Returns:

A formatted String with all the reduced items

isReducingLogs

public abstract boolean isReducingLogs()

Returns:

true if this rule is actually reducing logs