public enum SummaryFunctionType extends java.lang.Enum<SummaryFunctionType> implements ValueEnum
listGrid summary row, where a row is shown at the bottom
of the listGrid containing summary information about each column.Server Summaries feature or when Including values from multiple recordsFor the client-side SummaryFunctions may be specified in one of 2 ways:
StringMethod, which will be passed records (an array of records)
and field (the field definition for which the summary is required).Server Summaries overview, including how to implement custom summary
functions, not just builtin ones listed here (look for "Custom Aggregation" section).| Enum Constant and Description |
|---|
ARRAY
Client: The same approach as for "concat"but returning an array of the values, rather than a string
concatenation
Server: The same approach as for "concat", and with the same restrictons and limitations, but returning an array of the values, rather than a string concatenation. |
AVG
Client: iterates through the set of records, picking up all numeric values for the specified field and
determining the mean value.
|
CONCAT
Client: iterates through the set of records, producing a string with each value concatenated to the end.
Server: implemented as SQL CONCAT function by the Oracle database driver; other SQL drivers perform an additional query to fetch the values for concatenation. |
COUNT
Client: returns a numeric count of the total number of records passed in.
Server: acts exactly like SQL COUNT function. |
FIRST
Client: Currently the same as the min function.
Server: implemented as SQL MIN function. |
MAX
Client: iterates through the set of records, picking up all values for the specified field and finding the
maximum value.
|
MIN
Client: iterates through the set of records, picking up all values for the specified field and finding the
minimum value.
|
MULTIPLIER
Client: iterates through the set of records, picking up all numeric values for the specified field and
multiplying them together.
|
SUM
Client: iterates through the set of records, picking up and summing all numeric values for the specified field.
|
TITLE
Client: returns
field.summaryValueTitle if specified, otherwise field.titleServer: not supported. |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getValue() |
static SummaryFunctionType |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static SummaryFunctionType[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final SummaryFunctionType SUM
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "sum".
public static final SummaryFunctionType AVG
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "avg".
public static final SummaryFunctionType MAX
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "max".
public static final SummaryFunctionType MIN
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "min".
public static final SummaryFunctionType MULTIPLIER
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "multiplier".
public static final SummaryFunctionType COUNT
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "count".
public static final SummaryFunctionType TITLE
field.summaryValueTitle if specified, otherwise field.title
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "title".
public static final SummaryFunctionType FIRST
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "first".
public static final SummaryFunctionType CONCAT
allowAggregation documentation. Not supported by JPA or
Hibernate dataSources. Note: This function is only supported for DataSourceField.includeSummaryFunction; it is
not supported in other summary contexts, such as DSRequest.summaryFunctions. See also joinPrefix, joinString and joinSuffix related datasource field attributes.
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "concat".
public static final SummaryFunctionType ARRAY
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "array".
public static SummaryFunctionType[] values()
for (SummaryFunctionType c : SummaryFunctionType.values()) System.out.println(c);
public static SummaryFunctionType valueOf(java.lang.String name)
name - the name of the enum constant to be returned.java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null