planetj.database.report
Class ReportPropertyGroup

java.lang.Object
  java.util.AbstractMap
      java.util.HashMap
          planetj.property.PropertyGroup
              planetj.property.DefaultPropertyGroup
                  planetj.database.report.ReportPropertyGroup

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, java.util.Map, java.io.Serializable

public class ReportPropertyGroup

extends DefaultPropertyGroup

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).
• reportSingleRow (optional) - Indicates if reports should be generated if there is only a single row of data to report upon. The default is false.
• reportBreakClass (optional) - The name of the Java class to use which provides report break functionality. This property should only be specified if you have created your own custom report break subclass
• evenCSSStyle (optional) - The name of the CSS style class applied to even report rows. The default value is pjr-r-e for normal report rows, and pjr-or-e for overall report rows. If this report break property group is used for both normal and overall report breaks, then the style for overall report breaks cannot be altered from the default. To specify a style for overall report breaks, you need to create a separate report break property group.
• oddCSSStyle (optional) - The name of the CSS style class applied to odd report rows. The default value is pjr-r-o for normal report rows, and pjr-or-o for overall report rows. If this report break property group is used for both normal and overall report breaks, then the style for overall report breaks cannot be altered from the default. To specify a style for overall report breaks, you need to create a separate report break property group.
• oddBlankCSSStyle (optional) - The name of the CSS style class applied to odd blank report rows. (A blank report row is used when a report row would normally be added, except that there is only one row overwhich to report.) The default value is not to apply any type of special style.
• evenBlankCSSStyle (optional) - The name of the CSS style class applied to even blank report rows. (A blank report row is used when a report row would normally be added, except that there is only one row overwhich to report.) The default value is not to apply any type of special style.
• javaClass (optional) - The name of the Java class to use which provides report break functionality. This property should only be specified if you have created your own custom report break subclass
• 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 java.lang.String	BREAK_COLUMNS
static java.lang.String	COLUMN_FUNCTIONS
static java.lang.String	COLUMNS
static java.util.List	COLUMNS_ALL A special value indicating that the column function(s) should be applied to all columns
static java.lang.String	EVEN_BLANK_CSS_STYLE
static java.lang.String	EVEN_CSS_STYLE
static java.lang.String	JAVA_CLASS
static java.lang.String	ODD_BLANK_CSS_STYLE
static java.lang.String	ODD_CSS_STYLE
static java.lang.String	OVERALL
static java.lang.String	REPORT_BREAK
static java.lang.String	REPORT_SINGLE_ROW

Fields inherited from class planetj.property.PropertyGroup

ALL, ALL_FALSE, ALL_TRUE, BOOLEAN_PROPERTY, DATE_PROPERTY, DOUBLE_PROPERTY, FLOAT_PROPERTY, INTEGER_PROPERTY, JAVA_CLASS_PROPERTY, LIST_PROPERTY, MAP_PROPERTY, NONE, ROW_COLLECTION_KEY, STRING_PROPERTY

Constructor Summary

ReportPropertyGroup()
ReportPropertyGroup constructor

ReportPropertyGroup(java.lang.String pName)
ReportPropertyGroup constructor

Method Summary

void	addReportBreaks(ReportBreakCollection pRBC) Populates a ReportBreakCollection with ReportBreak objects, based on the Properties contained in this ReportPropertyGroup.
java.util.List	getAllPropertyNames() Gets a List containing the names of all the supported properties
java.util.List	getColumns() Gets the columns for which reports should be generated
java.lang.String	getDefaultPropertiesString() Gets a default String for this property group.
java.lang.Class	getJavaClass() Gets the Java Class for the report break
java.util.List	getRequiredPropertyNames() Gets a List containing the names of all the required properties
boolean	isGenerateReportForSingleRow() Should reports be generated for a single row?
boolean	isOverall() Should an overall report be generated?
protected short	propertyType(java.lang.String pPropertyName) Gets the type of property for a specified property name.
protected void	validate() Ensures that everything is okay with the property group

Methods inherited from class planetj.property.PropertyGroup

add, addProperty, addProperty, append, clone, compareTo, compareTo, compareTo, containsProperty, copyUndefinedPropertiesFrom, createProperty, createValue, getAllMetapropertyNames, getAllSetBooleanPropertyNames, getAllSetIntPropertyNames, getAllSetListPropertyNames, getAllSetPropertyNames, getAllSetStringPropertyNames, getBooleanValue, getDateFormat, getDateValue, getDoubleValue, getFloatValue, getIntValue, getJavaClassValue, getListValue, getMapValue, getName, getProperty, getPropertyType, getStringValue, getValue, isMergeableOnList, isMetaproperty, iterator, mergeOnList, metapropertyType, put, put, put, setName, toString, updateProperty, validateMetadata, validateMetadataBoolean

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

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

REPORT_BREAK

public static final java.lang.String REPORT_BREAK

See Also:

Constant Field Values

COLUMNS

public static final java.lang.String COLUMNS

See Also:

Constant Field Values

BREAK_COLUMNS

public static final java.lang.String BREAK_COLUMNS

See Also:

Constant Field Values

OVERALL

public static final java.lang.String OVERALL

See Also:

Constant Field Values

COLUMN_FUNCTIONS

public static final java.lang.String COLUMN_FUNCTIONS

See Also:

Constant Field Values

REPORT_SINGLE_ROW

public static final java.lang.String REPORT_SINGLE_ROW

See Also:

Constant Field Values

EVEN_CSS_STYLE

public static final java.lang.String EVEN_CSS_STYLE

See Also:

Constant Field Values

ODD_CSS_STYLE

public static final java.lang.String ODD_CSS_STYLE

See Also:

Constant Field Values

EVEN_BLANK_CSS_STYLE

public static final java.lang.String EVEN_BLANK_CSS_STYLE

See Also:

Constant Field Values

ODD_BLANK_CSS_STYLE

public static final java.lang.String ODD_BLANK_CSS_STYLE

See Also:

Constant Field Values

JAVA_CLASS

public static final java.lang.String JAVA_CLASS

See Also:

Constant Field Values

COLUMNS_ALL

public static final java.util.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(java.lang.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.

Throws:

DataEngineException

getAllPropertyNames

public java.util.List getAllPropertyNames()

Gets a List containing the names of all the supported properties

Overrides:

getAllPropertyNames in class DefaultPropertyGroup

getColumns

public java.util.List getColumns()

Gets the columns for which reports should be generated

getDefaultPropertiesString

public java.lang.String getDefaultPropertiesString()

Description copied from class: DefaultPropertyGroup

Gets a default String for this property group. All properties are listed without any values.

Overrides:

getDefaultPropertiesString in class DefaultPropertyGroup

getJavaClass

public java.lang.Class getJavaClass()

Gets the Java Class for the report break

getRequiredPropertyNames

public java.util.List getRequiredPropertyNames()

Gets a List containing the names of all the required properties

Overrides:

getRequiredPropertyNames in class DefaultPropertyGroup

isGenerateReportForSingleRow

public boolean isGenerateReportForSingleRow()

Should reports be generated for a single row?

isOverall

public boolean isOverall()

Should an overall report be generated?

propertyType

protected short propertyType(java.lang.String pPropertyName)

Gets the type of property for a specified property name.

Overrides:

propertyType in class DefaultPropertyGroup

validate

protected void validate()
                 throws ValidationException

Ensures that everything is okay with the property group

Overrides:

validate in class PropertyGroup

Throws:

ValidationException