com.technia.tvc.core.db

Class Query

java.lang.Object

com.technia.tvc.core.db.Query

All Implemented Interfaces:

java.io.Serializable

public class Query
extends java.lang.Object
implements java.io.Serializable

Since:

5.1.3

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FINDER
static short	MAX_LIMIT
static short	NO_LIMIT
static java.lang.String	WILD_PATTERN

Method Summary

Modifier and Type	Method and Description
void	addPostCommand(java.lang.String command) Adds a MQL command that should be performed after the query is executed.
void	addPrepareCommand(java.lang.String command) Adds a MQL command that should be performed before the query is executed.
void	clearPostCommand() Clears the list of commands that are executed after the query is executed.
void	clearPrepareCommand() Clears the list of commands that are executed before the query is executed.
static void	deleteQuery(java.lang.String queryName) Deletes a query from the database, with the specified name.
matrix.db.BusinessObjectList	evaluate() Evaluates the query.
void	evaluateInto(TableBean<?> table, boolean append)
void	evaluateIntoSet(java.lang.String setName, boolean append) Evaluates the query into the set with the specified name.
java.lang.String[]	evaluateOverSet(java.lang.String setName)
QueryIterator	getIterator(java.util.List<?> selects, short pageSize) Evaluates the query and selects the specified select statements.
java.lang.String	getNamePattern()
java.lang.String	getOwnerPattern()
int	getQueryLimit()
java.lang.String	getQueryName() Returns the name of the query, or null, if no name has been specified.
static java.lang.String[]	getQueryNames() Retrieves the names of the user's saved queries.
java.lang.String	getRevPattern()
java.lang.String	getSearchFormat()
java.lang.String	getSearchText()
java.lang.String	getTypePattern()
boolean	getUseQueryTrigger()
java.lang.String	getVaultPattern()
java.lang.String	getWhere()
static boolean	hasNativeIteratorSupport()
static boolean	isEmpty(java.lang.String s) Returns true if the string is empty when whitespace characters have been stripped.
boolean	isExpandType()
static boolean	isWildPattern(java.lang.String pattern) Returns true if the pattern is wild when whitespace characters have been stripped.
static Query	newInstance()
static Query	newInstance(java.lang.String queryName)
protected java.lang.String	paramString()
protected java.lang.StringBuilder	paramString(java.lang.StringBuilder sb, boolean addNewLine)
void	saveQuery() Saves this query persistently into the database if this instance has a name associated.
matrix.db.BusinessObjectWithSelectList	select(java.util.List<?> selects) Evaluates the query and selects the specified select statements.
matrix.db.BusinessObjectWithSelectList	select(Statement statement) Evaluates the query and selects the specified select statement
matrix.db.BusinessObjectWithSelectList	select(Statement[] stmts) Evaluates the query and selects the specified select statements
matrix.db.BusinessObjectWithSelectList	select(java.lang.String statement) Evaluates the query and selects the specified select statement.
matrix.db.BusinessObjectWithSelectList	select(java.lang.String[] select) Evaluates the query and selects the specified select statements.
java.lang.String[]	selectId() Evaluates the query and returns the id's of the objects found by the query.
void	setExpandType(boolean expandType) Defines if the query also should return objects, whose type is derived from any of the types defined in the type pattern.
void	setNamePattern(java.lang.String namePattern) Sets the name pattern.
void	setOwnerPattern(java.lang.String ownerPattern) Sets the owner pattern.
void	setQueryLimit(int queryLimit) Defies the query limit.
void	setQueryName(java.lang.String queryName) Gives the query a name, and causes the query to be saved once it is evaluated.
void	setRevPattern(java.lang.String revPattern) Sets the revision pattern.
void	setSearchFormat(java.lang.String searchFormat)
void	setSearchText(java.lang.String searchText)
void	setTypePattern(java.lang.String typePattern) Sets the type pattern.
void	setUseQueryTrigger(boolean useQueryTrigger)
void	setVaultPattern(java.lang.String vaultPattern) Sets the vault pattern.
void	setWhere(java.lang.String where) Sets the where expression that will be used to limit the query result.
static matrix.db.BusinessObjectList	tempQuery(java.lang.String type, java.lang.String name, java.lang.String revision) Executes a temporary query and returns the result.
static matrix.db.BusinessObjectList	tempQuery(java.lang.String type, java.lang.String name, java.lang.String revision, java.lang.String where) Executes a temporary query and returns the result.
static matrix.db.BusinessObjectList	tempQuery(java.lang.String type, java.lang.String name, java.lang.String revision, java.lang.String vault, java.lang.String owner, java.lang.String text, java.lang.String format, java.lang.String where, boolean expand, short limit) Executes a temporary query and returns the result.
static matrix.db.BusinessObjectWithSelectList	tempQuerySelect(java.lang.String type, java.lang.String name, java.lang.String revision, java.lang.String vault, java.lang.String where, java.util.List<?> selects) Executes a query and selects the specified statements.
static matrix.db.BusinessObjectWithSelectList	tempQuerySelect(java.lang.String type, java.lang.String name, java.lang.String revision, java.lang.String vault, java.lang.String owner, java.lang.String text, java.lang.String format, java.lang.String where, boolean expand, short limit, java.util.List<?> selects) Executes a query and selects the specified statements.
java.lang.String	toString()
boolean	willSaveQuery() Returns whether or not the query will be saved.

