|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.enhydra.shark.partmappersistence.data.GroupUserPackLevelParticipantQuery
public class GroupUserPackLevelParticipantQuery
GroupUserPackLevelParticipantQuery is used to query the SHKGroupUserPackLevelPart table in the database.
It returns objects of type GroupUserPackLevelParticipantDO.
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();
Constructor Summary | |
---|---|
GroupUserPackLevelParticipantQuery(com.lutris.appserver.server.sql.DBTransaction dbTrans)
Public constructor. |
Method Summary | |
---|---|
void |
addOrderByPARTICIPANTOID()
Add PARTICIPANTOID to the ORDER BY clause. |
void |
addOrderByPARTICIPANTOID(boolean direction_flag)
Add PARTICIPANTOID to the ORDER BY clause. |
void |
addOrderByUSEROID()
Add USEROID to the ORDER BY clause. |
void |
addOrderByUSEROID(boolean direction_flag)
Add USEROID 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. |
GroupUserPackLevelParticipantDO[] |
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 GroupUserPackLevelParticipantQuery object uses |
int |
getMaxRows()
Return limit of rows (DOs) returned. |
GroupUserPackLevelParticipantDO |
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 GroupUserPackLevelParticipantQuery
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 |
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 |
setQueryOId(com.lutris.appserver.server.sql.ObjectId oid)
Set the OID to query. |
void |
setQueryPARTICIPANTOID(PackLevelParticipantDO x)
Set the PARTICIPANTOID to query, with a QueryBuilder comparison operator. |
void |
setQueryPARTICIPANTOID(PackLevelParticipantDO x,
java.lang.String cmp_op)
Set the PARTICIPANTOID to query, with a QueryBuilder comparison operator. |
protected void |
setQueryTimeLimit(int qTimeLimit)
Sets attribute QueryTimeLimit. |
void |
setQueryUSEROID(GroupUserDO x)
Set the USEROID to query, with a QueryBuilder comparison operator. |
void |
setQueryUSEROID(GroupUserDO x,
java.lang.String cmp_op)
Set the USEROID to query, with a QueryBuilder comparison operator. |
void |
setReadSkip(int newReadSkip)
Set the readSkip number of the query |
void |
setUnique(boolean newUnique)
Set the unique flag of the query |
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 |
---|
public GroupUserPackLevelParticipantQuery(com.lutris.appserver.server.sql.DBTransaction dbTrans)
dbTrans
- current database transactionMethod Detail |
---|
public java.lang.String getLogicalDatabase()
public java.sql.PreparedStatement getStatement()
getStatement
in interface com.lutris.appserver.server.sql.ExtendedQuery
public void setLogicalDatabase(java.lang.String dbName) throws java.sql.SQLException, com.lutris.appserver.server.sql.DatabaseManagerException
dbName
- the logical name of the database
java.sql.SQLException
com.lutris.appserver.server.sql.DatabaseManagerException
public void setUnique(boolean newUnique)
newUnique
- The unique flag for the query
WebDocWf extensionpublic boolean getUnique()
public void setReadSkip(int newReadSkip)
newReadSkip
- The number of results to skip.
WebDocWf extensionpublic int getReadSkip()
public void setDatabaseLimit(int newLimit)
newLimit
- The limit for the query
WebDocWf extensionpublic int getDatabaseLimit()
public boolean getDatabaseLimitExceeded()
public void hitDatabase()
public void setUserStringWildcard(java.lang.String newUserStringWildcard)
newUserStringWildcard
- New user string wildcard.
WebDocWf extensionpublic void setUserStringSingleWildcard(java.lang.String newUserStringSingleWildcard)
newUserStringSingleWildcard
- New user string single wildcard.
WebDocWf extensionpublic void setUserStringSingleWildcardEscape(java.lang.String newUserStringSingleWildcardEscape)
newUserStringSingleWildcardEscape
- New user string single wildcard escape.
WebDocWf extensionpublic void setUserStringWildcardEscape(java.lang.String newUserStringWildcardEscape)
newUserStringWildcardEscape
- New user string wildcard escape.
WebDocWf extensionpublic void setUserStringAppendWildcard(boolean userStringAppendWildcard)
userStringAppendWildcard
- New user string append wildcard.
WebDocWf extensionpublic void setUserStringTrim(boolean userStringTrim)
userStringTrim
- New user string trim.
WebDocWf extensionpublic java.lang.String getUserStringWildcard()
public java.lang.String getUserStringSingleWildcard()
public java.lang.String getUserStringSingleWildcardEscape()
public java.lang.String getUserStringWildcardEscape()
public boolean getUserStringAppendWildcard()
public boolean getUserStringTrim()
public void setMaxRows(int maxRows) throws com.lutris.dods.builder.generator.query.DataObjectException, com.lutris.dods.builder.generator.query.NonUniqueQueryException
maxRows
- Max number of rows (DOs) returned.
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.public int getMaxRows()
public boolean isOrderRelevant()
public void setOrderRelevant(boolean newOrderRelevant)
newOrderRelevant
- new value of attribute orderRelavant.protected void setQueryTimeLimit(int qTimeLimit)
qTimeLimit
- new value of attribute QueryTimeLimit.protected void setMaxExecuteTime(int maxExeTime)
maxExeTime
- new value of attribute maxExecuteTime.public org.enhydra.dods.cache.QueryResult getCachedResults(org.enhydra.dods.cache.QueryResult result) throws com.lutris.dods.builder.generator.query.DataObjectException
result
- QueryResult object with result oids.
com.lutris.dods.builder.generator.query.DataObjectException
- If a database access error occurs.public void writeXML(java.io.Writer ow) throws com.lutris.dods.builder.generator.query.DataObjectException, com.lutris.dods.builder.generator.query.NonUniqueQueryException
com.lutris.dods.builder.generator.query.DataObjectException
com.lutris.dods.builder.generator.query.NonUniqueQueryException
public GroupUserPackLevelParticipantDO[] getDOArray() throws com.lutris.dods.builder.generator.query.DataObjectException, com.lutris.dods.builder.generator.query.NonUniqueQueryException
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.public GroupUserPackLevelParticipantDO getNextDO() throws com.lutris.dods.builder.generator.query.DataObjectException, com.lutris.dods.builder.generator.query.NonUniqueQueryException
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.public void setQueryOId(com.lutris.appserver.server.sql.ObjectId oid)
SHKGroupUserPackLevelPart
has a column named "oid"
.
This method is called from the DO classes to retrieve an object by id.
oid
- The object id to query.public void setQueryHandle(java.lang.String handle) throws com.lutris.appserver.server.sql.ObjectIdException
handle
- The string version of the id to query.
com.lutris.appserver.server.sql.ObjectIdException
public void requireUniqueInstance()
public void setLoadData(boolean newValue)
newValue
- boolean (true/false)public boolean getLoadData()
public void reset()
public java.sql.ResultSet executeQuery(com.lutris.appserver.server.sql.DBConnection conn) throws java.sql.SQLException
executeQuery
in interface com.lutris.appserver.server.sql.Query
conn
- Handle to database connection.
java.sql.SQLException
- If a database access error occurs.public java.lang.Object next(java.sql.ResultSet rs) throws java.sql.SQLException, com.lutris.appserver.server.sql.ObjectIdException
next
in interface com.lutris.appserver.server.sql.Query
rs
- JDBC result set from which the next object
will be instantiated.
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.public java.lang.String convertUserSearchValue(java.lang.String userSearchValue)
userSearchValue
- The string with user wildcards
public boolean containsWildcards(java.lang.String dbSearchValue)
dbSearchValue
- The string with possible DB wildcards
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
com.lutris.dods.builder.generator.query.NonUniqueQueryException
com.lutris.dods.builder.generator.query.DataObjectException
java.sql.SQLException
com.lutris.appserver.server.sql.DatabaseManagerException
- WebDocWf extensionpublic void set_CursorType(int resultSetType, int resultSetConcurrency)
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.public void set_FetchSize(int iCurrentFetchSizeIn)
iCurrentFetchSizeIn
- Query fetch size.public int get_FetchSize()
public int get_QueryTimeout()
public void set_QueryTimeout(int iQueryTimeoutIn)
iQueryTimeoutIn
- current queryTimeout.public int selectCount() throws java.sql.SQLException, com.lutris.appserver.server.sql.DatabaseManagerException
java.sql.SQLException
com.lutris.appserver.server.sql.DatabaseManagerException
- WebDocWf extensionpublic void setQueryPARTICIPANTOID(PackLevelParticipantDO x, java.lang.String cmp_op) throws com.lutris.dods.builder.generator.query.DataObjectException, com.lutris.dods.builder.generator.query.QueryException
x
- The PARTICIPANTOID of the SHKGroupUserPackLevelPart to query.cmp_op
- QueryBuilder comparison operator to use.
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).public void setQueryPARTICIPANTOID(PackLevelParticipantDO x) throws com.lutris.dods.builder.generator.query.DataObjectException, com.lutris.dods.builder.generator.query.QueryException
x
- The PARTICIPANTOID of the SHKGroupUserPackLevelPart to query.
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).public void addOrderByPARTICIPANTOID(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderByPARTICIPANTOID()
public void setQueryUSEROID(GroupUserDO x, java.lang.String cmp_op) throws com.lutris.dods.builder.generator.query.DataObjectException, com.lutris.dods.builder.generator.query.QueryException
x
- The USEROID of the SHKGroupUserPackLevelPart to query.cmp_op
- QueryBuilder comparison operator to use.
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).public void setQueryUSEROID(GroupUserDO x) throws com.lutris.dods.builder.generator.query.DataObjectException, com.lutris.dods.builder.generator.query.QueryException
x
- The USEROID of the SHKGroupUserPackLevelPart to query.
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).public void addOrderByUSEROID(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderByUSEROID()
public com.lutris.dods.builder.generator.query.QueryBuilder getQueryBuilder()
QueryBuilder
that this GroupUserPackLevelParticipantQuery
uses to construct and execute database queries.
GroupUserPackLevelParticipantQuery.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 GroupUserPackLevelParticipantQuery
, the application developer
does not call getQueryBuilder
,
then GroupUserPackLevelParticipantQuery.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 GroupUserPackLevelParticipantQuery
object ignores the cache
and hits the actual database.
public void or()
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 AND
ed 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.
QueryBuilder to construct more elaborate queries.
author Jay Gunter
public void openParen()
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.
QueryBuilder to construct more elaborate queries.
author Jay Gunter
public void closeParen()
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.
openParen
author Jay Gunter
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |