|
PSE 2000 Group 4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
jobmatch.data.CandidateAccountQuery
CandidateAccountQuery is used to query the CandidateAccount table in the database.
It returns objects of type CandidateAccountDO.
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 = ""; DogBDO[] dogs = dq.getBDOArray(); for ( int i = 0; i < dogs.length; i++ ) { names += dogs[i].getName() + " "; }or #2:
String names = ""; DogBDO dog; while ( null != ( dog = dq.getNextBDO() ) ) { names += dog.getName() + " "; }Note: Methods
getDOArray()
and getNextDO()
do exist, but they are not generally used
in the Business or Presentation layers of an application.
All access to the Data Layer (DO classes) should occur via
the Business Layer (BDO classes).
Only the Business Layer (BDO classes and classes extending them)
should need to manipulate the Data Layer (DO classes).
See also the comments in the BDO constructors.
Note: If requireUniqueInstance()
was called,
then getBDOArray()
or getNextBDO()
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 | |
CandidateAccountQuery()
Public constructor. |
Method Summary | |
void |
addOrderByCandidate()
Add Candidate to the ORDER BY clause. |
void |
addOrderByCandidate(boolean direction_flag)
Add Candidate to the ORDER BY clause. |
void |
addOrderByEmail()
Add Email to the ORDER BY clause. |
void |
addOrderByEmail(boolean direction_flag)
Add Email to the ORDER BY clause. |
void |
addOrderByLastLogin()
Add LastLogin to the ORDER BY clause. |
void |
addOrderByLastLogin(boolean direction_flag)
Add LastLogin to the ORDER BY clause. |
void |
addOrderByLoginReminder()
Add LoginReminder to the ORDER BY clause. |
void |
addOrderByLoginReminder(boolean direction_flag)
Add LoginReminder to the ORDER BY clause. |
void |
addOrderByUsername()
Add Username to the ORDER BY clause. |
void |
addOrderByUsername(boolean direction_flag)
Add Username to the ORDER BY clause. |
void |
closeParen()
Place a closing parenthesis in the WHERE clause. |
ResultSet |
executeQuery(jobmatch.data.DBConnection conn)
Method to query objects from the database. |
CandidateAccountBDO[] |
getBDOArray()
Return array of BDOs constructed from ResultSet returned by query. |
CandidateAccountDO[] |
getDOArray()
Return array of DOs constructed from ResultSet returned by query. |
CandidateAccountBDO |
getNextBDO()
Return successive BDOs from array built from ResultSet returned by query. |
CandidateAccountDO |
getNextDO()
Return successive DOs from array built from ResultSet returned by query. |
jobmatch.data.QueryBuilder |
getQueryBuilder()
Returns the QueryBuilder that this CandidateAccountQuery
uses to construct and execute database queries. |
void |
hitDatabase()
|
Object |
next(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. |
void |
setQueryCandidate(CandidateDO x)
Set the Candidate to query |
void |
setQueryCandidate(CandidateDO x,
boolean exact)
Set the Candidate to query. |
void |
setQueryEmail(String x)
Set the Email to query |
void |
setQueryEmail(String x,
boolean exact)
Set the Email to query. |
void |
setQueryHandle(String handle)
Set the object handle to query. |
void |
setQueryLastLogin(Timestamp x)
Set the LastLogin to query |
void |
setQueryLastLogin(Timestamp x,
boolean exact)
Set the LastLogin to query. |
void |
setQueryLoginReminder(int x)
Set the LoginReminder to query |
void |
setQueryLoginReminder(int x,
boolean exact)
Set the LoginReminder to query. |
void |
setQueryOId(jobmatch.data.ObjectId oid)
Set the OID to query. |
void |
setQueryUsername(String x)
Set the Username to query |
void |
setQueryUsername(String x,
boolean exact)
Set the Username to query. |
Constructor Detail |
public CandidateAccountQuery()
Method Detail |
public void hitDatabase()
public CandidateAccountDO[] getDOArray() throws jobmatch.data.DataObjectException, jobmatch.data.NonUniqueQueryException
public CandidateAccountDO getNextDO() throws jobmatch.data.DataObjectException, jobmatch.data.NonUniqueQueryException
public CandidateAccountBDO[] getBDOArray() throws jobmatch.data.DataObjectException, jobmatch.data.NonUniqueQueryException
public CandidateAccountBDO getNextBDO() throws jobmatch.data.DataObjectException, jobmatch.data.NonUniqueQueryException
public void setQueryOId(jobmatch.data.ObjectId oid)
CandidateAccount
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(String handle) throws jobmatch.data.ObjectIdException
handle
- The string version of the id to query.public void requireUniqueInstance()
public void reset()
public ResultSet executeQuery(jobmatch.data.DBConnection conn) throws SQLException
conn
- Handle to database connection.public Object next(ResultSet rs) throws SQLException, jobmatch.data.ObjectIdException
rs
- JDBC result set from which the next object
will be instantiated.public void setQueryUsername(String x, boolean exact) throws jobmatch.data.DataObjectException, jobmatch.data.QueryException
x
- The Username of the CandidateAccount to query.exact
- to use matches or notpublic void setQueryUsername(String x) throws jobmatch.data.DataObjectException, jobmatch.data.QueryException
x
- The Username of the CandidateAccount to query.public void addOrderByUsername(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderByUsername()
public void setQueryEmail(String x, boolean exact) throws jobmatch.data.DataObjectException, jobmatch.data.QueryException
x
- The Email of the CandidateAccount to query.exact
- to use matches or notpublic void setQueryEmail(String x) throws jobmatch.data.DataObjectException, jobmatch.data.QueryException
x
- The Email of the CandidateAccount to query.public void addOrderByEmail(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderByEmail()
public void setQueryLastLogin(Timestamp x, boolean exact) throws jobmatch.data.DataObjectException, jobmatch.data.QueryException
x
- The LastLogin of the CandidateAccount to query.exact
- to use matches or notpublic void setQueryLastLogin(Timestamp x) throws jobmatch.data.DataObjectException, jobmatch.data.QueryException
x
- The LastLogin of the CandidateAccount to query.public void addOrderByLastLogin(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderByLastLogin()
public void setQueryLoginReminder(int x, boolean exact) throws jobmatch.data.DataObjectException, jobmatch.data.QueryException
x
- The LoginReminder of the CandidateAccount to query.exact
- to use matches or notpublic void setQueryLoginReminder(int x) throws jobmatch.data.DataObjectException, jobmatch.data.QueryException
x
- The LoginReminder of the CandidateAccount to query.public void addOrderByLoginReminder(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderByLoginReminder()
public void setQueryCandidate(CandidateDO x, boolean exact) throws jobmatch.data.DataObjectException, jobmatch.data.QueryException
x
- The Candidate of the CandidateAccount to query.exact
- to use matches or notpublic void setQueryCandidate(CandidateDO x) throws jobmatch.data.DataObjectException, jobmatch.data.QueryException
x
- The Candidate of the CandidateAccount to query.public void addOrderByCandidate(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderByCandidate()
public jobmatch.data.QueryBuilder getQueryBuilder()
QueryBuilder
that this CandidateAccountQuery
uses to construct and execute database queries.
CandidateAccountQuery.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 CandidateAccountQuery
, the application developer
does not call getQueryBuilder
,
then CandidateAccountQuery.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 CandidateAccountQuery
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" );
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();
public void closeParen()
WHERE
clause.openParen
|
PSE 2000 Group 4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |