com.archibus.datasource

Class DataSourceGroupingImpl

java.lang.Object

com.archibus.datasource.DataSourceImpl

com.archibus.datasource.DataSourceGroupingImpl

All Implemented Interfaces:

DataSource

public class DataSourceGroupingImpl
extends DataSourceImpl

DataSource implementation that supports groupBy fields.

Nested Class Summary

Nested classes/interfaces inherited from class com.archibus.datasource.DataSourceImpl

DataSourceImpl.Parameter, DataSourceImpl.SortField, DataSourceImpl.TableAndRole

Nested classes/interfaces inherited from interface com.archibus.datasource.DataSource

DataSource.RecordHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<com.archibus.datasource.VirtualFieldDef>	calculatedGroupingFieldDefs List of calculated grouping field definitions.
static java.lang.String	FORMULA_AVG
static java.lang.String	FORMULA_COUNT
static java.lang.String	FORMULA_COUNT_PERCENT
static java.lang.String	FORMULA_DAY
static java.lang.String	FORMULA_MAX
static java.lang.String	FORMULA_MIN
static java.lang.String	FORMULA_MONTH
static java.lang.String	FORMULA_QUARTER
static java.lang.String	FORMULA_SUM Supported aggregate field formulas.
static java.lang.String	FORMULA_SUM_PERCENT Additional aggregate formulas not supported by SQL-99.
static java.lang.String	FORMULA_WEEK
static java.lang.String	FORMULA_YEAR Supported aggregate field formulas for temporal groupings.
protected java.util.List<java.lang.String>	groupingFieldNames List of fully qualified names of simple (non-calculated) grouping fields.

Fields inherited from class com.archibus.datasource.DataSourceImpl

applyVpaRestrictions, basicRulesLog, calculatedFieldDefs, CASCADE_HANDLER, cascadeHandler, customSqlQueries, database, databaseRole, dataSourceDef, doNotWrapCustomSql, eventHandlerContext, expressionContext, fieldNames, fieldNamesForNewRecord, hasMoreRecords, isAutoCommit, isDistinct, keyFieldsByFullName, locale, log, mainTableDef, mainTableName, maxRecords, parameters, parametersChanged, parentContext, persistentRestrictions, primaryKeyFields, project, query, restrictions, restrictionValues, SCRIPT_INJECTION_HANDLER, scriptInjectionHandler, sortFields, SQL_INJECTION_HANDLER, sqlInjectionHandler, standardQueries, tablesAndRoles, useHierarchicalSecurityRestriction, virtualFieldDefs, virtualFields, visibleFields, visibleFieldsByName

Fields inherited from interface com.archibus.datasource.DataSource

DATA_TYPE_BOOLEAN, DATA_TYPE_CURRENCY, DATA_TYPE_DATE, DATA_TYPE_DOUBLE, DATA_TYPE_INTEGER, DATA_TYPE_MEMO, DATA_TYPE_NUMBER, DATA_TYPE_TEXT, DATA_TYPE_TIME, DATA_TYPE_VERBATIM, DB_ROLE_DATA, DB_ROLE_SCHEMA, DB_ROLE_SECURITY, ROLE_MAIN, ROLE_STANDARD, SORT_ASC, SORT_DESC

Constructor Summary

Constructors

Constructor and Description
DataSourceGroupingImpl()

Method Summary

