DODS 5.1 API

org.webdocwf.util.genericstore.data
Class GenericObjectQuery

java.lang.Object
  |
  +--org.webdocwf.util.genericstore.data.GenericObjectQuery
All Implemented Interfaces:
Query

public class GenericObjectQuery
extends java.lang.Object
implements Query

GenericObjectQuery is used to query the GENERICOBJECT table in the database. It returns objects of type GenericObjectDO.

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.2 $
Author:
administrator

Constructor Summary
GenericObjectQuery()
          Public constructor.
GenericObjectQuery(User usr)
          Constructor for Query with security
 
Method Summary
 void addOrderByEXTERNALOID()
          Add EXTERNALOID to the ORDER BY clause.
 void addOrderByEXTERNALOID(boolean direction_flag)
          Add EXTERNALOID to the ORDER BY clause.
 void addOrderByTYPEDEFINITIONOID()
          Add TYPEDEFINITIONOID to the ORDER BY clause.
 void addOrderByTYPEDEFINITIONOID(boolean direction_flag)
          Add TYPEDEFINITIONOID to the ORDER BY clause.
static void assertQueryAccess(User usr)
          Ensure that the given user is allowed to create a query
 void assertQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x, boolean exact, User usr)
          Deprecated. Instead use assertQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension
 void assertQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x, java.lang.String cmp_op, User usr)
          Ensure the given user is allowed to query the attribute
 void assertQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x, User usr)
          Ensure the given user is allowed to query the attribute
 void assertQueryAttrTYPEDEFINITIONOIDAccess(TypeDefinitionDO x, boolean exact, User usr)
          Deprecated. Instead use assertQueryAttrTYPEDEFINITIONOIDAccess(org.webdocwf.util.genericstore.data.TypeDefinitionDO x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension
 void assertQueryAttrTYPEDEFINITIONOIDAccess(TypeDefinitionDO x, java.lang.String cmp_op, User usr)
          Ensure the given user is allowed to query the attribute
 void assertQueryAttrTYPEDEFINITIONOIDAccess(TypeDefinitionDO x, User usr)
          Ensure the given user is allowed to query the attribute
 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(DBConnection conn)
          Method to query objects from the database.
 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
 GenericObjectDO[] getDOArray()
          Return array of DOs constructed from ResultSet returned by query.
 GenericObjectDO getNextDO()
          Return successive DOs from array built from ResultSet returned by query.
 QueryBuilder getQueryBuilder()
          Returns the QueryBuilder that this GenericObjectQuery uses to construct and execute database queries.
 int getReadSkip()
          Get the readSkip number of the query
 boolean getUnique()
          Get the unique flag of the query
 User getUser()
          Get the user of the query
 boolean getUserStringAppendWildcard()
           
 java.lang.String getUserStringSingleWildcard()
           
 java.lang.String getUserStringSingleWildcardEscape()
           
 boolean getUserStringTrim()
           
 java.lang.String getUserStringWildcard()
           
 java.lang.String getUserStringWildcardEscape()
           
static boolean hasQueryAccess(User usr)
          Check whether the given user is allowed to create a query
 boolean hasQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x, boolean exact, User usr)
          Deprecated. Instead use hasQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension
 boolean hasQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x, java.lang.String cmp_op, User usr)
          Check whether the given user is allowed to query the attribute
 boolean hasQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x, User usr)
          Check whether the given user is allowed to query the attribute
 boolean hasQueryAttrTYPEDEFINITIONOIDAccess(TypeDefinitionDO x, boolean exact, User usr)
          Deprecated. Instead use hasQueryAttrTYPEDEFINITIONOIDAccess(org.webdocwf.util.genericstore.data.TypeDefinitionDO x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension
 boolean hasQueryAttrTYPEDEFINITIONOIDAccess(TypeDefinitionDO x, java.lang.String cmp_op, User usr)
          Check whether the given user is allowed to query the attribute
 boolean hasQueryAttrTYPEDEFINITIONOIDAccess(TypeDefinitionDO x, User usr)
          Check whether the given user is allowed to query the attribute
 void hitDatabase()
           
 java.lang.Object next(java.sql.ResultSet rs)
          WARNING! This method is disabled.
 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 setDatabaseLimit(int newLimit)
          Set the database limit of the query
 void setMaxRows(int maxRows)
          Limit the number of rows (DOs) returned.
 void setQueryEXTERNALOID(java.math.BigDecimal x)
          Set the EXTERNALOID to query
 void setQueryEXTERNALOID(java.math.BigDecimal x, boolean exact)
          Deprecated. Instead use setQueryEXTERNALOID(java.math.BigDecimal x,String cmp_op)
 void setQueryEXTERNALOID(java.math.BigDecimal x, boolean exact, User usr)
          Deprecated. Instead use setQueryEXTERNALOID(java.math.BigDecimal x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension
 void setQueryEXTERNALOID(java.math.BigDecimal x, java.lang.String cmp_op)
          Set the EXTERNALOID to query, with a QueryBuilder comparison operator.
 void setQueryEXTERNALOID(java.math.BigDecimal x, java.lang.String cmp_op, User usr)
          Set the EXTERNALOID to query, with a QueryBuilder comparison operator.
 void setQueryEXTERNALOID(java.math.BigDecimal x, User usr)
          Set the EXTERNALOID to query.
 void setQueryHandle(java.lang.String handle)
          Set the object handle to query.
 void setQueryOId(ObjectId oid)
          Set the OID to query.
 void setQueryTYPEDEFINITIONOID(TypeDefinitionDO x)
          Set the TYPEDEFINITIONOID to query
 void setQueryTYPEDEFINITIONOID(TypeDefinitionDO x, boolean exact)
          Deprecated. Instead use setQueryTYPEDEFINITIONOID(org.webdocwf.util.genericstore.data.TypeDefinitionDO x,String cmp_op)
 void setQueryTYPEDEFINITIONOID(TypeDefinitionDO x, boolean exact, User usr)
          Deprecated. Instead use setQueryTYPEDEFINITIONOID(org.webdocwf.util.genericstore.data.TypeDefinitionDO x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension
 void setQueryTYPEDEFINITIONOID(TypeDefinitionDO x, java.lang.String cmp_op)
          Set the TYPEDEFINITIONOID to query, with a QueryBuilder comparison operator.
 void setQueryTYPEDEFINITIONOID(TypeDefinitionDO x, java.lang.String cmp_op, User usr)
          Set the TYPEDEFINITIONOID to query, with a QueryBuilder comparison operator.
 void setQueryTYPEDEFINITIONOID(TypeDefinitionDO x, User usr)
          Set the TYPEDEFINITIONOID to query.
 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)
           
 void setUserStringSingleWildcard(java.lang.String newUserStringSingleWildcard)
           
 void setUserStringSingleWildcardEscape(java.lang.String newUserStringSingleWildcardEscape)
           
 void setUserStringTrim(boolean userStringTrim)
           
 void setUserStringWildcard(java.lang.String newUserStringWildcard)
           
 void setUserStringWildcardEscape(java.lang.String newUserStringWildcardEscape)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GenericObjectQuery

public GenericObjectQuery()
Public constructor.


GenericObjectQuery

public GenericObjectQuery(User usr)
                   throws AccessException
Constructor for Query with security

Parameters:
usr - The user for security check
Throws:
AccessException - The user is not allowed to create a query WebDocWf extension
Method Detail

assertQueryAccess

public static void assertQueryAccess(User usr)
                              throws AccessException
Ensure that the given user is allowed to create a query

Parameters:
usr - The user for security check
Throws:
AccessException - The user is not allowed to create a query WebDocWf extension

hasQueryAccess

public static boolean hasQueryAccess(User usr)
                              throws AccessEvalException
Check whether the given user is allowed to create a query

Parameters:
usr - The user for security check
Returns:
Whether the given user is allowed to create a query WebDocWf extension
AccessEvalException

getUser

public User getUser()
Get the user of the query

Returns:
The user of the query WebDocWf extension

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


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 WebDocWf extension

hitDatabase

public void hitDatabase()

setUserStringWildcard

public void setUserStringWildcard(java.lang.String newUserStringWildcard)

setUserStringSingleWildcard

public void setUserStringSingleWildcard(java.lang.String newUserStringSingleWildcard)

setUserStringSingleWildcardEscape

public void setUserStringSingleWildcardEscape(java.lang.String newUserStringSingleWildcardEscape)

setUserStringWildcardEscape

public void setUserStringWildcardEscape(java.lang.String newUserStringWildcardEscape)

setUserStringAppendWildcard

public void setUserStringAppendWildcard(boolean userStringAppendWildcard)

setUserStringTrim

public void setUserStringTrim(boolean userStringTrim)

getUserStringWildcard

public java.lang.String getUserStringWildcard()

getUserStringSingleWildcard

public java.lang.String getUserStringSingleWildcard()

getUserStringSingleWildcardEscape

public java.lang.String getUserStringSingleWildcardEscape()

getUserStringWildcardEscape

public java.lang.String getUserStringWildcardEscape()

getUserStringAppendWildcard

public boolean getUserStringAppendWildcard()

getUserStringTrim

public boolean getUserStringTrim()

setMaxRows

public void setMaxRows(int maxRows)
                throws DataObjectException,
                       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.

Throws:
DataObjectException - If a database access error occurs.
NonUniqueQueryException - If too many rows were found.

getDOArray

public GenericObjectDO[] getDOArray()
                             throws DataObjectException,
                                    NonUniqueQueryException
Return array of DOs constructed from ResultSet returned by query.

Throws:
DataObjectException - If a database access error occurs.
NonUniqueQueryException - If too many rows were found.

getNextDO

public GenericObjectDO getNextDO()
                          throws DataObjectException,
                                 NonUniqueQueryException
Return successive DOs from array built from ResultSet returned by query.

Throws:
DataObjectException - If a database access error occurs.
NonUniqueQueryException - If too many rows were found.

setQueryOId

public void setQueryOId(ObjectId oid)
Set the OID to query. WARNING! This method assumes that table GENERICOBJECT 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 ObjectIdException
Set the object handle to query. This is a variant of setQueryOId().

Parameters:
handle - The string version of the id to query.
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.


reset

public void reset()
Reset the query parameters.


executeQuery

public java.sql.ResultSet executeQuery(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 Query
Parameters:
conn - Handle to database connection.
Throws:
java.sql.SQLException - If a database access error occurs.

next

public java.lang.Object next(java.sql.ResultSet rs)
                      throws java.sql.SQLException,
                             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 createExisting() method throws an exception that we cannot reasonably handle here, and that we cannot throw from here.

Specified by:
next in interface Query
Parameters:
rs - JDBC result set from which the next object will be instantiated.
Throws:
java.sql.SQLException - If a database access error occurs.
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 NonUniqueQueryException,
                    DataObjectException,
                    java.sql.SQLException,
                    DatabaseManagerException
Get the rowcount of the query If possible, do it without reading all rows

Returns:
The row count WebDocWf extension
NonUniqueQueryException
DataObjectException
java.sql.SQLException
DatabaseManagerException

selectCount

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

Returns:
The row count WebDocWf extension
java.sql.SQLException
DatabaseManagerException

setQueryEXTERNALOID

public void setQueryEXTERNALOID(java.math.BigDecimal x,
                                java.lang.String cmp_op)
                         throws DataObjectException,
                                QueryException
Set the EXTERNALOID to query, with a QueryBuilder comparison operator.

Parameters:
x - The EXTERNALOID of the GENERICOBJECT to query.
cmp_op - QueryBuilder comparison operator to use.
Throws:
DataObjectException - If a database access error occurs.
QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field).

setQueryEXTERNALOID

public void setQueryEXTERNALOID(java.math.BigDecimal x,
                                boolean exact)
                         throws DataObjectException,
                                QueryException
Deprecated. Instead use setQueryEXTERNALOID(java.math.BigDecimal x,String cmp_op)

Set the EXTERNALOID to query.

Parameters:
x - The EXTERNALOID of the GENERICOBJECT to query.
exact - to use matches or not
Throws:
DataObjectException - If a database access error occurs.
QueryException

setQueryEXTERNALOID

public void setQueryEXTERNALOID(java.math.BigDecimal x)
                         throws DataObjectException,
                                QueryException
Set the EXTERNALOID to query

Parameters:
x - The EXTERNALOID of the GENERICOBJECT to query.
Throws:
DataObjectException - If a database access error occurs.
QueryException

addOrderByEXTERNALOID

public void addOrderByEXTERNALOID(boolean direction_flag)
Add EXTERNALOID to the ORDER BY clause.

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

addOrderByEXTERNALOID

public void addOrderByEXTERNALOID()
Add EXTERNALOID to the ORDER BY clause. This convenience method assumes ascending order.


setQueryEXTERNALOID

public void setQueryEXTERNALOID(java.math.BigDecimal x,
                                boolean exact,
                                User usr)
                         throws DataObjectException,
                                QueryException,
                                AccessException
Deprecated. Instead use setQueryEXTERNALOID(java.math.BigDecimal x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension

Set the EXTERNALOID to query.

Parameters:
x - The EXTERNALOID of the GENERICOBJECT to query.
exact - to use matches or not
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setQueryEXTERNALOID

public void setQueryEXTERNALOID(java.math.BigDecimal x,
                                User usr)
                         throws DataObjectException,
                                QueryException,
                                AccessException
Set the EXTERNALOID to query.

Parameters:
x - The EXTERNALOID of the GENERICOBJECT to query.
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute WebDocWf extension
QueryException

setQueryEXTERNALOID

public void setQueryEXTERNALOID(java.math.BigDecimal x,
                                java.lang.String cmp_op,
                                User usr)
                         throws DataObjectException,
                                QueryException,
                                AccessException
Set the EXTERNALOID to query, with a QueryBuilder comparison operator.

Parameters:
x - The EXTERNALOID of the GENERICOBJECT to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field). WebDocWf extension
AccessException

assertQueryAttrEXTERNALOIDAccess

public void assertQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x,
                                             boolean exact,
                                             User usr)
                                      throws AccessException
Deprecated. Instead use assertQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Ensure the given user is allowed to query the attribute

Parameters:
x - The EXTERNALOID of the GENERICOBJECT to query.
exact - to use matches or not
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute

assertQueryAttrEXTERNALOIDAccess

public void assertQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x,
                                             java.lang.String cmp_op,
                                             User usr)
                                      throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The EXTERNALOID of the GENERICOBJECT to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

