org.enhydra.shark.eventaudit.data
Class ProcessStateEventAuditQuery

java.lang.Object
  extended byorg.enhydra.shark.eventaudit.data.ProcessStateEventAuditQuery
All Implemented Interfaces:
com.lutris.appserver.server.sql.ExtendedQuery, com.lutris.appserver.server.sql.Query

public class ProcessStateEventAuditQuery
extends java.lang.Object
implements com.lutris.appserver.server.sql.ExtendedQuery

ProcessStateEventAuditQuery is used to query the SHKProcessStateEventAudits table in the database.
It returns objects of type ProcessStateEventAuditDO.

General usage:

In DODS: Create a Data Object named "Dog", and create an Attribute named "Name", and set that Attribute to "Can be queried." DODS will then generate the method DogQuery.setQueryName().

In your Business Layer, prepare the query:

			   DogQuery	dq = new DogQuery();
			   dq.setQueryName("Rex")
			   if (	Rex	is a reserved name )
				   dq.requireUniqueInstance();
 
Then, get the query results one of two ways:

#1:

			   String names	= "";
			   DogDO[] dogs	= dq.getDOArray();
			   for ( int i = 0;	i < dogs.length;	i++	) {
				   names +=	dogs[i].getName() +	" ";
			   }
 
or #2:
			   String names	= "";
			   DogDO dog;
			   while ( null	!= ( dog = dq.getNextDO() )	) {
				   names +=	dog.getName() +	" ";
			   }
 

Note: If requireUniqueInstance() was called, then getDOArray() or getNextDO() will throw an exception if more than one "Rex" was found.

Note: Results of the query will come from the Data Object cache if: - The cache is available. - Matches were found in the cache. - No other tables (Data Objects of other types) were involved in the query. This can happen if you extend the DogQuery class and you make calls to the QueryBuilder object to add SQL involving other tables. If any of these conditions is not true, then any results from the query will come from the database.

To reuse the query object, call:

			   dq.reset();
 

Version:
$Revision: 1.35 $
Author:
NN

Constructor Summary
ProcessStateEventAuditQuery()
          Public constructor.
ProcessStateEventAuditQuery(com.lutris.appserver.server.sql.DBTransaction dbTrans)
          Public constructor.
 
