com.day.cq.reporting

Enum FilteringPhase

java.lang.Object

java.lang.Enum<FilteringPhase>

com.day.cq.reporting.FilteringPhase

All Implemented Interfaces:

Serializable, Comparable<FilteringPhase>

public enum FilteringPhase
extends Enum<FilteringPhase>

This enumeration defines the phases of filtering,

Enum Constant Summary

Enum Constants

Enum Constant and Description
PREPROCESSED Filtering is applied on data that has already been pre-processed using the configured Processors
RAW Filtering is applied on raw data
RESOLVED Filtering is applied on data that has been resolved using the configured ValueResolvers

Method Summary

Modifier and Type	Method and Description
static FilteringPhase	fromTransferString(String transferStr) Gets a suitable FilteringPhase for the specified transfer representation.
String	getTransferStr() Gets the string representation used for data transfer.
static FilteringPhase	valueOf(String name) Returns the enum constant of this type with the specified name.
static FilteringPhase[]	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

RAW

public static final FilteringPhase RAW

Filtering is applied on raw data

PREPROCESSED

public static final FilteringPhase PREPROCESSED

Filtering is applied on data that has already been pre-processed using the configured Processors

RESOLVED

public static final FilteringPhase RESOLVED

Filtering is applied on data that has been resolved using the configured ValueResolvers

Method Detail

values

public static FilteringPhase[] 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 (FilteringPhase c : FilteringPhase.values())
    System.out.println(c);

Returns:

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

valueOf

public static FilteringPhase valueOf(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:

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

NullPointerException - if the argument is null

getTransferStr

public String getTransferStr()

Gets the string representation used for data transfer.

Returns:

The string representation used for data transfer

fromTransferString

public static FilteringPhase fromTransferString(String transferStr)

Gets a suitable FilteringPhase for the specified transfer representation.

Parameters:

transferStr - The transfer string

Returns:

the matching FilteringPhase for the specified transfer representation