assertQueryAttrEXTERNALOIDAccess

public void assertQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x,
                                             User usr)
                                      throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The EXTERNALOID of the GENERICOBJECT to query.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

hasQueryAttrEXTERNALOIDAccess

public boolean hasQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x,
                                             boolean exact,
                                             User usr)
                                      throws AccessEvalException
Deprecated. Instead use hasQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Check whether the given user is allowed to query the attribute

Parameters:
x - The EXTERNALOID of the GENERICOBJECT to query.
exact - to use matches or not
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute
AccessEvalException

hasQueryAttrEXTERNALOIDAccess

public boolean hasQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x,
                                             java.lang.String cmp_op,
                                             User usr)
                                      throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The EXTERNALOID of the GENERICOBJECT to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

hasQueryAttrEXTERNALOIDAccess

public boolean hasQueryAttrEXTERNALOIDAccess(java.math.BigDecimal x,
                                             User usr)
                                      throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The EXTERNALOID of the GENERICOBJECT to query.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

setQueryTYPEDEFINITIONOID

public void setQueryTYPEDEFINITIONOID(TypeDefinitionDO x,
                                      java.lang.String cmp_op)
                               throws DataObjectException,
                                      QueryException
Set the TYPEDEFINITIONOID to query, with a QueryBuilder comparison operator.