Method Summary
 void addOrderByKeyValue()
          Add KeyValue to the ORDER BY clause.
 void addOrderByKeyValue(boolean direction_flag)
          Add KeyValue to the ORDER BY clause.
 void addOrderByName()
          Add Name to the ORDER BY clause.
 void addOrderByName(boolean direction_flag)
          Add Name to the ORDER BY clause.
 void closeParen()
          Place a closing parenthesis in the WHERE clause.
 boolean containsWildcards(java.lang.String dbSearchValue)
          Check whether a string contains DB wildcards
 java.lang.String convertUserSearchValue(java.lang.String userSearchValue)
          Convert a String with user wildcards into a string with DB wildcards
 java.sql.ResultSet executeQuery(com.lutris.appserver.server.sql.DBConnection conn)
          Method to query objects from the database.
 int get_FetchSize()
          reads the current fetchsize for this query
 int get_QueryTimeout()
          Reads the current queryTimeout for this query.
 org.enhydra.dods.cache.QueryResult getCachedResults(org.enhydra.dods.cache.QueryResult result)
          Return QueryResult with read DOs or DataStructs from caches.
 int getCount()
          Get the rowcount of the query If possible, do it without reading all rows
 int getDatabaseLimit()
          Get the database limit of the query
 boolean getDatabaseLimitExceeded()
          Get the database limit exceeded flag of the query.
 ProcessStateEventAuditDO[] getDOArray()
          Return array of DOs constructed from ResultSet returned by query.
 boolean getLoadData()
          Return true if Query is prepared for select t1.* statement.
 java.lang.String getLogicalDatabase()
          Return logical name of the database that ProcessStateEventAuditQuery object uses
 int getMaxRows()
          Return limit of rows (DOs) returned.
 ProcessStateEventAuditDO getNextDO()
          Return successive DOs from array built from ResultSet returned by query.
 com.lutris.dods.builder.generator.query.QueryBuilder getQueryBuilder()
          Returns the QueryBuilder that this ProcessStateEventAuditQuery uses to construct and execute database queries.
 int getReadSkip()
          Get the readSkip number of the query
 java.sql.PreparedStatement getStatement()
          Return java.sql.PreparedStatement from QueryBuilder class
 boolean getUnique()
          Get the unique flag of the query
 boolean getUserStringAppendWildcard()
          Get user string append wildcard.
 java.lang.String getUserStringSingleWildcard()
          Get user string single wildcard.
 java.lang.String getUserStringSingleWildcardEscape()
          Get user string single wildcard escape.
 boolean getUserStringTrim()
          Get user string trim.
 java.lang.String getUserStringWildcard()
          Get user string wildcard.
 java.lang.String getUserStringWildcardEscape()
          Get user string wildcard escape.
 void hitDatabase()
          Set that all queries go to database, not to cache.
 boolean isOrderRelevant()
          Returns attribute orderRelevant.
 java.lang.Object next(java.sql.ResultSet rs)
          WARNING!
 void openParen()
          Place an open parenthesis in the WHERE clause.
 void or()
          Insert an OR between WHERE clauses.
 void requireUniqueInstance()
          Set "unique instance" assertion bit.
 void reset()
          Reset the query parameters.
 int selectCount()
          Get the rowcount of the query by using count(*) in the DB
 void set_CursorType(int resultSetType, int resultSetConcurrency)
          set the current cursor type - overrides default value from dbVendorConf file.
 void set_FetchSize(int iCurrentFetchSizeIn)
          Set fetch size for this query
 void set_QueryTimeout(int iQueryTimeoutIn)
          Sets the current queryTimeout for this query.
 void setDatabaseLimit(int newLimit)
          Set the database limit of the query
 void setDBMatchKeyValue(java.lang.String x)
          Deprecated. Use comparison operators instead WebDocWf extension
 void setDBMatchName(java.lang.String x)
          Deprecated. Use comparison operators instead WebDocWf extension
 void setLoadData(boolean newValue)
          Set loadData parameter. if parameter is set to true, Query select t.* is performed.
 void setLogicalDatabase(java.lang.String dbName)
          Change logical database to another logical database (which name is dbName)
protected  void setMaxExecuteTime(int maxExeTime)
          Sets attribute maxExecuteTime.
 void setMaxRows(int maxRows)
          Limit the number of rows (DOs) returned.
 void setOrderRelevant(boolean newOrderRelevant)
          Sets attribute orderRelevant.
 void setQueryHandle(java.lang.String handle)
          Set the object handle to query.
 void setQueryKeyValue(java.lang.String x)
          Set the KeyValue to query, with a QueryBuilder comparison operator.
 void setQueryKeyValue(java.lang.String x, java.lang.String cmp_op)
          Set the KeyValue to query, with a QueryBuilder comparison operator.
 void setQueryName(java.lang.String x)
          Set the Name to query, with a QueryBuilder comparison operator.
 void setQueryName(java.lang.String x, java.lang.String cmp_op)
          Set the Name to query, with a QueryBuilder comparison operator.
 void setQueryOId(com.lutris.appserver.server.sql.ObjectId oid)
          Set the OID to query.
protected  void setQueryTimeLimit(int qTimeLimit)
          Sets attribute QueryTimeLimit.
 void setReadSkip(int newReadSkip)
          Set the readSkip number of the query
 void setUnique(boolean newUnique)
          Set the unique flag of the query
 void setUserMatchKeyValue(java.lang.String x)
          Deprecated. Use comparison operators instead WebDocWf extension
 void setUserMatchName(java.lang.String x)
          Deprecated. Use comparison operators instead WebDocWf extension
 void setUserStringAppendWildcard(boolean userStringAppendWildcard)
          Set user string append wildcard.
 void setUserStringSingleWildcard(java.lang.String newUserStringSingleWildcard)
          Set user string single wildcard.
 void setUserStringSingleWildcardEscape(java.lang.String newUserStringSingleWildcardEscape)
          Set user string single wildcard escape.
 void setUserStringTrim(boolean userStringTrim)
          Set user string trim.
 void setUserStringWildcard(java.lang.String newUserStringWildcard)
          Set user string wildcard.
 void setUserStringWildcardEscape(java.lang.String newUserStringWildcardEscape)
          Set user string wildcard escape.
 void writeXML(java.io.Writer ow)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProcessStateEventAuditQuery

public ProcessStateEventAuditQuery()
Public constructor.


ProcessStateEventAuditQuery

public ProcessStateEventAuditQuery(com.lutris.appserver.server.sql.DBTransaction dbTrans)
Public constructor.

Parameters:
dbTrans - current database transaction
Method Detail

getLogicalDatabase

public java.lang.String getLogicalDatabase()
Return logical name of the database that ProcessStateEventAuditQuery object uses

Returns:
param logical database name

getStatement

public java.sql.PreparedStatement getStatement()
Return java.sql.PreparedStatement from QueryBuilder class

Specified by:
getStatement in interface com.lutris.appserver.server.sql.ExtendedQuery
Returns:
PreparedStatement from this query object.

setLogicalDatabase

public void setLogicalDatabase(java.lang.String dbName)
                        throws java.sql.SQLException,
                               com.lutris.appserver.server.sql.DatabaseManagerException
Change logical database to another logical database (which name is dbName)

Parameters:
dbName - the logical name of the database
Throws:
java.sql.SQLException
com.lutris.appserver.server.sql.DatabaseManagerException

setUnique

public void setUnique(boolean newUnique)
Set the unique flag of the query

Parameters:
newUnique - The unique flag for the query WebDocWf extension

getUnique

public boolean getUnique()
Get the unique flag of the query

Returns:
The unique flag of the query WebDocWf extension

setReadSkip

public void setReadSkip(int newReadSkip)
Set the readSkip number of the query

Parameters:
newReadSkip - The number of results to skip. WebDocWf extension

getReadSkip

public int getReadSkip()
Get the readSkip number of the query

Returns:
The number of rows which are skipped WebDocWf extension

setDatabaseLimit

public void setDatabaseLimit(int newLimit)
Set the database limit of the query

Parameters:
newLimit - The limit for the query WebDocWf extension

getDatabaseLimit

public int getDatabaseLimit()
Get the database limit of the query

Returns:
The database limit of the query WebDocWf extension

getDatabaseLimitExceeded

public boolean getDatabaseLimitExceeded()
Get the database limit exceeded flag of the query.

Returns:
The database limit exceeded flag of the query True if there would have been more rows than the limit, otherwise false. WebDocWf extension

hitDatabase

public void hitDatabase()
Set that all queries go to database, not to cache.


setUserStringWildcard

public void setUserStringWildcard(java.lang.String newUserStringWildcard)
Set user string wildcard.

Parameters:
newUserStringWildcard - New user string wildcard. WebDocWf extension

setUserStringSingleWildcard

public void setUserStringSingleWildcard(java.lang.String newUserStringSingleWildcard)
Set user string single wildcard.

Parameters:
newUserStringSingleWildcard - New user string single wildcard. WebDocWf extension

setUserStringSingleWildcardEscape

public void setUserStringSingleWildcardEscape(java.lang.String newUserStringSingleWildcardEscape)
Set user string single wildcard escape.

Parameters:
newUserStringSingleWildcardEscape - New user string single wildcard escape. WebDocWf extension

setUserStringWildcardEscape

public void setUserStringWildcardEscape(java.lang.String newUserStringWildcardEscape)
Set user string wildcard escape.

Parameters:
newUserStringWildcardEscape - New user string wildcard escape. WebDocWf extension

setUserStringAppendWildcard

public void setUserStringAppendWildcard(boolean userStringAppendWildcard)
Set user string append wildcard.

Parameters:
userStringAppendWildcard - New user string append wildcard. WebDocWf extension

setUserStringTrim

public void setUserStringTrim(boolean userStringTrim)
Set user string trim.

Parameters:
userStringTrim - New user string trim. WebDocWf extension

getUserStringWildcard

public java.lang.String getUserStringWildcard()
Get user string wildcard.

Returns:
User string wildcard. WebDocWf extension

getUserStringSingleWildcard

public java.lang.String getUserStringSingleWildcard()
Get user string single wildcard.

Returns:
User string single wildcard. WebDocWf extension

getUserStringSingleWildcardEscape