Methods inherited from class java.lang.Object

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

Field Detail

WILD_PATTERN

public static final java.lang.String WILD_PATTERN

See Also:

Constant Field Values

FINDER

public static final java.lang.String FINDER

See Also:

Constant Field Values

NO_LIMIT

public static final short NO_LIMIT

See Also:

Constant Field Values

MAX_LIMIT

public static final short MAX_LIMIT

See Also:

Constant Field Values

Method Detail

newInstance

public static Query newInstance()

Returns:

Creates and returns a new Query instance.

newInstance

public static Query newInstance(java.lang.String queryName)
                         throws TVCException

Returns:

Creates and returns a new named Query instance. The query is populated from the query, stored in the database with the given name.

Throws:

TVCException

willSaveQuery

public boolean willSaveQuery()

Returns whether or not the query will be saved.

Returns:

True if the query will be saved.

addPrepareCommand

public void addPrepareCommand(java.lang.String command)

Adds a MQL command that should be performed before the query is executed.

Parameters:

command - A MQL command.

clearPrepareCommand

public void clearPrepareCommand()

Clears the list of commands that are executed before the query is executed.

addPostCommand

public void addPostCommand(java.lang.String command)

Adds a MQL command that should be performed after the query is executed.

Parameters:

command - A MQL command.

clearPostCommand

public void clearPostCommand()

Clears the list of commands that are executed after the query is executed.

setQueryName

public void setQueryName(java.lang.String queryName)

Gives the query a name, and causes the query to be saved once it is evaluated.

Note: Matrix has a name limitation of 127 chars for a query name. Note: The name of a query might not contain certain characters. This method will not try to validate these.

getQueryName

public java.lang.String getQueryName()

Returns the name of the query, or null, if no name has been specified.

setTypePattern

public void setTypePattern(java.lang.String typePattern)

Sets the type pattern. An empty string or null is treated as a asterisk when the query is evaluated.

Note: A pattern can not be longer than 127 characters (Matrix limitation)

Parameters:

typePattern - The type pattern

getTypePattern

public java.lang.String getTypePattern()

Returns:

The type pattern of the query

setNamePattern

public void setNamePattern(java.lang.String namePattern)

Sets the name pattern. An empty string or null is treated as a asterisk when the query is evaluated.

Note: A pattern can not be longer than 127 characters (Matrix limitation)

Parameters:

namePattern - The name pattern

getNamePattern

public java.lang.String getNamePattern()

Returns:

The name pattern of the query

setRevPattern

public void setRevPattern(java.lang.String revPattern)

Sets the revision pattern. An empty string or null is treated as a asterisk when the query is evaluated.

Note: A pattern can not be longer than 127 characters (Matrix limitation)

Parameters:

revPattern - The revision pattern

getRevPattern

public java.lang.String getRevPattern()

Returns:

The revision pattern of the query

setVaultPattern

public void setVaultPattern(java.lang.String vaultPattern)

Sets the vault pattern. An empty string or null is treated as a asterisk when the query is evaluated.

Note: A pattern can not be longer than 127 characters (Matrix limitation)

Parameters:

vaultPattern - The vault pattern

getVaultPattern

public java.lang.String getVaultPattern()

Returns:

The vault pattern of the query

setOwnerPattern

