Project: stp

com.ibm.rational.wvcm.stp.cq
Enum CqQuery.DisplayField.Aggregation

Object
  extended by Enum<CqQuery.DisplayField.Aggregation>
      extended by CqQuery.DisplayField.Aggregation
All Implemented Interfaces:
com.ibm.rational.wvcm.stpex.StpExEnumeration, Serializable, Comparable<CqQuery.DisplayField.Aggregation>
Enclosing interface:
CqQuery.DisplayField

public static enum CqQuery.DisplayField.Aggregation
extends Enum<CqQuery.DisplayField.Aggregation>
implements com.ibm.rational.wvcm.stpex.StpExEnumeration

Supported display field aggregate functions. When these aggregate functions are used, the result set will have only one row. The value in the column of that row will be computed as a function of the values in this display field in all records selected by the query filter.


Enum Constant Summary
AVERAGE
          The average of the field values associated with this column
COUNT
          The number of non-null field values associated with this column.
MAXIMUM
          The maximum value of the field values associated with this column
MINIMUM
          The minimum value of the field values associated with this column
NO_AGGREGATION
          The column is not aggregated
SUM
          The sum of the field values associated with his column
 
Method Summary
static CqQuery.DisplayField.Aggregation valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CqQuery.DisplayField.Aggregation[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

AVERAGE

public static final CqQuery.DisplayField.Aggregation AVERAGE
The average of the field values associated with this column


COUNT

public static final CqQuery.DisplayField.Aggregation COUNT
The number of non-null field values associated with this column.


MAXIMUM

public static final CqQuery.DisplayField.Aggregation MAXIMUM
The maximum value of the field values associated with this column


MINIMUM

public static final CqQuery.DisplayField.Aggregation MINIMUM
The minimum value of the field values associated with this column


NO_AGGREGATION

public static final CqQuery.DisplayField.Aggregation NO_AGGREGATION
The column is not aggregated


SUM

public static final CqQuery.DisplayField.Aggregation SUM
The sum of the field values associated with his column

Method Detail

valueOf

public static CqQuery.DisplayField.Aggregation 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

values

public static final CqQuery.DisplayField.Aggregation[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(CqQuery.DisplayField.Aggregation c : CqQuery.DisplayField.Aggregation.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

Generated Mon 2-Mar-2009 11:14 PM

Copyright © IBM 2009. All rights reserved.