Modifier and Type	Method and Description
DataSource	addCalculatedField(java.lang.String table, java.lang.String name, java.lang.String dataType, int size, int decimals, java.lang.String formula, java.lang.String baseField) Adds a calculated numeric field.
DataSource	addCalculatedField(java.lang.String table, java.lang.String name, java.lang.String dataType, java.lang.String formula, java.lang.String baseField) Adds a calculated field.
DataSource	addCalculatedGroupByField(com.archibus.datasource.VirtualFieldDef groupingField) Adds a calculated grouping field.
DataSource	addGroupByField(java.lang.String table, java.lang.String name, java.lang.String dataType) Adds a simple grouping field.
DataSource	createCopy() Creates and returns a copy of this data source.
com.archibus.datasource.data.DataRecord	createRecord() Creates new DataRecord with default values for all fields defined in the data source.
void	deleteRecord(com.archibus.datasource.data.DataRecord record) Override for DataSourceImpl.deleteRecord().
void	deleteRecord(java.util.Map fieldValues) Override for DataSourceImpl.deleteRecord().
protected void	evaluateSqlExpressions() Evaluates expressions in custom SQL queries.
java.lang.String	formatSqlQueryForSubtotals(java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> clientRestrictions, java.lang.String groupingFieldName) Formats SQL query for totals.
java.lang.String	formatSqlQueryForSubtotals(java.lang.String restrictionString, java.lang.String groupingFieldName) Formats SQL query for totals.
java.lang.String	formatSqlQueryForTotals(java.lang.String restrictionString) Formats SQL query for totals.
java.util.List<java.lang.String>	getAllGroupingFieldNames() Returns the list of full names for calculated and non-calculated grouping fields.
java.util.List	getDbFieldsForSubtotals(java.lang.String groupingFieldName) Returns the list of fields for the sub-totals query.
java.util.List	getDbFieldsForTotals() Returns the list of fields for the totals query.
java.util.List<java.lang.String>	getGroupingFieldNames() Returns the list of full names for non-calculated grouping fields.
java.util.Set<com.archibus.schema.LookupFieldMapping>	getLookupFieldDefs() Returns all lookup field definitions for this data source.
protected com.archibus.datasource.DataSourceQueryImpl	getQueryInstance(com.archibus.config.Database.Immutable database) Returns new query instance.
java.util.List<com.archibus.datasource.data.DataRecord>	getSubtotals(java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> clientRestrictions, java.lang.String groupingFieldName) Retrieve records that contains subtotals for all calculated fields and specified grouping field.
java.util.List<com.archibus.datasource.data.DataRecord>	getSubtotals(java.lang.String restriction, java.lang.String groupingFieldName) Retrieve records that contains subtotals for all calculated fields and specified grouping field.
com.archibus.datasource.data.DataRecord	getTotals(java.lang.String restriction) Retrieve records that contains totals for all calculated fields.
com.archibus.datasource.data.DataRecord	saveRecord(com.archibus.datasource.data.DataRecord record) Override for DataSourceImpl.saveRecord().
boolean	useVirtualFields() Returns true if virtual fields must be used instead of visible fields to handle JDBC resultset (always for grouping DataSource).

Methods inherited from class com.archibus.datasource.DataSourceImpl

addCalculatedField, addField, addField, addField, addField, addParameter, addParameter, addParameter, addParameter, addPersistentRestrictions, addQuery, addQuery, addRestriction, addRestriction, addRestrictionsToQuery, addSort, addSort, addSort, addTable, addTable, addVirtualField, addVirtualField, addVirtualField, checkAutoCommit, checkSetContext, clearRestrictions, commit, copyProperties, createNewRecord, createPrimaryKeyIds, createRecordFromContext, createSqlForLastAddedPK, createVirtualField, createVirtualViewField, enableIdLookup, evaluateExpressions, executeUpdate, executeUpdateRequired, findField, findKeyField, findTable, findVirtualField, formatJoin, formatSqlForPersistentRestrictions, formatSqlForPersistentRestrictionsForTable, formatSqlForPersistentRestrictionsForTableAndRole, formatSqlForRestriction, formatSqlQuery, formatSqlQuery, formatSqlQuery, formatSqlQuery, formatSqlQueryForField, getAllFields, getAllRecords, getCalculatedFieldDef, getContext, getDatabaseRole, getDataSourceDef, getDbFieldsForNewRecord, getDbFieldsForPrimaryKeys, getDbFieldsForPrimaryKeysAsMap, getDbFieldsForVisibleFields, getDefaultRecord, getFieldNames, getId, getMainTableDef, getMainTableName, getParameters, getPKeyFieldNamesForTable, getPrimaryKeyFieldNamesForTable, getPrimaryKeyFields, getQueries, getRecord, getRecord, getRecords, getRecords, getRecords, getRecords, getRecords, getRecords, getRestrictionRelativeOperation, getRestrictions, getRestrictionValues, getSortFields, getTablesAndRoles, getTitle, getViewName, getVirtualFieldDef, getVirtualFields, getVisibleFields, getVisibleFieldsByName, hasCustomQuery, hasMoreRecords, hasVirtualFields, isDistinct, isIdLookupEnabled, isOracle, isSqlServer, isSybase, parseClientRestrictions, queryRecords, queryRecords, rollback, setApplyVpaRestrictions, setAutoCommit, setContext, setContext, setContext, setDatabaseRole, setDataSourceDef, setDistinct, setDoNotWrapCustomSql, setId, setMaxRecords, setParameter, setRestrictionRelativeOperation, setTitle, setUseHierarchicalSecurityRestriction, setViewName, updateRecord, useCascadeHandler

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORMULA_SUM

