Main Page | Packages | Class Hierarchy | Class List | Directories | File List | Class Members | Related Pages

org.odbms.Query Interface Reference

Inheritance diagram for org.odbms.Query:

org.openmobileis.database.fastobjectdb.db.query.soda.FODBSodaQuery List of all members.

Detailed Description

handle to a node in the query graph.



A node in the query graph can represent multiple classes, one class or an attribute of a class.

The graph is automatically extended with attributes of added constraints (see constrain()) and upon calls to (java.lang.String) descend() that request nodes that do not yet exist.

References to joined nodes in the query graph kann be obtained by "walking" along the nodes of the graph with the method {(java.lang.String) descend().

execute() evaluates the entire graph against all persistent objects.

execute() can be called from any Query node of the graph. It will return an ObjectSet filled with objects of the class/classes that the node, it was called from, represents.

Definition at line 31 of file Query.java.

Public Member Functions

Constraint constrain (Object constraint)
 adds a constraint to this node.
Constraints constraints ()
 returns a Constraints object that holds an array of all constraints on this node.
ObjectSet execute ()
 executes the Query.
Query descend (String fieldName)
 returns a reference to a descendant node in the query graph.
Query orderAscending ()
 adds an ascending ordering criteria to this node of the query graph.
Query orderDescending ()
 adds a descending order criteria to this node of the query graph.


Member Function Documentation

Constraint org.odbms.Query.constrain Object  constraint  ) 
 

adds a constraint to this node.



If the constraint contains attributes that are not yet present in the query graph, the query graph is extended accordingly.

Special behaviour for:

  • class : confine the result to objects of one class (if the Class object represents a class) or to objects implementing a specific interface (if the Class object represents an interface).
  • interface Evaluation: run evaluation callbacks against all candidates.
Parameters:
constraint the constraint to be added to this Query.
Returns:
Constraint a new Constraint for this query node or null for objects implementing the Evaluation interface.

Implemented in org.openmobileis.database.fastobjectdb.db.query.soda.FODBSodaQuery.

Referenced by org.openmobileis.synchro.journal.JournalQueryManager.createOrUpdate(), org.openmobileis.database.fastobjectdb.synchro.client.FODBSyncActionDBQueryManager.getActionDB(), org.openmobileis.database.fastobjectdb.synchro.client.FODBSyncActionDBQueryManager.getActionsForService(), org.openmobileis.database.fastobjectdb.db.test.TestFODBSyncTarget.getAllCollectionObject(), org.openmobileis.synchro.journal.JournalQueryManager.getAllEntryForService(), org.openmobileis.modules.crm.database.common.fodb.FODBRepresentantFactory.getAllRepresentants(), org.openmobileis.database.fastobjectdb.db.test.TestFODBSyncTarget.getCollectionObjectWithId(), org.openmobileis.modules.crm.database.common.fodb.FODBLabelFactory.getLabelListForCategorie(), org.openmobileis.modules.crm.database.common.fodb.FODBLabelFactory.getLabelWithIds(), org.openmobileis.database.fastobjectdb.synchro.client.SynchroFastObjectDB.getObjectFromCollectionWithId(), org.openmobileis.modules.crm.database.common.fodb.FODBRepresentantFactory.getRepresentant(), org.openmobileis.database.fastobjectdb.db.test.TestThreadRequest2.run(), org.openmobileis.database.fastobjectdb.db.test.TestThreadRequest.run(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testDataWithArray(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testDBSearch(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testFindLike(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testMultipleIndex(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testRomvedTree(), and org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testTree().

Constraints org.odbms.Query.constraints  ) 
 

returns a Constraints object that holds an array of all constraints on this node.

Returns:
Constraints on this query node.

Implemented in org.openmobileis.database.fastobjectdb.db.query.soda.FODBSodaQuery.

Query org.odbms.Query.descend String  fieldName  ) 
 

returns a reference to a descendant node in the query graph.



If the node does not exist, it will be created.

All classes represented in the query node are tested, whether they contain a field with the specified field name. The descendant Query node will be created from all possible candidate classes.

Parameters:
field path to the descendant.
Returns:
descendant Query node

Implemented in org.openmobileis.database.fastobjectdb.db.query.soda.FODBSodaQuery.

Referenced by org.openmobileis.synchro.journal.JournalQueryManager.createOrUpdate(), org.openmobileis.database.fastobjectdb.synchro.client.FODBSyncActionDBQueryManager.getActionDB(), org.openmobileis.database.fastobjectdb.synchro.client.FODBSyncActionDBQueryManager.getActionsForService(), org.openmobileis.database.fastobjectdb.db.test.TestFODBSyncTarget.getAllCollectionObject(), org.openmobileis.synchro.journal.JournalQueryManager.getAllEntryForService(), org.openmobileis.modules.crm.database.common.fodb.FODBRepresentantFactory.getAllRepresentants(), org.openmobileis.database.fastobjectdb.db.test.TestFODBSyncTarget.getCollectionObjectWithId(), org.openmobileis.modules.crm.database.common.fodb.FODBLabelFactory.getLabelListForCategorie(), org.openmobileis.modules.crm.database.common.fodb.FODBLabelFactory.getLabelWithIds(), org.openmobileis.database.fastobjectdb.synchro.client.SynchroFastObjectDB.getObjectFromCollectionWithId(), org.openmobileis.modules.crm.database.common.fodb.FODBRepresentantFactory.getRepresentant(), org.openmobileis.database.fastobjectdb.db.test.TestThreadRequest2.run(), org.openmobileis.database.fastobjectdb.db.test.TestThreadRequest.run(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testDataWithArray(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testDBSearch(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testFindLike(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testMultipleIndex(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testRomvedTree(), and org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testTree().

ObjectSet org.odbms.Query.execute  ) 
 

executes the Query.

Returns:
ObjectSet - the result of the Query.

Implemented in org.openmobileis.database.fastobjectdb.db.query.soda.FODBSodaQuery.

Referenced by org.openmobileis.synchro.journal.JournalQueryManager.createOrUpdate(), org.openmobileis.database.fastobjectdb.synchro.client.FODBSyncActionDBQueryManager.getActionDB(), org.openmobileis.database.fastobjectdb.synchro.client.FODBSyncActionDBQueryManager.getActionsForService(), org.openmobileis.database.fastobjectdb.db.test.TestFODBSyncTarget.getAllCollectionObject(), org.openmobileis.synchro.journal.JournalQueryManager.getAllEntryForService(), org.openmobileis.modules.crm.database.common.fodb.FODBRepresentantFactory.getAllRepresentants(), org.openmobileis.database.fastobjectdb.db.test.TestFODBSyncTarget.getCollectionObjectWithId(), org.openmobileis.modules.crm.database.common.fodb.FODBLabelFactory.getLabelListForCategorie(), org.openmobileis.modules.crm.database.common.fodb.FODBLabelFactory.getLabelWithIds(), org.openmobileis.database.fastobjectdb.synchro.client.SynchroFastObjectDB.getObjectFromCollectionWithId(), org.openmobileis.modules.crm.database.common.fodb.FODBRepresentantFactory.getRepresentant(), org.openmobileis.database.fastobjectdb.db.test.TestThreadRequest2.run(), org.openmobileis.database.fastobjectdb.db.test.TestThreadRequest.run(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testDataWithArray(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testDBSearch(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testFindLike(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testMultipleIndex(), org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testRomvedTree(), and org.openmobileis.database.fastobjectdb.db.test.TestFastObjectDB.testTree().

Query org.odbms.Query.orderAscending  ) 
 

adds an ascending ordering criteria to this node of the query graph.

Multiple ordering criteria will be applied in the order they were called.

Returns:
this Query object to allow the chaining of method calls.

Implemented in org.openmobileis.database.fastobjectdb.db.query.soda.FODBSodaQuery.

Query org.odbms.Query.orderDescending  ) 
 

adds a descending order criteria to this node of the query graph.

Multiple ordering criteria will be applied in the order they were called.

Returns:
this Query object to allow the chaining of method calls.

Implemented in org.openmobileis.database.fastobjectdb.db.query.soda.FODBSodaQuery.


The documentation for this interface was generated from the following file:
Generated on Wed Dec 14 21:05:37 2005 for OpenMobileIS by  doxygen 1.4.4