com.tsgrp.opencontent.core.query

Class AbstractLuceneQueryImpl

java.lang.Object

com.tsgrp.opencontent.core.query.AbstractLuceneQueryImpl

All Implemented Interfaces:

IQuery

Direct Known Subclasses:

ElasticsearchSchemalessQueryImpl, SolrSchemalessQueryImpl

public class AbstractLuceneQueryImpl
extends java.lang.Object
implements IQuery

Constructor Summary

Constructors

Constructor and Description
AbstractLuceneQueryImpl()

Method Summary

Modifier and Type	Method and Description
void	addCurrentFlagToQuery(java.lang.StringBuffer queryString) Adds the current flag to the query
protected void	addSecurityToQuery(java.lang.String ticket, java.util.List<java.lang.String> queryTypes, java.lang.StringBuffer queryString) Adds security to the query
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.
protected static java.lang.String	escapeSpecialCharacters(java.lang.String input) When the queryString includes special characters, this method is called to escape them before appending it to the query for execution.
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 java.lang.String	formatDate(java.util.Date d)
protected java.lang.String	generateLuceneQuery(java.lang.String ticket, OCQuery query, java.util.List<OCSearchParameter> searchParams, java.util.List<java.lang.String> queryTypes, java.util.List<java.lang.String> typeQueries)
protected java.util.Map<java.lang.String,java.lang.String>	getEncryptionAttrMap()
byte[]	getEncryptionMetadataKey(java.lang.String keyId)
protected static java.lang.String	getFullTextSearchClause(java.lang.String fullTextQueryString) When a query is executing a full text search, getFullTextSearchClause builds the string with the correct syntax which will be appended to the query.
protected java.lang.String	getMimeTypeAttrName()
protected java.lang.String	getObjectTypeRepoName()
protected static java.lang.String	getRepoType(OCQuery query)
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.
OCQuery	processResults(java.lang.String ticket, OCQuery query) Hotspot function for client overrides of OCQuery results
protected void	setPropertyValue(java.lang.Object[] fieldNames, java.util.Map<java.lang.String,java.lang.Object> valueMap, java.lang.String propId, long nullDatePlaceHolder, OCQuery query) Sets OCO on the Query from the field names and value map

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLuceneQueryImpl

public AbstractLuceneQueryImpl()

Method Detail

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

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

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

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)

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

getRepoType

protected static java.lang.String getRepoType(OCQuery query)

escapeSpecialCharacters

protected static java.lang.String escapeSpecialCharacters(java.lang.String input)

When the queryString includes special characters, this method is called to escape them before appending it to the query for execution.

Parameters:

input - string

Returns:

the given string without special characters

getFullTextSearchClause

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

When a query is executing a full text search, getFullTextSearchClause builds the string with the correct syntax which will be appended to the query. Clients can customize if they want to add anything additional to the query, but OOB impl just passes through directly whatever the user passes in.

Parameters:

searchParam -

Returns:

The full text string that will be appended to the query.

addSecurityToQuery

protected void addSecurityToQuery(java.lang.String ticket,
                                  java.util.List<java.lang.String> queryTypes,
                                  java.lang.StringBuffer queryString)

Adds security to the query

Parameters:

{String} - ticket

{String} - queryString

addCurrentFlagToQuery

public void addCurrentFlagToQuery(java.lang.StringBuffer queryString)

Adds the current flag to the query

Parameters:

{String} - queryString

generateLuceneQuery

protected java.lang.String generateLuceneQuery(java.lang.String ticket,
                                               OCQuery query,
                                               java.util.List<OCSearchParameter> searchParams,
                                               java.util.List<java.lang.String> queryTypes,
                                               java.util.List<java.lang.String> typeQueries)

setPropertyValue

protected void setPropertyValue(java.lang.Object[] fieldNames,
                                java.util.Map<java.lang.String,java.lang.Object> valueMap,
                                java.lang.String propId,
                                long nullDatePlaceHolder,
                                OCQuery query)

Sets OCO on the Query from the field names and value map

Parameters:

{Object[]} - fieldNames

{Map - Object>} valueMap

{String} - propId

{long} - nullDatePlaceHolder

{OCQuery} - query

getEncryptionAttrMap

protected java.util.Map<java.lang.String,java.lang.String> getEncryptionAttrMap()

getEncryptionMetadataKey

public byte[] getEncryptionMetadataKey(java.lang.String keyId)

getMimeTypeAttrName

protected java.lang.String getMimeTypeAttrName()

getObjectTypeRepoName

protected java.lang.String getObjectTypeRepoName()

formatDate

protected java.lang.String formatDate(java.util.Date d)