Enum RecordSummaryFunctionType
- All Implemented Interfaces:
ValueEnum
,Serializable
,Comparable<RecordSummaryFunctionType>
,Constable
"summary" type ListGrid fields
. Record summary functions may be specified in one of two ways:
- as an explicit function or executable
StringMethod
. Takes 3 parameters:record
the record for which the value is being calculatedfields
Array of listGridFields from which summaries should be calculatedsummaryField
pointer to the summary type field on which the summary function is being run. - The
identifier of such a function or string method, either built-in or registered via
DataSource.registerRecordSummaryFunction()
DataSource.registerRecordSummaryFunction()
may be used to expand the set of registered record summary functions.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionIterates through each field, picking up the numeric field values from the record and calculating the mean value.Iterates through each field, picking up the numeric field values from the record and calculating the maximum value.Iterates through each field, picking up the numeric field values from the record and calculating the minimum value.Iterates through each field, picking up the numeric field values from the record and multiplying them together.Iterates through each field, picking up the numeric field values from the record and summing them. -
Method Summary
Modifier and TypeMethodDescriptiongetValue()
static RecordSummaryFunctionType
Returns the enum constant of this type with the specified name.static RecordSummaryFunctionType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
SUM
Iterates through each field, picking up the numeric field values from the record and summing them. This is the default ifListGridField.recordSummaryFunction
is not specified andListGridField.getRecordSummary()
is not implemented.If this enumerated value is used in a
Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "sum". -
AVG
Iterates through each field, picking up the numeric field values from the record and calculating the mean value.If this enumerated value is used in a
Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "avg". -
MAX
Iterates through each field, picking up the numeric field values from the record and calculating the maximum value.If this enumerated value is used in a
Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "max". -
MIN
Iterates through each field, picking up the numeric field values from the record and calculating the minimum value.If this enumerated value is used in a
Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "min". -
MULTIPLIER
Iterates through each field, picking up the numeric field values from the record and multiplying them together.If this enumerated value is used in a
Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "multiplier".
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-
getValue
-