com.tsgrp.opencontent.core.util

Class QueryUtil

java.lang.Object

com.tsgrp.opencontent.core.util.QueryUtil

public class QueryUtil
extends java.lang.Object

Created Feb 5, 2009 by nmccabe of Technology Services Group

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	PROP_HPI_ANNOTATED The property to set if HPI document has an annotation.
protected static java.lang.String	PROP_HPI_DOC_NOTE The property to set if HPI document has a note.
protected static java.lang.String	PROP_HPI_ISINWORKFLOW The property to set if HPI document is in a workflow.
protected static java.lang.String	PROP_HPI_REDACTED The property to set if HPI document is redacted.

Constructor Summary

Constructors

Constructor and Description
QueryUtil()

Method Summary

Modifier and Type	Method and Description
static void	convertQueryFromBeanNames(EnhancedQueryCriteriaBean query) Converts the given query from using bean names to using repo names.
static void	fixQualificationSet(QueryQualificationSet query) All implementations MUST call this method before working with a QueryCriteriaBean, must send in QueryCriteriaBean#getWhereClause() as the argument.
static java.lang.String	flattenValuesForInQuery(java.lang.String[] values) Takes an array of strings for an IN or NOT IN query and transforms it into a string with the appropriate delimiter
static java.lang.String	getDocIdFromLegacyIdQuery(java.lang.String ticket, java.lang.String legacyId) Queries legacyId in the repository, returns docId if a document has the same legacyId attached to it
static int	getResultLimit(EnhancedQueryCriteriaBean criteria) Returns the result limit for the given criteria, always returns -1 when the criteria matches conditions for returning all values.
static int	getResultLimit(QueryCriteriaBean criteria) Returns the result limit for the given criteria, always returns -1 when the criteria matches conditions for returning all values.
static void	processDefaultIndicators(java.lang.String ticket, OCQuery query, java.lang.String redactedRelationName, java.lang.String folderNoteRelationName) We process each oco from the query and decide which faux property gets added corresponding to whether object hasDocNotes, isInWorkflow, isAnnotated or isRedacted

Methods inherited from class java.lang.Object

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

Field Detail

PROP_HPI_REDACTED

protected static final java.lang.String PROP_HPI_REDACTED

The property to set if HPI document is redacted.

See Also:

Constant Field Values

PROP_HPI_DOC_NOTE

protected static final java.lang.String PROP_HPI_DOC_NOTE

The property to set if HPI document has a note.

See Also:

Constant Field Values

PROP_HPI_ANNOTATED

protected static final java.lang.String PROP_HPI_ANNOTATED

The property to set if HPI document has an annotation.

See Also:

Constant Field Values

PROP_HPI_ISINWORKFLOW

protected static final java.lang.String PROP_HPI_ISINWORKFLOW

The property to set if HPI document is in a workflow.

See Also:

Constant Field Values

Constructor Detail

QueryUtil

public QueryUtil()

Method Detail

flattenValuesForInQuery

public static java.lang.String flattenValuesForInQuery(java.lang.String[] values)

Takes an array of strings for an IN or NOT IN query and transforms it into a string with the appropriate delimiter

Parameters:

values - an array of string values

Returns:

flattened string of values with the appropriate delimiter

fixQualificationSet

public static void fixQualificationSet(QueryQualificationSet query)

All implementations MUST call this method before working with a QueryCriteriaBean, must send in QueryCriteriaBean#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 QueryQualificationSet

Parameters:

query -

getResultLimit

public static int getResultLimit(QueryCriteriaBean criteria)

Returns the result limit for the given criteria, always returns -1 when the criteria matches conditions for returning all values.

Parameters:

criteria -

Returns:

-1 means return all values, or any positive integer signifying the number of results to return.

getResultLimit

public static int getResultLimit(EnhancedQueryCriteriaBean criteria)

Returns the result limit for the given criteria, always returns -1 when the criteria matches conditions for returning all values.

Parameters:

criteria -

Returns:

-1 means return all values, or any positive integer signifying the number of results to return.

convertQueryFromBeanNames

public static void convertQueryFromBeanNames(EnhancedQueryCriteriaBean query)

Converts the given query from using bean names to using repo names. This is useful when a client (ex: the REST client) only has access to bean names in the OCConstants or Wizard2Constants. If the query is already setup to have the repo names set on the various query components (select attributes, table name, where clause), this method does nothing. Note - at this time, this method doesn't support Join Qualifications

Parameters:

query - the query to convert

processDefaultIndicators

public static void processDefaultIndicators(java.lang.String ticket,
                                            OCQuery query,
                                            java.lang.String redactedRelationName,
                                            java.lang.String folderNoteRelationName)

We process each oco from the query and decide which faux property gets added corresponding to whether object hasDocNotes, isInWorkflow, isAnnotated or isRedacted

Parameters:

ticket -

query -

redactedRelationName -

foldernoteRelationName -

getDocIdFromLegacyIdQuery

public static java.lang.String getDocIdFromLegacyIdQuery(java.lang.String ticket,
                                                         java.lang.String legacyId)

Queries legacyId in the repository, returns docId if a document has the same legacyId attached to it

Parameters:

legacyId - the legacyId to be queried

ticket - the OC ticket

Returns:

return the docId of the document with matching legacyId, null if no match