com.centrasite.jaxr

Interface CentraSiteBusinessQuery

public interface CentraSiteBusinessQuery

An interface which provides capability to write xquery with various options (extention to QueryManager, BusinessQueryManager) to CentraSite database through JAXR API.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTEXT_OBJECT Context object variable string used inside the business query.
static java.lang.String	FIND_QUALIFIER_OBJECT_CACHE_EAGER Eager object cache population.
static java.lang.String	FIND_QUALIFIER_OBJECT_CACHE_LAZY Lazy object cache population.

Method Summary

Modifier and Type	Method and Description
void	addClassifications(java.util.Collection<Classification> classifications) Adds the collection of classification objects.
void	addComparison(java.lang.String path, java.lang.Boolean value) Add a value comparison to this query's predicate conjunction.
void	addComparison(java.lang.String path, java.util.List<java.lang.String> values) Add a value comparison to this query's predicate conjunction.
void	addComparison(java.lang.String path, java.lang.String value) Add a value comparison to this query's predicate conjunction.
void	addComparisonCaseInsensitive(java.lang.String path, java.lang.String value) Add a case-insensitive value comparison to this query's predicate conjunction.
void	addContains(java.lang.String path, java.lang.String value) Add a contains to this query's predicate conjunction.
void	addKeywordSearch(java.lang.String path, java.lang.String searchString) Add keyword search string for a specific path.
void	addOrderBy(java.lang.String path, boolean descending) Add an order by clause.
void	addOrderByRelevance(java.util.Collection keywords, boolean descending) Add an order by clause specifically for sorting by relevance w.r.t. a certain set of keywords
void	addPredicate(java.lang.String predicate) Add a free style predicate.
void	addPrologExtension(java.lang.String p) Appends to query specific entry for the XQuery prolog.
void	addQueryBodyPrefix(java.lang.String p) Appends to query specific prefix for the query body.
void	addStartsWith(java.lang.String path, java.lang.String value) Adds a starts-with to this query's predicate conjunction.
void	addStartsWithCaseInsensitive(java.lang.String path, java.lang.String value) Adds a case-insensitive starts-with to this query's predicate conjunction.
void	enableEmptyPredicate() Turn on full doctype retrieval.
void	excludeClassifiedObjects(java.util.Collection<java.lang.String> conceptKeys) Restricts the search result not to contain any objects that are classified with any concept that is identified by a collection of concept key ids.
BulkResponse	execute() Executes this query.
javax.xml.namespace.QName	getDoctypeQName(java.lang.String objectType) Returns doctype QName for object type.
java.lang.String	getPrefixForNamespaceUri(java.lang.String uri, boolean importRequired) Gets a prefix for given namespace URI.
java.lang.String	getPrologExtension() Gets query specific entry for the XQuery prolog.
java.lang.String	getQueryBodyPrefix() Gets query specific prefix for the query body.
java.lang.String	getQueryString() Obtains the query string needed for executing this BusinessQuery.
void	includeClassifiedObjects(java.util.Collection<java.lang.String> conceptKeys) Restricts the search result to contain only objects that are classified with any concept that is identified by a collection of concept key ids.
void	setKeywordSearch(java.util.Collection keywords) Passes a group of words or phrases for keyword search.
void	setKeywordSearch(java.lang.String searchString) Sets asset search keyword string for this BusinessQuery.
void	setPrologExtension(java.lang.String p) Sets query specific entry for the XQuery prolog.
void	setQueryBodyPrefix(java.lang.String p) Sets query specific prefix for the query body.
void	setUseLogicalOperatorOR(boolean useOR) Sets logical operator for combining predicates.
void	translatePatterns(java.lang.String name, java.util.Collection patterns) Translates namePatterns argument of findXXX methods to its XQuery representation.

Field Detail

FIND_QUALIFIER_OBJECT_CACHE_EAGER

static final java.lang.String FIND_QUALIFIER_OBJECT_CACHE_EAGER

Eager object cache population.

See Also:

Constant Field Values

FIND_QUALIFIER_OBJECT_CACHE_LAZY

static final java.lang.String FIND_QUALIFIER_OBJECT_CACHE_LAZY

Lazy object cache population.

See Also:

Constant Field Values

CONTEXT_OBJECT

static final java.lang.String CONTEXT_OBJECT

Context object variable string used inside the business query.

See Also:

Constant Field Values

Method Detail

addComparison

void addComparison(java.lang.String path,
                   java.lang.String value)

Add a value comparison to this query's predicate conjunction.

Parameters:

path - the path expression

value - the comparison value

addComparisonCaseInsensitive

void addComparisonCaseInsensitive(java.lang.String path,
                                  java.lang.String value)

Add a case-insensitive value comparison to this query's predicate conjunction.

Parameters:

path - the path expression

value - the comparison value

addComparison

void addComparison(java.lang.String path,
                   java.util.List<java.lang.String> values)
            throws JAXRException

Add a value comparison to this query's predicate conjunction. The comparison will be logical OR of the values.

Parameters:

path - the path expression

values - the collection of values which this comparison can have.

Throws:

JAXRException - if an internal error occurs

addComparison

void addComparison(java.lang.String path,
                   java.lang.Boolean value)
            throws JAXRException

Add a value comparison to this query's predicate conjunction.

Parameters:

path - the path expression

value - the comparison value

Throws:

JAXRException - if an internal error occurs

addClassifications

void addClassifications(java.util.Collection<Classification> classifications)
                 throws JAXRException

Adds the collection of classification objects.

Parameters:

classifications - the collection of classification objects.

Throws:

JAXRException - if an internal error occurs

addStartsWith

void addStartsWith(java.lang.String path,
                   java.lang.String value)

Adds a starts-with to this query's predicate conjunction.

Parameters:

path - the path expression

value - the comparison value

addStartsWithCaseInsensitive

void addStartsWithCaseInsensitive(java.lang.String path,
                                  java.lang.String value)

Adds a case-insensitive starts-with to this query's predicate conjunction.

Parameters:

path - the path expression

value - the comparison value

addContains

void addContains(java.lang.String path,
                 java.lang.String value)

Add a contains to this query's predicate conjunction.

Parameters:

path - the path expression

value - the comparison value

addKeywordSearch

void addKeywordSearch(java.lang.String path,
                      java.lang.String searchString)
               throws JAXRException

Add keyword search string for a specific path.

Parameters:

path - the path specifying the nodes to be searched

searchString - a string containing a blank separated list of search words and quoted phrases

Throws:

JAXRException - if an internal error occurs on keyword search

addOrderByRelevance

void addOrderByRelevance(java.util.Collection keywords,
                         boolean descending)

Add an order by clause specifically for sorting by relevance w.r.t. a certain set of keywords

Parameters:

keywords - The keywords

descending - If true sorting will be descending.

addOrderBy

void addOrderBy(java.lang.String path,
                boolean descending)

Add an order by clause.

Parameters:

path - The path expression used for the sorting - should refer to CONTEXT_OBJECT

descending - If true sorting will be descending.

addPredicate

void addPredicate(java.lang.String predicate)

Add a free style predicate.

Parameters:

predicate - the predicate string

enableEmptyPredicate

void enableEmptyPredicate()

Turn on full doctype retrieval.

execute

BulkResponse execute()
              throws JAXRException

Executes this query.

Returns:

the list of keys, wrapped in a BulkResponse

Throws:

JAXRException - if an internal error occurs

getPrefixForNamespaceUri

java.lang.String getPrefixForNamespaceUri(java.lang.String uri,
                                          boolean importRequired)

Gets a prefix for given namespace URI.

Parameters:

uri - the namespace URI.

importRequired - true if the import is required.

Returns:

the corresponding prefix.

getQueryString

java.lang.String getQueryString()
                         throws JAXRException

Obtains the query string needed for executing this BusinessQuery.

Returns:

the query string

Throws:

JAXRException - if an internal error occurs on retrieving the query string

setKeywordSearch

void setKeywordSearch(java.util.Collection keywords)
               throws JAXRException

