com.day.cq.reporting

Enum ProcessingPhase

java.lang.Object

java.lang.Enum<ProcessingPhase>

com.day.cq.reporting.ProcessingPhase

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProcessingPhase>

public enum ProcessingPhase
extends java.lang.Enum<ProcessingPhase>

This enumeration defines the types of data processing phases available.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLY Apply the preprocessing to the raw data (keeping it all the way through processing)
APPLY_AFTER Apply the preprocessing to the completely processed data (grouped, aggregated, etc.; the processed data will be replaced accordingly)
FILTER Apply the preprocessing for filtering.
GROUP Apply the preprocessing for grouping.

Method Summary

Modifier and Type	Method and Description
boolean	applyValue() Checks if the formatted value should be applied to the data (versus being used for calculation only).
static ProcessingPhase	fromStringRep(java.lang.String stringRep) Creates a suitable ProcessingPhase from the specified string representation.
java.lang.String	getStringRep() Gets the string representation of the preprocessing module.
static ProcessingPhase	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ProcessingPhase[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

APPLY

public static final ProcessingPhase APPLY

Apply the preprocessing to the raw data (keeping it all the way through processing)

APPLY_AFTER

public static final ProcessingPhase APPLY_AFTER

Apply the preprocessing to the completely processed data (grouped, aggregated, etc.; the processed data will be replaced accordingly)

GROUP

public static final ProcessingPhase GROUP

Apply the preprocessing for grouping. The raw data will remain unchanged.

FILTER

public static final ProcessingPhase FILTER

Apply the preprocessing for filtering. The raw data will remain unchanged.

Method Detail

values

public static ProcessingPhase[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ProcessingPhase c : ProcessingPhase.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ProcessingPhase valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getStringRep

public java.lang.String getStringRep()

Gets the string representation of the preprocessing module.

Returns:

The string representation of the preprocessing module

applyValue

public boolean applyValue()

Checks if the formatted value should be applied to the data (versus being used for calculation only).

Returns:

true if the formatted value should be applied to the data

fromStringRep

public static ProcessingPhase fromStringRep(java.lang.String stringRep)

Creates a suitable ProcessingPhase from the specified string representation.

Parameters:

stringRep - The string representation

Returns:

The preprocessing type; null if an invalid string representation has been specified