com.tsgrp.opencontent.core.enhanced.util

Class QueryFactory

java.lang.Object

com.tsgrp.opencontent.core.enhanced.util.QueryFactory

Direct Known Subclasses:

EnhancedAlfrescoLuceneQueryFactory, EnhancedDctmQueryFactory, EnhancedElasticsearchQueryFactory, EnhancedSolrQueryFactory

public abstract class QueryFactory
extends java.lang.Object

The methods defined convert a EnhancedQueryCriteriaBean into the subsections that make up a query.

Member Variable	Description
Map propertyTablesMap	Maps table names to unique table identifiers. When joining tables, we are required to provide an alias that is used to reference the table in the query.
Boolean joinQuery	Set in initPropertyMap(EnhancedQueryCriteriaBean)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	joinQuery Set in initPropertyMap(EnhancedQueryCriteriaBean)
protected java.util.Map<java.lang.String,java.lang.String>	propertyTablesMap Maps table names to unique table identifiers.

Constructor Summary

Constructors

Constructor and Description
QueryFactory()

Method Summary

Modifier and Type	Method and Description
static void	fixQualificationSet(EnhancedQueryQualificationSet query) All implementations MUST call this method before working with a EnhancedQueryCriteriaBean, must send in EnhancedQueryCriteriaBean.getWhereClause() as the argument.
abstract java.lang.String	getExecuteQuery(EnhancedQueryCriteriaBean query) Returns the specified execute query.
abstract java.lang.String	getReadQuery(EnhancedQueryCriteriaBean query) Returns the read query represented by the EnhancedQueryCriteriaBean.
void	initPropertyMap(EnhancedQueryCriteriaBean query) Sets the joinQuery parameter to true for read queries with multiple tables, then populates the propertyTablesMap.
abstract java.lang.String	parseDeleteTable(EnhancedQueryCriteriaBean query) Returns the DELETE clause for this update query.
abstract java.lang.String	parseFromClause(EnhancedQueryCriteriaBean query) Returns the from clause for this read query.
abstract java.lang.String	parseInsertTable(EnhancedQueryCriteriaBean query) Returns the insert into clause for this insert query.
abstract java.lang.String	parseInsertValues(EnhancedQueryCriteriaBean query) Returns the (columns) VALUES (columnValues) clause for this insert query.
abstract java.lang.String	parseSelectClause(EnhancedQueryCriteriaBean query) Returns the select clause for this read query.
abstract java.lang.String	parseUpdateSet(EnhancedQueryCriteriaBean query) Returns the SET clause for this update query.
abstract java.lang.String	parseUpdateTable(EnhancedQueryCriteriaBean query) Returns the UPDATE clause for this update query.
abstract java.lang.String	parseWhereClause(EnhancedQueryCriteriaBean query) Returns the where clause for this read query and update query.

Methods inherited from class java.lang.Object

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

Field Detail

propertyTablesMap

protected java.util.Map<java.lang.String,java.lang.String> propertyTablesMap

Maps table names to unique table identifiers. When joining tables, we are required to provide an alias that is used to reference the table in the query.

joinQuery

protected boolean joinQuery

Set in initPropertyMap(EnhancedQueryCriteriaBean)

Constructor Detail

QueryFactory

public QueryFactory()

Method Detail

initPropertyMap

public void initPropertyMap(EnhancedQueryCriteriaBean query)
                     throws OCException

Sets the joinQuery parameter to true for read queries with multiple tables, then populates the propertyTablesMap.

Parameters:

query -

Throws:

OCException

getReadQuery

public abstract java.lang.String getReadQuery(EnhancedQueryCriteriaBean query)
                                       throws OCException

Returns the read query represented by the EnhancedQueryCriteriaBean.
Must call:

• initPropertyMap(EnhancedQueryCriteriaBean)
• parseSelectClause(EnhancedQueryCriteriaBean)
• parseFromClause(EnhancedQueryCriteriaBean)
• parseWhereClause(EnhancedQueryCriteriaBean)

Parameters:

query -

Returns:

Throws:

OCException

getExecuteQuery

public abstract java.lang.String getExecuteQuery(EnhancedQueryCriteriaBean query)
                                          throws OCException

Returns the specified execute query.
First Call:

• initPropertyMap(EnhancedQueryCriteriaBean)

if queryType == insert

• parseInsertTable(EnhancedQueryCriteriaBean)
• parseInsertValues(EnhancedQueryCriteriaBean)

else if queryType == update

• parseUpdateTable(EnhancedQueryCriteriaBean)
• parseUpdateSet(EnhancedQueryCriteriaBean)
• parseWhereClause(EnhancedQueryCriteriaBean)

Parameters:

query -

Returns:

Throws:

OCException

parseSelectClause

public abstract java.lang.String parseSelectClause(EnhancedQueryCriteriaBean query)
                                            throws OCException

Returns the select clause for this read query.

Parameters:

query -

Returns:

Throws:

OCException

parseDeleteTable

public abstract java.lang.String parseDeleteTable(EnhancedQueryCriteriaBean query)
                                           throws OCException

Returns the DELETE clause for this update query.

Parameters:

query -

Returns:

Throws:

OCException

parseFromClause

public abstract java.lang.String parseFromClause(EnhancedQueryCriteriaBean query)
                                          throws OCException

Returns the from clause for this read query.

Parameters:

query -

Returns:

Throws:

OCException

parseWhereClause

public abstract java.lang.String parseWhereClause(EnhancedQueryCriteriaBean query)
                                           throws OCException

Returns the where clause for this read query and update query.

Parameters:

query -

Returns:

Throws:

OCException

parseInsertTable

public abstract java.lang.String parseInsertTable(EnhancedQueryCriteriaBean query)
                                           throws OCException

Returns the insert into clause for this insert query.

Returns:

Throws:

OCException

parseInsertValues

public abstract java.lang.String parseInsertValues(EnhancedQueryCriteriaBean query)
                                            throws OCException

Returns the (columns) VALUES (columnValues) clause for this insert query.

Parameters:

query -

Returns:

Throws:

OCException

parseUpdateTable

public abstract java.lang.String parseUpdateTable(EnhancedQueryCriteriaBean query)
                                           throws OCException

Returns the UPDATE clause for this update query.

Parameters:

query -

Returns:

Throws:

OCException

parseUpdateSet

public abstract java.lang.String parseUpdateSet(EnhancedQueryCriteriaBean query)
                                         throws OCException

Returns the SET clause for this update query.

Parameters:

query -

Returns:

Throws:

OCException

fixQualificationSet

public static void fixQualificationSet(EnhancedQueryQualificationSet query)

All implementations MUST call this method before working with a EnhancedQueryCriteriaBean, must send in EnhancedQueryCriteriaBean.getWhereClause() as the argument.

This method creates empty arrays in place of the null arrays, because:

• If the IQuery implementation is invoked from a web service, empty array parameters are converted to null
• If the implementation is directly invoked or from a web service, the user is not required to populate all of the array member fields on the EnhancedQueryQualificationSet

Parameters:

query -