public void setOwnerPattern(java.lang.String ownerPattern)

Sets the owner pattern. An empty string or null is treated as a asterisk when the query is evaluated.

Note: A pattern can not be longer than 127 characters (Matrix limitation)

Parameters:

ownerPattern - The owner pattern

getOwnerPattern

public java.lang.String getOwnerPattern()

Returns:

The owner pattern of the query

setExpandType

public void setExpandType(boolean expandType)

Defines if the query also should return objects, whose type is derived from any of the types defined in the type pattern.

Default is false.

Parameters:

expandType - True if the type pattern applies to derived types

isExpandType

public boolean isExpandType()

Returns:

True if the query should return objects, whose type is a derived type of any of the types in the type pattern.

setQueryLimit

public void setQueryLimit(int queryLimit)

Defies the query limit. 0 (zero) is treated as no-limit.

Note: Matrix has an upper limit of 32767

Parameters:

queryLimit - The query limit.

getQueryLimit

public int getQueryLimit()

Returns:

The query limit

setWhere

public void setWhere(java.lang.String where)

Sets the where expression that will be used to limit the query result.

Parameters:

where - The where clause.

getWhere

public java.lang.String getWhere()

Returns:

The where clause.

setSearchFormat

public void setSearchFormat(java.lang.String searchFormat)

getSearchFormat

public java.lang.String getSearchFormat()

setSearchText

public void setSearchText(java.lang.String searchText)

getSearchText

public java.lang.String getSearchText()

setUseQueryTrigger

public void setUseQueryTrigger(boolean useQueryTrigger)

getUseQueryTrigger

public boolean getUseQueryTrigger()

saveQuery

public void saveQuery()
               throws TVCException

Saves this query persistently into the database if this instance has a name associated.

Throws:

TVCException - Upon db errors

getQueryNames

public static java.lang.String[] getQueryNames()

Retrieves the names of the user's saved queries.

Returns:

the names of the user's saved queries.

evaluateInto

public void evaluateInto(TableBean<?> table,
                         boolean append)
                  throws TVCException

Parameters:

table - The tablebean that will hold the result

append - True if to append the query result

Throws:

TVCException

Since:

6.3.2

evaluate

public matrix.db.BusinessObjectList evaluate()
                                      throws TVCException

Evaluates the query.

Returns:

the result of the evaluation.

Throws:

TVCException - if unable to evalute.

select

public matrix.db.BusinessObjectWithSelectList select(java.lang.String[] select)
                                              throws TVCException

Evaluates the query and selects the specified select statements.

Parameters:

select - the select statements.

Returns:

the result.

Throws:

TVCException - if unable to evalute.

select

public matrix.db.BusinessObjectWithSelectList select(java.lang.String statement)
                                              throws TVCException

Evaluates the query and selects the specified select statement.

Parameters:

statement - the select statement.

Returns:

the result.

Throws:

TVCException - if unable to evalute.

select

public matrix.db.BusinessObjectWithSelectList select(Statement statement)
                                              throws TVCException

Evaluates the query and selects the specified select statement

Parameters:

statement - The statement to be used

Returns:

The result

Throws:

TVCException - if unable to evaluate the query

Since:

5.2.1

select

public matrix.db.BusinessObjectWithSelectList select(Statement[] stmts)
                                              throws TVCException

Evaluates the query and selects the specified select statements

Parameters:

stmts - An array of statements

Throws:

TVCException - if unable to evaluate the query

Since:

5.2.1

selectId

public java.lang.String[] selectId()
                            throws TVCException

Evaluates the query and returns the id's of the objects found by the query.

Returns:

The object ids as a string array.

Throws:

TVCException - if unable to evaluate the query

Since:

6.1.8

select

public matrix.db.BusinessObjectWithSelectList select(java.util.List<?> selects)
                                              throws TVCException

Evaluates the query and selects the specified select statements.

Parameters:

selects - the select statements. Note that this parameter can be an instance of any class that implements the java.util.List interface but will be converted to a matrix.util.StringList if necessary. Also note that the list should contain instances of java.lang.String.

Returns:

the result.

Throws:

TVCException - if unable to evalute.

evaluateOverSet

public java.lang.String[] evaluateOverSet(java.lang.String setName)
                                   throws TVCException

Parameters:

setName -

Returns:

An array of strings containing object id's

Throws:

TVCException

Since:

6.0.1

deleteQuery

public static void deleteQuery(java.lang.String queryName)
                        throws TVCException

Deletes a query from the database, with the specified name.

Parameters:

queryName - The name of the query to delete

Throws:

TVCException - If unable to delete the query

evaluateIntoSet

public void evaluateIntoSet(java.lang.String setName,
                            boolean append)
                     throws TVCException

Evaluates the query into the set with the specified name.

Parameters:

setName - the name of the set.

append - whether to append the objects from the result to the set or not.

Throws:

TVCException - if an error occurrs.

tempQuery

public static matrix.db.BusinessObjectList tempQuery(java.lang.String type,
                                                     java.lang.String name,
                                                     java.lang.String revision,
                                                     java.lang.String vault,
                                                     java.lang.String owner,
                                                     java.lang.String text,
                                                     java.lang.String format,
                                                     java.lang.String where,
                                                     boolean expand,
                                                     short limit)
                                              throws TVCException

Executes a temporary query and returns the result.

Parameters:

type - the business object type pattern.

name - the business object name pattern.

revision - the business object revision pattern.

vault - the vault pattern.

owner - the owner pattern.

text - the search text.

format - the search format.

where - the where expression.

expand - whether to expand type or not.

limit - the search limit.

Returns:

the result.

Throws:

TVCException - if unable to query the database.

tempQuery

public static matrix.db.BusinessObjectList tempQuery(java.lang.String type,
                                                     java.lang.String name,
                                                     java.lang.String revision)
                                              throws TVCException

Executes a temporary query and returns the result.

Parameters:

type - the business object type pattern.

name - the business object name pattern.

revision - the business object revision pattern.

Returns:

the result.

Throws:

TVCException - if unable to query the database.

tempQuery

public static matrix.db.BusinessObjectList tempQuery(java.lang.String type,
                                                     java.lang.String name,
                                                     java.lang.String revision,
                                                     java.lang.String where)
                                              throws TVCException

Executes a temporary query and returns the result.

Parameters:

type - the business object type pattern.

name - the business object name pattern.

revision - the business object revision pattern.

where - the where expression.

Returns:

the result.

Throws:

TVCException - if unable to query the database.

tempQuerySelect

public static matrix.db.BusinessObjectWithSelectList tempQuerySelect(java.lang.String type,
                                                                     java.lang.String name,
                                                                     java.lang.String revision,
                                                                     java.lang.String vault,
                                                                     java.lang.String where,
                                                                     java.util.List<?> selects)
                                                              throws TVCException

Executes a query and selects the specified statements.

Throws:

TVCException

Since:

6.1.5

tempQuerySelect

public static matrix.db.BusinessObjectWithSelectList tempQuerySelect(java.lang.String type,
                                                                     java.lang.String name,
                                                                     java.lang.String revision,
                                                                     java.lang.String vault,
                                                                     java.lang.String owner,
                                                                     java.lang.String text,
                                                                     java.lang.String format,
                                                                     java.lang.String where,
                                                                     boolean expand,
                                                                     short limit,
                                                                     java.util.List<?> selects)
                                                              throws TVCException

Executes a query and selects the specified statements.

Throws:

TVCException

paramString

protected java.lang.String paramString()

paramString

protected java.lang.StringBuilder paramString(java.lang.StringBuilder sb,
                                              boolean addNewLine)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isWildPattern

public static boolean isWildPattern(java.lang.String pattern)

Returns true if the pattern is wild when whitespace characters have been stripped.

isEmpty

public static boolean isEmpty(java.lang.String s)

Returns true if the string is empty when whitespace characters have been stripped.

getIterator

public QueryIterator getIterator(java.util.List<?> selects,
                                 short pageSize)
                          throws TVCException

Evaluates the query and selects the specified select statements.

Parameters:

selects - the select statements. Note that this parameter can be an instance of any class that implements the java.util.List interface but will be converted to a matrix.util.StringList if necessary. Also note that the list should contain instances of java.lang.String.

pageSize - The page size to use for streaming data source.

Returns:

the result.

Throws:

TVCException - if unable to evalute.

Since:

6.1.4

hasNativeIteratorSupport

public static boolean hasNativeIteratorSupport()

Returns:

Returns true if the matrix.db.Query object supports iterators , if it doesn't we will fake it when you call any of the getIterator methods on this class.

Since:

6.1.4