public java.lang.String getUserStringSingleWildcardEscape()
Get user string single wildcard escape.

Returns:
User string single wildcard escape. WebDocWf extension

getUserStringWildcardEscape

public java.lang.String getUserStringWildcardEscape()
Get user string wildcard escape.

Returns:
User string wildcard escape. WebDocWf extension

getUserStringAppendWildcard

public boolean getUserStringAppendWildcard()
Get user string append wildcard.

Returns:
User string append wildcard. WebDocWf extension

getUserStringTrim

public boolean getUserStringTrim()
Get user string trim.

Returns:
User string trim. WebDocWf extension

setMaxRows

public void setMaxRows(int maxRows)
                throws com.lutris.dods.builder.generator.query.DataObjectException,
                       com.lutris.dods.builder.generator.query.NonUniqueQueryException
Limit the number of rows (DOs) returned. NOTE: When setting a limit on rows returned by a query, you usually want to use a call to an addOrderBy method to cause the most interesting rows to be returned first. However, the DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database. So, setMaxRows also forces the query to hit the database.

Parameters:
maxRows - Max number of rows (DOs) returned.
Throws:
com.lutris.dods.builder.generator.query.DataObjectException - If a database access error occurs.
com.lutris.dods.builder.generator.query.NonUniqueQueryException - If too many rows were found.

getMaxRows

public int getMaxRows()
Return limit of rows (DOs) returned.

Returns:
Max number of rows (DOs) returned.

isOrderRelevant

public boolean isOrderRelevant()
Returns attribute orderRelevant.

Returns:
true if order of query results is relavant, otherwise false.

setOrderRelevant

public void setOrderRelevant(boolean newOrderRelevant)
Sets attribute orderRelevant.

Parameters:
newOrderRelevant - new value of attribute orderRelavant.

setQueryTimeLimit

protected void setQueryTimeLimit(int qTimeLimit)
Sets attribute QueryTimeLimit.

Parameters:
qTimeLimit - new value of attribute QueryTimeLimit.

setMaxExecuteTime

protected void setMaxExecuteTime(int maxExeTime)
Sets attribute maxExecuteTime.

Parameters:
maxExeTime - new value of attribute maxExecuteTime.

getCachedResults

public org.enhydra.dods.cache.QueryResult getCachedResults(org.enhydra.dods.cache.QueryResult result)
                                                    throws com.lutris.dods.builder.generator.query.DataObjectException
Return QueryResult with read DOs or DataStructs from caches.

Parameters:
result - QueryResult object with result oids.
Returns:
QueryResult object with filled DOs or DataStructs that are found in the cache.
Throws:
com.lutris.dods.builder.generator.query.DataObjectException - If a database access error occurs.

writeXML

public void writeXML(java.io.Writer ow)
              throws com.lutris.dods.builder.generator.query.DataObjectException,
                     com.lutris.dods.builder.generator.query.NonUniqueQueryException
Throws:
com.lutris.dods.builder.generator.query.DataObjectException
com.lutris.dods.builder.generator.query.NonUniqueQueryException

getDOArray

public ProcessStateEventAuditDO[] getDOArray()
                                      throws com.lutris.dods.builder.generator.query.DataObjectException,
                                             com.lutris.dods.builder.generator.query.NonUniqueQueryException
Return array of DOs constructed from ResultSet returned by query.

Returns:
Array of DOs constructed from ResultSet returned by query.
Throws:
com.lutris.dods.builder.generator.query.DataObjectException - If a database access error occurs.
com.lutris.dods.builder.generator.query.NonUniqueQueryException - If too many rows were found.

getNextDO

public ProcessStateEventAuditDO getNextDO()
                                   throws com.lutris.dods.builder.generator.query.DataObjectException,
                                          com.lutris.dods.builder.generator.query.NonUniqueQueryException
Return successive DOs from array built from ResultSet returned by query.

Returns:
DOs from array built from ResultSet returned by query.
Throws:
com.lutris.dods.builder.generator.query.DataObjectException - If a database access error occurs.
com.lutris.dods.builder.generator.query.NonUniqueQueryException - If too many rows were found.

setQueryOId

