com.wewebu.ow.server.fieldctrlimpl.dynamic

Class OwDBDependentComboboxDataHandler

java.lang.Object

com.wewebu.ow.server.fieldctrlimpl.dynamic.OwDBDependentComboboxDataHandler

All Implemented Interfaces:

OwDependentComboboxDataHandler

public class OwDBDependentComboboxDataHandler
extends Object
implements OwDependentComboboxDataHandler

Implements a DB based OwDependentComboboxDataHandler. Will query data from a DB, and provide the result as OwComboItem.

Allows to configure independent DataSource using own JNDI name, if local Session DB connection should not be used.
<DataSource>JNDI_NAME</DataSource>

Concept of SQL-Query definition is based on standard query for Select- and From-clause
<Query selectAll="false">Select my,fields FROM table</Query>
where the attribute selectAll is controlling if everything should be retrieved in case dependent fields are empty, and additional dynamic/dependent WHERE Property definitions:

• <Property operator="=">ECM_FIELD_ID<Property>
  Defines a where property, where DB column name and ECM field id is the same.
• <Property queryName="DBClumnName" operator="=">ECM_FIELD_ID<Property>
  Specific mapping of ECM field id to DB column name, with equals operator.
• <Property queryName="DBClumnName">ECM_FIELD_ID<Property>
  Mapping of ECM field id and DB column name, the operator will be assumed as "equals" (=).
• <Property queryName="DBClumnName" operator="!%s=?">ECM_FIELD_ID<Property>
  Special definition of SQL-operator, which can be used if the order of column name and operator is different or should be negated. If operator contains a percent sign (%s), the %s will be replaced by queryName value and added to query, else the construction of where clause is done like:
  queryName (space) operator (space) ?
The constructed Query is provided as QueryString for prepared Statement and should not contain value definitions.

Attention all WHERE property definition will be concatenated with AND, and then attached to the Query parameter value (WHERE value should not be part of Query value).

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Since:

4.2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OwDBDependentComboboxDataHandler.OwWherePropDefinition POJO containing configuration options, as simplified data objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AT_PROP_OPERATOR
protected static String	AT_PROP_QUERY_NAME
protected static String	AT_SELECT_ALL
protected static String	EL_DATA_SOURCE
protected static String	EL_PROPERTY
protected static String	EL_QUERY

Constructor Summary

Constructors

Constructor and Description
OwDBDependentComboboxDataHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	createFullQuery(String query, Map<String,OwDBDependentComboboxDataHandler.OwWherePropDefinition> whereProps) Create the String which represents the full SQL query to be fired for new results.
protected OwXMLUtil	getConf()
protected OwAppContext	getContext()
List<OwComboItem>	getData(OwFieldProvider fieldProvider) Provide Combobox results which should be available as options in UI.
List<String>	getDependentFieldIds() Return a list of Id's on which fields of the field provider the handler is dependent.
protected org.springframework.jdbc.core.JdbcTemplate	getTemplate()
void	init(OwAppContext context, OwXMLUtil configuration) Init method called when OwFieldControl is successfully initialized and attached to context.
protected void	processRequest(String query, Map<String,OwDBDependentComboboxDataHandler.OwWherePropDefinition> whereProps, List<OwComboItem> result) Process the query and add the query-results into the provided results collection, wrapped as OwComoboItem interface.
boolean	selectAll()
protected void	setConf(OwXMLUtil conf)
protected void	setTemplate(org.springframework.jdbc.core.JdbcTemplate template)

Methods inherited from class java.lang.Object

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

Field Detail

EL_DATA_SOURCE

protected static final String EL_DATA_SOURCE

See Also:

Constant Field Values

AT_SELECT_ALL

protected static final String AT_SELECT_ALL

See Also:

Constant Field Values

EL_QUERY

protected static final String EL_QUERY

See Also:

Constant Field Values

EL_PROPERTY

protected static final String EL_PROPERTY

See Also:

Constant Field Values

AT_PROP_QUERY_NAME

protected static final String AT_PROP_QUERY_NAME

See Also:

Constant Field Values

AT_PROP_OPERATOR

protected static final String AT_PROP_OPERATOR

See Also:

Constant Field Values

Constructor Detail

OwDBDependentComboboxDataHandler

public OwDBDependentComboboxDataHandler()

Method Detail

init

public void init(OwAppContext context,
        OwXMLUtil configuration)
          throws OwException

Description copied from interface: OwDependentComboboxDataHandler

Init method called when OwFieldControl is successfully initialized and attached to context.

Specified by:

init in interface OwDependentComboboxDataHandler

Parameters:

context - OwAppContext where OwFieldControl is attached

configuration - OwXMLUtil configuration information

Throws:

OwException

getData

public List<OwComboItem> getData(OwFieldProvider fieldProvider)
                          throws OwException

Description copied from interface: OwDependentComboboxDataHandler

Provide Combobox results which should be available as options in UI.

Specified by:

getData in interface OwDependentComboboxDataHandler

Parameters:

fieldProvider - OwFieldProvider current context object who define fields

Returns:

List of OwComboItem elements, or empty List

Throws:

OwException

processRequest

protected void processRequest(String query,
                  Map<String,OwDBDependentComboboxDataHandler.OwWherePropDefinition> whereProps,
                  List<OwComboItem> result)
                       throws OwException

Process the query and add the query-results into the provided results collection, wrapped as OwComoboItem interface.

Parameters:

query - String the created query

whereProps - Map of ECM field name and corresponding SQL where definition

result - List of OwComboItem's

Throws:

OwException

createFullQuery

protected String createFullQuery(String query,
                     Map<String,OwDBDependentComboboxDataHandler.OwWherePropDefinition> whereProps)
                          throws OwException

Create the String which represents the full SQL query to be fired for new results. By default creates an AND concatenated WHERE clause for provided properties, using the query as predefined information.

Parameters:

query - String the base Query

whereProps - Map of WHERE props to handle

Returns:

String representing the full query string

Throws:

OwException

getContext

protected OwAppContext getContext()

getTemplate

protected org.springframework.jdbc.core.JdbcTemplate getTemplate()

setTemplate

protected void setTemplate(org.springframework.jdbc.core.JdbcTemplate template)

getConf

protected OwXMLUtil getConf()

setConf

protected void setConf(OwXMLUtil conf)

getDependentFieldIds

public List<String> getDependentFieldIds()

Description copied from interface: OwDependentComboboxDataHandler

Return a list of Id's on which fields of the field provider the handler is dependent.

Specified by:

getDependentFieldIds in interface OwDependentComboboxDataHandler

Returns:

List of Strings, or empty list

selectAll

public boolean selectAll()