Parameters:
x - The TYPEDEFINITIONOID of the GENERICOBJECT to query.
cmp_op - QueryBuilder comparison operator to use.
Throws:
DataObjectException - If a database access error occurs.
QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field).

setQueryTYPEDEFINITIONOID

public void setQueryTYPEDEFINITIONOID(TypeDefinitionDO x,
                                      boolean exact)
                               throws DataObjectException,
                                      QueryException
Deprecated. Instead use setQueryTYPEDEFINITIONOID(org.webdocwf.util.genericstore.data.TypeDefinitionDO x,String cmp_op)

Set the TYPEDEFINITIONOID to query.

Parameters:
x - The TYPEDEFINITIONOID of the GENERICOBJECT to query.
exact - to use matches or not
Throws:
DataObjectException - If a database access error occurs.
QueryException

setQueryTYPEDEFINITIONOID

public void setQueryTYPEDEFINITIONOID(TypeDefinitionDO x)
                               throws DataObjectException,
                                      QueryException
Set the TYPEDEFINITIONOID to query

Parameters:
x - The TYPEDEFINITIONOID of the GENERICOBJECT to query.
Throws:
DataObjectException - If a database access error occurs.
QueryException

addOrderByTYPEDEFINITIONOID

public void addOrderByTYPEDEFINITIONOID(boolean direction_flag)
Add TYPEDEFINITIONOID to the ORDER BY clause.

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

