com.tsgrp.opencontent.dctm.query

Class DCTMQueryImpl

java.lang.Object

com.tsgrp.opencontent.dctm.query.DCTMQueryImpl

All Implemented Interfaces:

IQuery

public class DCTMQueryImpl
extends java.lang.Object
implements IQuery

Service methods for executing Documentum queries.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	enableFulltext
static java.lang.String	OPERATOR_EQUALS
static java.lang.String	OPERATOR_GREATER_THAN_OR_EQUAL_TO
static java.lang.String	OPERATOR_LESS_THAN_OR_EQUAL_TO
static java.lang.String	OPERATOR_LIKE
static java.lang.String	OPERATOR_NOT_EQUALS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DCTMQueryImpl()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	addExtraWhereClause(OCQuery query) Hot spot method to add an extra where clause to the end of the where statement This method is responsible for adding the logic.
protected java.lang.String	buildDqlProps(OCQuery query, boolean fulltext)
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
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 static java.lang.String	getFullTextSearchClause(java.lang.String fullTextQueryString) Creates the FullTextSearch clause based on specified criteria.
protected static java.lang.String[]	getPhrasesArray(java.lang.String fullTextQueryString) Helper function to get the phrases from a fulltextquery string.
java.lang.String	getRepoType(OCQuery query)
protected java.lang.String	manipulateExecuteQueryDql(java.lang.String dql) Hot spot method to manipulate the final query.
int	passthroughExecuteQuery(java.lang.String ticket, java.lang.String query) Run an execute DQL query.
StringArray[]	passthroughReadQuery(java.lang.String ticket, java.lang.String query) Execute a DQL query, returning a table of results.
OCQuery	processResults(java.lang.String ticket, OCQuery query) Hotspot function for client overrides of OCQuery results
protected static java.lang.String	removeEscapeCharacters(java.lang.String value) Removes escape characters from a string.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATOR_LIKE

public static final java.lang.String OPERATOR_LIKE

See Also:

Constant Field Values

OPERATOR_EQUALS

public static final java.lang.String OPERATOR_EQUALS

See Also:

Constant Field Values

OPERATOR_NOT_EQUALS

public static final java.lang.String OPERATOR_NOT_EQUALS

See Also:

Constant Field Values

OPERATOR_LESS_THAN_OR_EQUAL_TO

public static final java.lang.String OPERATOR_LESS_THAN_OR_EQUAL_TO

See Also:

Constant Field Values

OPERATOR_GREATER_THAN_OR_EQUAL_TO

public static final java.lang.String OPERATOR_GREATER_THAN_OR_EQUAL_TO

See Also:

Constant Field Values

enableFulltext

@Value(value="${search.fulltext.enabled}")
protected java.lang.Boolean enableFulltext

Constructor Detail

DCTMQueryImpl

protected DCTMQueryImpl()

Method Detail

passthroughReadQuery

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

Execute a DQL 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

passthroughExecuteQuery

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

Run an execute DQL 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

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

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

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)

manipulateExecuteQueryDql

protected java.lang.String manipulateExecuteQueryDql(java.lang.String dql)

Hot spot method to manipulate the final query. In this impl this method returns the same dql that is passed in.

Parameters:

the - current dql

Returns:

a string representing the final dql

buildDqlProps

protected java.lang.String buildDqlProps(OCQuery query,
                                         boolean fulltext)

addExtraWhereClause

protected java.lang.String addExtraWhereClause(OCQuery query)

Hot spot method to add an extra where clause to the end of the where statement This method is responsible for adding the logic. example return: " or object_name like '%document%' "

Parameters:

query - the oc query with all the search params

Returns:

a string representing the clause to append

getRepoType

public java.lang.String getRepoType(OCQuery query)

getFullTextSearchClause

protected static java.lang.String getFullTextSearchClause(java.lang.String fullTextQueryString)

Creates the FullTextSearch clause based on specified criteria. It does this by first parsing for phrases separated by double quotes and then parsing for individual words without double quotes and then ANDing them together.

Parameters:

criteria - QueryCriteria containing query info

Returns:

String FullTextSearch clause

removeEscapeCharacters

protected static java.lang.String removeEscapeCharacters(java.lang.String value)

Removes escape characters from a string.

Parameters:

value - String with potential escape characters

Returns:

String Formatted string without escape characters

getPhrasesArray

protected static java.lang.String[] getPhrasesArray(java.lang.String fullTextQueryString)

Helper function to get the phrases from a fulltextquery string.

Parameters:

fullTextQueryString - The Full Text Query String to be parsed

Returns:

String[] Array containing the phrases

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

processResults

public OCQuery processResults(java.lang.String ticket,
                              OCQuery query)

Description copied from interface: IQuery

Hotspot function for client overrides of OCQuery results

Specified by:

processResults in interface IQuery

Parameters:

ticket - valid OC ticket

query - results on which IQuery.executeQuery has already been called. No-op if no results found

Returns:

manipulated results without mutating the passed in OCQuery

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