public static final java.lang.String FORMULA_SUM

Supported aggregate field formulas. Match SQL-99 aggregate functions.

See Also:

Constant Field Values

FORMULA_COUNT

public static final java.lang.String FORMULA_COUNT

See Also:

Constant Field Values

FORMULA_AVG

public static final java.lang.String FORMULA_AVG

See Also:

Constant Field Values

FORMULA_MIN

public static final java.lang.String FORMULA_MIN

See Also:

Constant Field Values

FORMULA_MAX

public static final java.lang.String FORMULA_MAX

See Also:

Constant Field Values

FORMULA_SUM_PERCENT

public static final java.lang.String FORMULA_SUM_PERCENT

Additional aggregate formulas not supported by SQL-99.

See Also:

Constant Field Values

FORMULA_COUNT_PERCENT

public static final java.lang.String FORMULA_COUNT_PERCENT

See Also:

Constant Field Values

FORMULA_YEAR

public static final java.lang.String FORMULA_YEAR

Supported aggregate field formulas for temporal groupings.

See Also:

Constant Field Values

FORMULA_QUARTER

public static final java.lang.String FORMULA_QUARTER

See Also:

Constant Field Values

FORMULA_MONTH

public static final java.lang.String FORMULA_MONTH

See Also:

Constant Field Values

FORMULA_WEEK

public static final java.lang.String FORMULA_WEEK

See Also:

Constant Field Values

FORMULA_DAY

public static final java.lang.String FORMULA_DAY

See Also:

Constant Field Values

groupingFieldNames

protected java.util.List<java.lang.String> groupingFieldNames

List of fully qualified names of simple (non-calculated) grouping fields.

calculatedGroupingFieldDefs

protected final java.util.List<com.archibus.datasource.VirtualFieldDef> calculatedGroupingFieldDefs

List of calculated grouping field definitions.

Constructor Detail

DataSourceGroupingImpl

public DataSourceGroupingImpl()

Method Detail

getGroupingFieldNames

public java.util.List<java.lang.String> getGroupingFieldNames()

Returns the list of full names for non-calculated grouping fields.

Returns:

The list of full field names.

getAllGroupingFieldNames

public java.util.List<java.lang.String> getAllGroupingFieldNames()

Returns the list of full names for calculated and non-calculated grouping fields.

Returns:

The list of full field names.

addGroupByField

public DataSource addGroupByField(java.lang.String table,
                                  java.lang.String name,
                                  java.lang.String dataType)

Adds a simple grouping field.

Parameters:

table - The table name.

name - The field name.

dataType - The data type.

Returns:

This data source.

addCalculatedGroupByField

public DataSource addCalculatedGroupByField(com.archibus.datasource.VirtualFieldDef groupingField)

Adds a calculated grouping field.

Parameters:

groupingField - The field definition.

Returns:

This data source.

addCalculatedField

public DataSource addCalculatedField(java.lang.String table,
                                     java.lang.String name,
                                     java.lang.String dataType,
                                     java.lang.String formula,
                                     java.lang.String baseField)

Adds a calculated field.

Parameters:

table - The table name.

name - The field name.

dataType - The data type.

formula - The formula.

baseField - The base field name.

Returns:

This data source.

addCalculatedField

public DataSource addCalculatedField(java.lang.String table,
                                     java.lang.String name,
                                     java.lang.String dataType,
                                     int size,
                                     int decimals,
                                     java.lang.String formula,
                                     java.lang.String baseField)

Adds a calculated numeric field.

Parameters:

table - The table name.

name - The field name.

dataType - The data type.

size - The numeric field size.

decimals - The number of numeric field decimals.

formula - The formula.

baseField - The base field name.

Returns:

This data source.

createCopy

public DataSource createCopy()

Creates and returns a copy of this data source. Only copies configuration properties, not per-request properties.

Overrides:

createCopy in class DataSourceImpl

Returns:

The copy.

getTotals

public com.archibus.datasource.data.DataRecord getTotals(java.lang.String restriction)

Retrieve records that contains totals for all calculated fields. Runs modified query without GROUP BY clause. SELECT count(pr_id) FROM property

Parameters:

restriction - Client-supplied restriction string, or null.

Returns:

DataRecord with totals.

getSubtotals

public java.util.List<com.archibus.datasource.data.DataRecord> getSubtotals(java.lang.String restriction,
                                                                            java.lang.String groupingFieldName)