addOrderByTYPEDEFINITIONOID

public void addOrderByTYPEDEFINITIONOID()
Add TYPEDEFINITIONOID to the ORDER BY clause. This convenience method assumes ascending order.


setQueryTYPEDEFINITIONOID

public void setQueryTYPEDEFINITIONOID(TypeDefinitionDO x,
                                      boolean exact,
                                      User usr)
                               throws DataObjectException,
                                      QueryException,
                                      AccessException
Deprecated. Instead use setQueryTYPEDEFINITIONOID(org.webdocwf.util.genericstore.data.TypeDefinitionDO x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension

Set the TYPEDEFINITIONOID to query.

Parameters:
x - The TYPEDEFINITIONOID of the GENERICOBJECT to query.
exact - to use matches or not
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setQueryTYPEDEFINITIONOID

public void setQueryTYPEDEFINITIONOID(TypeDefinitionDO x,
                                      User usr)
                               throws DataObjectException,
                                      QueryException,
                                      AccessException
Set the TYPEDEFINITIONOID to query.

Parameters:
x - The TYPEDEFINITIONOID of the GENERICOBJECT to query.
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute WebDocWf extension
QueryException

setQueryTYPEDEFINITIONOID

public void setQueryTYPEDEFINITIONOID(TypeDefinitionDO x,
                                      java.lang.String cmp_op,
                                      User usr)
                               throws DataObjectException,
                                      QueryException,
                                      AccessException
Set the TYPEDEFINITIONOID to query, with a QueryBuilder comparison operator.

Parameters:
x - The TYPEDEFINITIONOID of the GENERICOBJECT to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field). WebDocWf extension
AccessException