Passes a group of words or phrases for keyword search. Each string in Collection keywords contains a single word or a blank separated phrase.

Parameters:

keywords - a group words or phrases

Throws:

JAXRException - if an internal error occurs on keyword search

See Also:

setKeywordSearch(String)

setKeywordSearch

void setKeywordSearch(java.lang.String searchString)
               throws JAXRException

Sets asset search keyword string for this BusinessQuery.

This method will add predicates to the query that effectively make it search for keywords in these paths:

• $ro/cs:name/cs:localString
• $ro/cs:description/cs:localString
• $ro/cs:instanceSlots/*
• $ro/SLOT for all type specific slots SLOT

The search will all also match a $ro when it is related to an externalLink $el that matches the keywords in:

• $el/cs:externalURI

The search string consists of blank-separated words and phrases. A phrase consists of blank-separated words enclosed in quotes, it will match objects that contain all of these words in sequence, e.g. "\"light blue\"" will match objects that contain "light" and "blue" in this order, adjacent to each other.

The words and phrases in one search string are in a logical OR connection, i.e. searching for "red \"light blue\"" will match objects that match "red" as well as those matching "\"light blue\"".

Multiple calls of setKeywordSearch create multiple groups of search keywords. At query execution time, these groups are in a locical AND connection, unless setUseLogicalOperatorOR(boolean) is used to override. With an AND connection, an object matches the search if it matches all of the groups, whereas with an OR connection, it matches the search when it matches any of the groups.

Parameters:

searchString - a string containing a blank separated list of search words and quoted phrases

Throws:

JAXRException - if an internal error occurs on keyword search

includeClassifiedObjects

void includeClassifiedObjects(java.util.Collection<java.lang.String> conceptKeys)

Restricts the search result to contain only objects that are classified with any concept that is identified by a collection of concept key ids.

Parameters:

conceptKeys - the collection of concept key ids.

excludeClassifiedObjects

void excludeClassifiedObjects(java.util.Collection<java.lang.String> conceptKeys)

Restricts the search result not to contain any objects that are classified with any concept that is identified by a collection of concept key ids.

Parameters:

conceptKeys - the collection of concept key ids.

getPrologExtension

java.lang.String getPrologExtension()

Gets query specific entry for the XQuery prolog.

Returns:

the XQuery prolog as string value

setPrologExtension

void setPrologExtension(java.lang.String p)

Sets query specific entry for the XQuery prolog.

Parameters:

p - the string to add to the XQuery prolog

addPrologExtension

void addPrologExtension(java.lang.String p)

Appends to query specific entry for the XQuery prolog.

Parameters:

p - the string to add to the XQuery prolog

getQueryBodyPrefix

java.lang.String getQueryBodyPrefix()

Gets query specific prefix for the query body.

Returns:

the string to add in front of the query body

setQueryBodyPrefix

void setQueryBodyPrefix(java.lang.String p)

Sets query specific prefix for the query body.

Parameters:

p - the string to add in front of the query body

addQueryBodyPrefix

void addQueryBodyPrefix(java.lang.String p)

Appends to query specific prefix for the query body.

Parameters:

p - a string to add in front of the query body

setUseLogicalOperatorOR

void setUseLogicalOperatorOR(boolean useOR)

Sets logical operator for combining predicates.

Parameters:

useOR - if true, predicates will be combined by a logical OR, otherwise they will be combined by a logical AND (which also is the default behaviour).

translatePatterns

void translatePatterns(java.lang.String name,
                       java.util.Collection patterns)
                throws JAXRException

Translates namePatterns argument of findXXX methods to its XQuery representation.

Parameters:

name - @see javax.xml.registry.BusinessQueryManager#findOrganizations(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)

patterns - the collection of patterns.

Throws:

JAXRException - if an internal error occurs.

getDoctypeQName

javax.xml.namespace.QName getDoctypeQName(java.lang.String objectType)

Returns doctype QName for object type.

Parameters:

objectType - the object type (as in LifeCycleManager constants)

Returns:

the corresponding doctype QName