planetj.database.report
Class ReportPropertyGroup

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--java.util.HashMap
              |
              +--planetj.property.PropertyGroup
                    |
                    +--planetj.database.report.ReportPropertyGroup

All Implemented Interfaces:

Cloneable, Comparable, Map, Serializable

public class ReportPropertyGroup

extends PropertyGroup

Contains Property objects which specify one or more ReportBreak objects. The following properties are supported:

• columns - A list of the columns on which the column functions will operate
• breakColumns (optional property) - A list of the columns to break on. If this property is not specified, then overall reports will be generated
• overall (optional) - A boolean property specifying whether or not overall reports should be generated generated in addition to the normal reports. The default is true. This property is ignored if no break columns are specified (because that means that only overall reports will be generated).
• columnFunctions - A list of the column functions which will be used to generate reports. Currently the following column functions are supported:
  1. AVG
  2. COUNT
  3. MAX
  4. MIN
  5. SUM
  6. TOTAL (same effect as SUM)

See Also:

Serialized Form

Field Summary

static String	BREAK_COLUMNS
static String	COLUMN_FUNCTIONS
static String	COLUMNS
static List	COLUMNS_ALL A special value indicating that the column function(s) should be applied to all columns
static String	OVERALL
static String	REPORT_BREAK

Fields inherited from class planetj.property.PropertyGroup

ALL_FALSE, ALL_TRUE, BOOLEAN_PROPERTY, DATE_PROPERTY, DOUBLE_PROPERTY, INTEGER_PROPERTY, LIST_PROPERTY, ROW_COLLECTION_KEY, STRING_PROPERTY

Constructor Summary

ReportPropertyGroup()
ReportPropertyGroup constructor

ReportPropertyGroup(String pName)
ReportPropertyGroup constructor

Method Summary

void	addReportBreaks(ReportBreakCollection pRBC) Populates a ReportBreakCollection with ReportBreak objects, based on the Properties contained in this ReportPropertyGroup.
List	getAllPropertyNames() Gets a List containing the names of all the supported properties
List	getRequiredPropertyNames() Gets a List containing the names of all the required properties

Methods inherited from class planetj.property.PropertyGroup

add, addProperty, addProperty, append, clone, compareTo, compareTo, compareTo, containsProperty, createProperty, getAllMetapropertyNames, getAllSetBooleanPropertyNames, getAllSetIntPropertyNames, getAllSetListPropertyNames, getAllSetPropertyNames, getAllSetStringPropertyNames, getBooleanValue, getDateValue, getDoubleValue, getIntValue, getListValue, getName, getProperty, getPropertyType, getStringValue, getValue, isMergeableOnList, isMetaproperty, iterator, mergeOnList, put, put, put, setName, toString, updateProperty

Methods inherited from class java.util.HashMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

REPORT_BREAK

public static final String REPORT_BREAK

See Also:

Constant Field Values

COLUMNS

public static final String COLUMNS

See Also:

Constant Field Values

BREAK_COLUMNS

public static final String BREAK_COLUMNS

See Also:

Constant Field Values

OVERALL

public static final String OVERALL

See Also:

Constant Field Values

COLUMN_FUNCTIONS

public static final String COLUMN_FUNCTIONS

See Also:

Constant Field Values

COLUMNS_ALL

public static final List COLUMNS_ALL

A special value indicating that the column function(s) should be applied to all columns

Constructor Detail

ReportPropertyGroup

public ReportPropertyGroup()

ReportPropertyGroup constructor

ReportPropertyGroup

public ReportPropertyGroup(String pName)

ReportPropertyGroup constructor

Method Detail

addReportBreaks

public void addReportBreaks(ReportBreakCollection pRBC)
                     throws DataEngineException

Populates a ReportBreakCollection with ReportBreak objects, based on the Properties contained in this ReportPropertyGroup. A single ReportPropertyGroup can correspond to mulitple ReportBreak objects.

DataEngineException

getAllPropertyNames

public List getAllPropertyNames()

Gets a List containing the names of all the supported properties

Specified by:

getAllPropertyNames in class PropertyGroup

getRequiredPropertyNames

public List getRequiredPropertyNames()

Gets a List containing the names of all the required properties

Specified by:

getRequiredPropertyNames in class PropertyGroup