assertQueryAttrTYPEDEFINITIONOIDAccess

public void assertQueryAttrTYPEDEFINITIONOIDAccess(TypeDefinitionDO x,
                                                   boolean exact,
                                                   User usr)
                                            throws AccessException
Deprecated. Instead use assertQueryAttrTYPEDEFINITIONOIDAccess(org.webdocwf.util.genericstore.data.TypeDefinitionDO x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Ensure the given user is allowed to query the attribute

Parameters:
x - The TYPEDEFINITIONOID of the GENERICOBJECT to query.
exact - to use matches or not
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute

assertQueryAttrTYPEDEFINITIONOIDAccess

public void assertQueryAttrTYPEDEFINITIONOIDAccess(TypeDefinitionDO x,
                                                   java.lang.String cmp_op,
                                                   User usr)
                                            throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The TYPEDEFINITIONOID of the GENERICOBJECT to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

assertQueryAttrTYPEDEFINITIONOIDAccess

public void assertQueryAttrTYPEDEFINITIONOIDAccess(TypeDefinitionDO x,
                                                   User usr)
                                            throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The TYPEDEFINITIONOID of the GENERICOBJECT to query.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

hasQueryAttrTYPEDEFINITIONOIDAccess

public boolean hasQueryAttrTYPEDEFINITIONOIDAccess(TypeDefinitionDO x,
                                                   boolean exact,
                                                   User usr)
                                            throws AccessEvalException
Deprecated. Instead use hasQueryAttrTYPEDEFINITIONOIDAccess(org.webdocwf.util.genericstore.data.TypeDefinitionDO x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Check whether the given user is allowed to query the attribute

Parameters:
x - The TYPEDEFINITIONOID of the GENERICOBJECT to query.
exact - to use matches or not
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute
AccessEvalException

hasQueryAttrTYPEDEFINITIONOIDAccess

public boolean hasQueryAttrTYPEDEFINITIONOIDAccess(TypeDefinitionDO x,
                                                   java.lang.String cmp_op,
                                                   User usr)
                                            throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The TYPEDEFINITIONOID of the GENERICOBJECT to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

hasQueryAttrTYPEDEFINITIONOIDAccess

public boolean hasQueryAttrTYPEDEFINITIONOIDAccess(TypeDefinitionDO x,
                                                   User usr)
                                            throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The TYPEDEFINITIONOID of the GENERICOBJECT to query.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

getQueryBuilder

public QueryBuilder getQueryBuilder()
Returns the QueryBuilder that this GenericObjectQuery uses to construct and execute database queries. GenericObjectQuery.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 GenericObjectQuery, the application developer does not call getQueryBuilder, then GenericObjectQuery.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 GenericObjectQuery object ignores the cache and hits the actual database.


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" );

See Also:
to construct more elaborate queries.

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();

See Also:
to construct more elaborate queries.

closeParen

public void closeParen()
Place a closing parenthesis in the WHERE clause.


DODS 5.1 API