public void setQueryOId(com.lutris.appserver.server.sql.ObjectId oid)
Set the OID to query. WARNING! This method assumes that table SHKProcessStateEventAudits has a column named "oid". This method is called from the DO classes to retrieve an object by id.

Parameters:
oid - The object id to query.

setQueryHandle

public void setQueryHandle(java.lang.String handle)
                    throws com.lutris.appserver.server.sql.ObjectIdException
Set the object handle to query. This is a variant of setQueryOId().

Parameters:
handle - The string version of the id to query.
Throws:
com.lutris.appserver.server.sql.ObjectIdException

requireUniqueInstance

public void requireUniqueInstance()
Set "unique instance" assertion bit. The first call to the next() method will throw an exception if more than one object was found.


setLoadData

public void setLoadData(boolean newValue)
Set loadData parameter. if parameter is set to true, Query select t.* is performed.

Parameters:
newValue - boolean (true/false)

getLoadData

public boolean getLoadData()
Return true if Query is prepared for select t1.* statement. Otherwise return false.

Returns:
boolean (true/false)

reset

public void reset()
Reset the query parameters.


executeQuery

public java.sql.ResultSet executeQuery(com.lutris.appserver.server.sql.DBConnection conn)
                                throws java.sql.SQLException
Method to query objects from the database. The following call in runQuery() dbQuery.query( this ); causes the dbQuery object to invoke executeQuery()

Specified by:
executeQuery in interface com.lutris.appserver.server.sql.Query
Parameters:
conn - Handle to database connection.
Returns:
ResultSet with the results of the query.
Throws:
java.sql.SQLException - If a database access error occurs.

next

public java.lang.Object next(java.sql.ResultSet rs)
                      throws java.sql.SQLException,
                             com.lutris.appserver.server.sql.ObjectIdException
WARNING! This method is disabled. It's implementation is forced by the Query interface. This method is disabled for 2 reasons: 1) the getDOArray() and getNextDO() methods are better because they return DOs instead of JDBC objects. 2) the ceInternal() method throws an exception that we cannot reasonably handle here, and that we cannot throw from here.

Specified by:
next in interface com.lutris.appserver.server.sql.Query
Parameters:
rs - JDBC result set from which the next object will be instantiated.
Returns:
Next result.
Throws:
java.sql.SQLException - If a database access error occurs.
com.lutris.appserver.server.sql.ObjectIdException - If an invalid object id was queried from the database.

convertUserSearchValue

public java.lang.String convertUserSearchValue(java.lang.String userSearchValue)
Convert a String with user wildcards into a string with DB wildcards

Parameters:
userSearchValue - The string with user wildcards
Returns:
The string with DB wildcards WebDocWf extension

containsWildcards

public boolean containsWildcards(java.lang.String dbSearchValue)
Check whether a string contains DB wildcards

Parameters:
dbSearchValue - The string with possible DB wildcards
Returns:
Whether a string contains DB wildcards WebDocWf extension

getCount

public int getCount()
             throws com.lutris.dods.builder.generator.query.NonUniqueQueryException,
                    com.lutris.dods.builder.generator.query.DataObjectException,
                    java.sql.SQLException,
                    com.lutris.appserver.server.sql.DatabaseManagerException
Get the rowcount of the query If possible, do it without reading all rows

Returns:
The row count
Throws:
com.lutris.dods.builder.generator.query.NonUniqueQueryException
com.lutris.dods.builder.generator.query.DataObjectException
java.sql.SQLException
com.lutris.appserver.server.sql.DatabaseManagerException - WebDocWf extension

set_CursorType

public void set_CursorType(int resultSetType,
                           int resultSetConcurrency)
set the current cursor type - overrides default value from dbVendorConf file.

Parameters:
resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE.
resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE.
Returns:
the current queryTimeout;

set_FetchSize

public void set_FetchSize(int iCurrentFetchSizeIn)
Set fetch size for this query

Parameters:
iCurrentFetchSizeIn - Query fetch size.

get_FetchSize

public int get_FetchSize()
reads the current fetchsize for this query

Returns:
the current fetchsize; if -1 the no fetchsize is defined, defaultFetchSize will be use if defined

get_QueryTimeout

public int get_QueryTimeout()
Reads the current queryTimeout for this query.

Returns:
the current queryTimeout;

set_QueryTimeout

public void set_QueryTimeout(int iQueryTimeoutIn)
Sets the current queryTimeout for this query.

Parameters:
iQueryTimeoutIn - current queryTimeout.

selectCount

public int selectCount()
                throws java.sql.SQLException,
                       com.lutris.appserver.server.sql.DatabaseManagerException
Get the rowcount of the query by using count(*) in the DB

Returns:
The row count.
Throws:
java.sql.SQLException
com.lutris.appserver.server.sql.DatabaseManagerException - WebDocWf extension

setQueryKeyValue

public void setQueryKeyValue(java.lang.String x,
                             java.lang.String cmp_op)
                      throws com.lutris.dods.builder.generator.query.DataObjectException,
                             com.lutris.dods.builder.generator.query.QueryException
Set the KeyValue to query, with a QueryBuilder comparison operator.

Parameters:
x - The KeyValue of the SHKProcessStateEventAudits to query.
cmp_op - QueryBuilder comparison operator to use.
Throws:
com.lutris.dods.builder.generator.query.DataObjectException - If a database access error occurs.
com.lutris.dods.builder.generator.query.QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field).

setQueryKeyValue

public void setQueryKeyValue(java.lang.String x)
                      throws com.lutris.dods.builder.generator.query.DataObjectException,
                             com.lutris.dods.builder.generator.query.QueryException
Set the KeyValue to query, with a QueryBuilder comparison operator.

Parameters:
x - The KeyValue of the SHKProcessStateEventAudits to query.
Throws:
com.lutris.dods.builder.generator.query.DataObjectException - If a database access error occurs.
com.lutris.dods.builder.generator.query.QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field).

addOrderByKeyValue

public void addOrderByKeyValue(boolean direction_flag)
Add KeyValue to the ORDER BY clause. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.

Parameters:
direction_flag - True for ascending order, false for descending

addOrderByKeyValue

public void addOrderByKeyValue()
Add KeyValue to the ORDER BY clause. This convenience method assumes ascending order. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.


setUserMatchKeyValue

public void setUserMatchKeyValue(java.lang.String x)
                          throws com.lutris.dods.builder.generator.query.DataObjectException,
                                 com.lutris.dods.builder.generator.query.QueryException
Deprecated. Use comparison operators instead WebDocWf extension

Set the KeyValue to query with a user wildcard string

Parameters:
x - The KeyValue of the SHKProcessStateEventAudits to query with user wildcards
Throws:
com.lutris.dods.builder.generator.query.DataObjectException - If a database access error occurs.
com.lutris.dods.builder.generator.query.QueryException - If a query error occurs.

setDBMatchKeyValue

public void setDBMatchKeyValue(java.lang.String x)
                        throws com.lutris.dods.builder.generator.query.DataObjectException,
                               com.lutris.dods.builder.generator.query.QueryException
Deprecated. Use comparison operators instead WebDocWf extension

Set the KeyValue to query with a DB wildcard string

Parameters:
x - The KeyValue of the SHKProcessStateEventAudits to query with DB wildcards
Throws:
com.lutris.dods.builder.generator.query.DataObjectException - If a database access error occurs.
com.lutris.dods.builder.generator.query.QueryException - If a query error occurs.

setQueryName

public void setQueryName(java.lang.String x,
                         java.lang.String cmp_op)
                  throws com.lutris.dods.builder.generator.query.DataObjectException,
                         com.lutris.dods.builder.generator.query.QueryException
Set the Name to query, with a QueryBuilder comparison operator.

Parameters:
x - The Name of the SHKProcessStateEventAudits to query.
cmp_op - QueryBuilder comparison operator to use.
Throws:
com.lutris.dods.builder.generator.query.DataObjectException - If a database access error occurs.
com.lutris.dods.builder.generator.query.QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field).

setQueryName

public void setQueryName(java.lang.String x)
                  throws com.lutris.dods.builder.generator.query.DataObjectException,
                         com.lutris.dods.builder.generator.query.QueryException
Set the Name to query, with a QueryBuilder comparison operator.

Parameters:
x - The Name of the SHKProcessStateEventAudits to query.
Throws:
com.lutris.dods.builder.generator.query.DataObjectException - If a database access error occurs.
com.lutris.dods.builder.generator.query.QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field).

addOrderByName

public void addOrderByName(boolean direction_flag)
Add Name to the ORDER BY clause. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.

Parameters:
direction_flag - True for ascending order, false for descending

addOrderByName

public void addOrderByName()
Add Name to the ORDER BY clause. This convenience method assumes ascending order. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.


setUserMatchName

public void setUserMatchName(java.lang.String x)
                      throws com.lutris.dods.builder.generator.query.DataObjectException,
                             com.lutris.dods.builder.generator.query.QueryException
Deprecated. Use comparison operators instead WebDocWf extension

Set the Name to query with a user wildcard string

Parameters:
x - The Name of the SHKProcessStateEventAudits to query with user wildcards
Throws:
com.lutris.dods.builder.generator.query.DataObjectException - If a database access error occurs.
com.lutris.dods.builder.generator.query.QueryException - If a query error occurs.

setDBMatchName

public void setDBMatchName(java.lang.String x)
                    throws com.lutris.dods.builder.generator.query.DataObjectException,
                           com.lutris.dods.builder.generator.query.QueryException
Deprecated. Use comparison operators instead WebDocWf extension

Set the Name to query with a DB wildcard string

Parameters:
x - The Name of the SHKProcessStateEventAudits to query with DB wildcards
Throws:
com.lutris.dods.builder.generator.query.DataObjectException - If a database access error occurs.
com.lutris.dods.builder.generator.query.QueryException - If a query error occurs.

getQueryBuilder

public com.lutris.dods.builder.generator.query.QueryBuilder getQueryBuilder()
Returns the QueryBuilder that this ProcessStateEventAuditQuery uses to construct and execute database queries. ProcessStateEventAuditQuery.setQueryXXX methods use the QueryBuilder to append SQL expressions to the "WHERE" clause to be executed. The QueryBuilder.addEndClause method. can be used to append freeform SQL expressions to the WHERE clause, e.g. "ORDER BY name". Notes regarding cache-enabled DO classes: DO classes can be cache-enabled. If when using a ProcessStateEventAuditQuery, the application developer does not call getQueryBuilder, then ProcessStateEventAuditQuery.setQueryXXX methods simply prune the DO cache and return the remaining results. However, a QueryBuilder builds SELECT statements for execution by the actual database, and never searches the built-in cache for the DO. So, if the DO class is cache-enabled, and getQueryBuilder is called, this ProcessStateEventAuditQuery object ignores the cache and hits the actual database.

Returns:
QueryBuilder that is used to construct and execute database queries.

or

public void or()
Insert an OR between WHERE clauses. Example: find all the persons named Bob or Robert: PersonQuery pq = new PersonQuery(); pq.setQueryFirstName( "Bob" ); pq.or(); pq.setQueryFirstName( "Robert" ); Note: Calls to setQueryXxx methods are implicitly ANDed together, so the following example will always return nothing: PersonQuery pq = new PersonQuery(); pq.setQueryFirstName( "Bob" ); // AND automatically inserted here. pq.setQueryFirstName( "Robert" ); NOTE: The DO cache does not yet support the OR operator. Using the or() method forces the query to hit the database.

See Also:
QueryBuilder to construct more elaborate queries. author Jay Gunter

openParen

public void openParen()
Place an open parenthesis in the WHERE clause. Example usage: find all the Bobs and Roberts who are 5 or 50 years old: PersonQuery pq = new PersonQuery(); pq.openParen(); pq.setQueryFirstName( "Bob" ); pq.or(); pq.setQueryFirstName( "Robert" ); pq.closeParen(); // AND automatically inserted here. pq.openParen(); pq.setQueryAge( 5 ); pq.or(); pq.setQueryAge( 50 ); pq.closeParen(); NOTE: The DO cache does not yet support the Open Paren operator. Using the openParen() method forces the query to hit the database.

See Also:
QueryBuilder to construct more elaborate queries. author Jay Gunter

closeParen

public void closeParen()
Place a closing parenthesis in the WHERE clause. NOTE: The DO cache does not yet support the Close Paren operator. Using the closeParen() method forces the query to hit the database.

See Also:
openParen author Jay Gunter