com.tsgrp.opencontent.alfresco.query

Class AbstractAlfrescoEmbQueryImpl

java.lang.Object

com.tsgrp.opencontent.alfresco.query.AbstractAlfrescoEmbQueryImpl

All Implemented Interfaces:

IQuery

Direct Known Subclasses:

AlfrescoEmbQueryImpl

public abstract class AbstractAlfrescoEmbQueryImpl
extends java.lang.Object
implements IQuery

Field Summary

Fields

Modifier and Type	Field and Description
protected static OCLogger	logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAlfrescoEmbQueryImpl()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	buildAllPropertiesQueryParam(java.lang.String paramValue) Build the query param to search across all properties.
protected java.lang.String	buildCMISQuery(OCQuery query)
protected java.lang.String	buildFTSQuery(OCQuery query)
protected TSGSearchParameters	buildTSGSearchParameters(OCQuery query) Util for building TSG search parameters from an OCQuery
protected int	cleanResultClassType(java.lang.Object resultCount)
QueryResult	enhancedExecuteQuery(java.lang.String ticket, EnhancedQueryCriteriaBean query) Executes an enhanced execute query.
java.util.List<java.util.List<java.lang.Object>>	enhancedPassthroughReadQuery(java.lang.String ticket, java.lang.String query) Run and execute a database query against the given implementation.
QueryResult	enhancedReadQuery(java.lang.String ticket, EnhancedQueryCriteriaBean query) Executes an enhanced read query.
void	executeQuery(java.lang.String ticket, OCQuery query) findTotalRecords computes the number of total results and calculates the number of pages executeQuery supports pagination via the specified page number (1-based) Limited to page size unless pagesize is -1
void	executeQueryAlfrescoAPI(java.lang.String ticket, OCQuery query)
protected java.lang.String[]	findPhrase(java.lang.String param) This method takes in a string that contains at least one quote, and returns the string that's encapsulated within the first two quotation marks in the string, if there are two
java.util.Map<java.lang.String,java.lang.Object>	findTotalRecords(java.lang.String ticket, OCQuery query) Executes an OCQuery and returns the total number of results found for pagination
protected java.lang.Integer	getNumberOfResults(org.alfresco.service.cmr.search.ResultSet results) Because Alfresco introduced the getNumberFound method onto the ResultSetSPI parent class in 4.1.5 (and we support earlier versions), we have to do a cast to the proper type of result set to be able to use the getNumberFound method.
protected org.alfresco.service.cmr.search.ResultSet	getReadQueryResultSet(java.lang.String ticket, java.lang.String readQuery) This method needs to be implemented differently for Alfresco 5.x and 4.x.
int	passthroughExecuteQuery(java.lang.String ticket, java.lang.String query) Run an execute a database query.
StringArray[]	passthroughReadQuery(java.lang.String ticket, java.lang.String query) Run an execute a database query, returning a table of results.
void	setAlfrescoSQLQueryManager(AlfrescoSQLQueryManager alfrescoSQLQueryManager)
void	setCmisAuditableProperties(java.util.Map<java.lang.String,java.lang.String> auditableProps) required IF and ONLY if CMIS queries are used
void	setSqlManager(IDatabaseManager manager)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tsgrp.opencontent.core.query.IQuery

processResults

Field Detail

logger

protected static final OCLogger logger

Constructor Detail

AbstractAlfrescoEmbQueryImpl

protected AbstractAlfrescoEmbQueryImpl()

Method Detail

setCmisAuditableProperties

public void setCmisAuditableProperties(java.util.Map<java.lang.String,java.lang.String> auditableProps)

required IF and ONLY if CMIS queries are used

Parameters:

auditableProps -

setSqlManager

public void setSqlManager(IDatabaseManager manager)

setAlfrescoSQLQueryManager

public void setAlfrescoSQLQueryManager(AlfrescoSQLQueryManager alfrescoSQLQueryManager)

enhancedExecuteQuery

public QueryResult enhancedExecuteQuery(java.lang.String ticket,
                                        EnhancedQueryCriteriaBean query)

Description copied from interface: IQuery

Executes an enhanced execute query.

Specified by:

enhancedExecuteQuery in interface IQuery

Parameters:

ticket - an authentication ticket

query - a QueryCriteriaBean populated with query criteria

Returns:

• QueryResult
• error returns true if method failed, otherwise false

See Also:

IQuery.enhancedExecuteQuery(java.lang.String, com.tsgrp.opencontent.core.query.enhanced.model.EnhancedQueryCriteriaBean)

enhancedReadQuery

public QueryResult enhancedReadQuery(java.lang.String ticket,
                                     EnhancedQueryCriteriaBean query)

Description copied from interface: IQuery

Executes an enhanced read query.

Specified by:

enhancedReadQuery in interface IQuery

Parameters:

ticket - an authentication ticket

query - a QueryCriteriaBean populated with query criteria

Returns:

• QueryResult
• error returns true if method failed, otherwise false
• results contains an array of QueryResultRows returned by query