Retrieve records that contains subtotals for all calculated fields and specified grouping field. SELECT program_id, sum(cost_budget_cap) FROM prog_budget_items GROUP BY program_id

Parameters:

restriction - Client-supplied restriction string, or null.

groupingFieldName - The grouping field name.

Returns:

List of records.

getSubtotals

public java.util.List<com.archibus.datasource.data.DataRecord> getSubtotals(java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> clientRestrictions,
                                                                            java.lang.String groupingFieldName)

Retrieve records that contains subtotals for all calculated fields and specified grouping field. SELECT program_id, sum(cost_budget_cap) FROM prog_budget_items GROUP BY program_id

Parameters:

clientRestrictions - The list of restrictions.

groupingFieldName - The grouping field name.

Returns:

List of records.

formatSqlQueryForTotals

public java.lang.String formatSqlQueryForTotals(java.lang.String restrictionString)

Formats SQL query for totals.

Parameters:

restrictionString - Client-supplied restriction string, or null.

Returns:

The SQL.

formatSqlQueryForSubtotals

public java.lang.String formatSqlQueryForSubtotals(java.lang.String restrictionString,
                                                   java.lang.String groupingFieldName)

Formats SQL query for totals.

Parameters:

restrictionString - Client-supplied restriction string, or null.

groupingFieldName - The grouping field name.

Returns:

The SQL.

formatSqlQueryForSubtotals

public java.lang.String formatSqlQueryForSubtotals(java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> clientRestrictions,
                                                   java.lang.String groupingFieldName)

Formats SQL query for totals.

Parameters:

clientRestrictions - The list of restrictions.

groupingFieldName - The grouping field name.

Returns:

The SQL.

getQueryInstance

protected com.archibus.datasource.DataSourceQueryImpl getQueryInstance(com.archibus.config.Database.Immutable database)

Returns new query instance.

Overrides:

getQueryInstance in class DataSourceImpl

Parameters:

database - The database.

Returns:

The query.

getLookupFieldDefs

public java.util.Set<com.archibus.schema.LookupFieldMapping> getLookupFieldDefs()

Returns all lookup field definitions for this data source.

Returns:

Set of lookup field definitions.

useVirtualFields

public boolean useVirtualFields()

Returns true if virtual fields must be used instead of visible fields to handle JDBC resultset (always for grouping DataSource).

Overrides:

useVirtualFields in class DataSourceImpl

Returns:

The result.

evaluateSqlExpressions

protected void evaluateSqlExpressions()

Evaluates expressions in custom SQL queries.

Overrides:

evaluateSqlExpressions in class DataSourceImpl

getDbFieldsForTotals

public java.util.List getDbFieldsForTotals()

Returns the list of fields for the totals query.

Returns:

List

getDbFieldsForSubtotals

public java.util.List getDbFieldsForSubtotals(java.lang.String groupingFieldName)

Returns the list of fields for the sub-totals query.

Parameters:

groupingFieldName - The grouping field name.

Returns:

List

saveRecord

public com.archibus.datasource.data.DataRecord saveRecord(com.archibus.datasource.data.DataRecord record)

Override for DataSourceImpl.saveRecord(). This operation is prohibited.

Specified by:

saveRecord in interface DataSource

Overrides:

saveRecord in class DataSourceImpl

Parameters:

record - DataRecord containing record values to be saved and old values.

Returns:

DataRecord containing saved field values, or null if the table PK is not autonumbered.

deleteRecord

public void deleteRecord(com.archibus.datasource.data.DataRecord record)

Override for DataSourceImpl.deleteRecord(). This operation is prohibited.

Specified by:

deleteRecord in interface DataSource

Overrides:

deleteRecord in class DataSourceImpl

Parameters:

record - DataRecord containing record to be deleted.

deleteRecord

public void deleteRecord(java.util.Map fieldValues)
                  throws com.archibus.utility.ExceptionBase

Override for DataSourceImpl.deleteRecord(). This operation is prohibited.

Specified by:

deleteRecord in interface DataSource

Overrides:

deleteRecord in class DataSourceImpl

Parameters:

fieldValues - map containing record values.

Throws:

com.archibus.utility.ExceptionBase

createRecord

public com.archibus.datasource.data.DataRecord createRecord()

Description copied from interface: DataSource

Creates new DataRecord with default values for all fields defined in the data source.

Specified by:

createRecord in interface DataSource

Overrides:

createRecord in class DataSourceImpl

Returns:

DataRecord