See Also:

IQuery.enhancedReadQuery(java.lang.String, com.tsgrp.opencontent.core.query.enhanced.model.EnhancedQueryCriteriaBean)

passthroughExecuteQuery

public int passthroughExecuteQuery(java.lang.String ticket,
                                   java.lang.String query)

Description copied from interface: IQuery

Run an execute a database query. This method will attempt to run the passed in query, and return the integer return value from the query. If there is an error, the return value will be -1.

Specified by:

passthroughExecuteQuery in interface IQuery

Parameters:

ticket - an authentication ticket

query - the DQL query to execute, which must return a single int

Returns:

the integer return value from the query, or -1 on failure

See Also:

IQuery.passthroughExecuteQuery(java.lang.String, java.lang.String)

passthroughReadQuery

public StringArray[] passthroughReadQuery(java.lang.String ticket,
                                          java.lang.String query)

Description copied from interface: IQuery

Run an execute a database query, returning a table of results. Each row will be a StringArray object containing the rows contents as an array of String objects. The query must be a read-only query and cannot modify the repository.

Specified by:

passthroughReadQuery in interface IQuery

Parameters:

ticket - an authentication ticket

query - the DQL query to execute, which must return a single int

Returns:

the results of query execution, or null on failure

See Also:

IQuery.passthroughReadQuery(java.lang.String, java.lang.String)

buildTSGSearchParameters

protected TSGSearchParameters buildTSGSearchParameters(OCQuery query)

Util for building TSG search parameters from an OCQuery

Parameters:

query -

restrictions -

Returns:

findTotalRecords

public java.util.Map<java.lang.String,java.lang.Object> findTotalRecords(java.lang.String ticket,
                                                                         OCQuery query)

Description copied from interface: IQuery

Executes an OCQuery and returns the total number of results found for pagination

Specified by:

findTotalRecords in interface IQuery

Returns:

a OCQuery state that includes the total records found and total pages

executeQuery

public void executeQuery(java.lang.String ticket,
                         OCQuery query)

Description copied from interface: IQuery

findTotalRecords computes the number of total results and calculates the number of pages executeQuery supports pagination via the specified page number (1-based) Limited to page size unless pagesize is -1

Specified by:

executeQuery in interface IQuery

See Also:

IQuery.executeQuery(java.lang.String, com.tsgrp.opencontent.core.query.model.OCQuery)

executeQueryAlfrescoAPI

public void executeQueryAlfrescoAPI(java.lang.String ticket,
                                    OCQuery query)

getNumberOfResults

protected java.lang.Integer getNumberOfResults(org.alfresco.service.cmr.search.ResultSet results)

Because Alfresco introduced the getNumberFound method onto the ResultSetSPI parent class in 4.1.5 (and we support earlier versions), we have to do a cast to the proper type of result set to be able to use the getNumberFound method.

Parameters:

results - the result set containing the results of the query

Returns:

the number of results in the result set

buildCMISQuery

protected java.lang.String buildCMISQuery(OCQuery query)

buildFTSQuery

protected java.lang.String buildFTSQuery(OCQuery query)

cleanResultClassType

protected int cleanResultClassType(java.lang.Object resultCount)

Parameters:

resultCount - - as Long, long or any other numeric that String.valueOf can parse

Returns:

an Int

buildAllPropertiesQueryParam

protected abstract java.lang.String buildAllPropertiesQueryParam(java.lang.String paramValue)

Build the query param to search across all properties. Important note: This method is implemented separately for Alfresco 5.x and 4.x. See the 4.x and 5.x implementations for proper syntax.

Parameters:

paramValue - - The parameter value to use to search against all properties

Returns:

the query param to search across all properties

getReadQueryResultSet

protected org.alfresco.service.cmr.search.ResultSet getReadQueryResultSet(java.lang.String ticket,
                                                                          java.lang.String readQuery)

This method needs to be implemented differently for Alfresco 5.x and 4.x. See the 5.x implementations for proper syntax.

Parameters:

ticket - - ticket used to get service registry

readQuery - - query to use to get the resultSet

Returns:

result set of the passed in query

findPhrase

protected java.lang.String[] findPhrase(java.lang.String param)

This method takes in a string that contains at least one quote, and returns the string that's encapsulated within the first two quotation marks in the string, if there are two

Parameters:

param - - string that is passed in containing at least one quote

Returns:

result two arrays, one with phrase, second is the rest of the string concatentated

enhancedPassthroughReadQuery

public java.util.List<java.util.List<java.lang.Object>> enhancedPassthroughReadQuery(java.lang.String ticket,
                                                                                     java.lang.String query)

Description copied from interface: IQuery

Run and execute a database query against the given implementation. Returns a List of Lists representing each "row" of results. Does NOT provide the headers for the given query.

Specified by:

enhancedPassthroughReadQuery in interface IQuery

Parameters:

ticket - an authentication ticket

query - the given query to run

Returns:

the results of query execution