oracle.toplink.essentials.queryframework |
|
Java Source File Name | Type | Comment |
Call.java | Interface | Call defines the interface used primarily by TopLink queries
and query mechanisms to perform the necessary actions
(read, insert, update, delete) on the data store.
A Call can collaborate with an Accessor to perform its
responsibilities. |
ColumnResult.java | Class | Purpose:
Concrete class to represent the ColumnResult structure as defined by
the EJB 3.0 Persistence specification. |
ComplexQueryResult.java | Class | Purpose:
Used to return multiple sets of information from a query. |
ConstructorReportItem.java | Class | Purpose: An item specifying a class constructor method to be used in a ReportQuery's returned results. |
DatabaseQuery.java | Class | Purpose:
Abstract class for all database query objects.
DatabaseQuery is a visible class to the TopLink user. |
DataModifyQuery.java | Class | Purpose:
Concrete class used for executing non selecting SQL strings. |
DataReadQuery.java | Class | Purpose:
Concrete class to perform read using raw SQL. |
DeleteAllQuery.java | Class | Purpose:
Query used to delete a collection of objects
Responsibilities:
- Stores & retrieves the objects to delete.
|
DeleteObjectQuery.java | Class | Purpose: Used for deleting objects. |
DirectReadQuery.java | Class | Purpose:
Concrete class to perform a direct read.
Responsibilities:
Used in conjunction with DirectCollectionMapping.
This can be used to read a single column of data (i.e. |
DoesExistQuery.java | Class | Purpose:
This should only be used by the descriptor, this should not be executed directly.
Used to determine if an object resides on the database.
DoesExistQuery is normally used to determine whether to make an update
or insert statement when writing an object.
Responsibilities:
Verify the existence of an object. |
EJBQLCall.java | Class | Purpose: Used as an abstraction of a database invocation. |
EJBQLPlaceHolderQuery.java | Class | |
EntityResult.java | Class | Purpose:
Concrete class to represent the EntityResult structure as defined by
the EJB 3.0 Persistence specification. |
FetchGroup.java | Class | Purpose: A fetch group is a performance enhancement that allows a group of
attributes of an object to be loaded on demand, which means that the data for an attribute
might not loaded from the underlying data source until an explicit access call for the
attribute first occurs. |
FetchGroupTracker.java | Interface | Purpose: The fetch group tracker interface provides a set of APIs which
the domain object must implement, in order to take advantage of the TopLink fetch group
performance enhancement feature. |
FieldResult.java | Class | Purpose:
Concrete class to represent the FieldResult structure as defined by
the EJB 3.0 Persistence specification. |
InMemoryQueryIndirectionPolicy.java | Class | Purpose:
Used to provide the user with a means of contoling the behaviour of in memory queries
that access un-instantiated indirection in the query..
Description:
This class contains a state variable that is used to determine what a query should do
when accesing un-instantiated indirection. |
InsertObjectQuery.java | Class | Purpose:
Used for inserting new objects into the database. |
ModifyAllQuery.java | Class | PUBLIC:
Query used to perform a bulk delete using TopLink's expression framework. |
ModifyQuery.java | Class | Purpose:
Abstract class for all modify queries. |
ObjectBuildingQuery.java | Class | Purpose:
Abstract class for all read queries that build objects and potentially manipulate
the TopLink cache. |
ObjectLevelModifyQuery.java | Class | Purpose:
Abstract class for all object modify queries. |
ObjectLevelReadQuery.java | Class | Purpose:
Abstract class for all read queries using objects. |
ReadAllQuery.java | Class | set
Purpose:
Concrete class for all read queries involving a collection of objects. |
ReadObjectQuery.java | Class | Purpose:
Concrete class for all read queries involving a single object. |
ReadQuery.java | Class | Purpose:
Abstract class for all read queries. |
ReportQuery.java | Class | Purpose: Query for information about a set of objects instead of the objects themselves.
This supports select single attributes, nested attributes, aggregation functions and group bys.
Attribute Types:
- addAttribute("directQueryKey") is a short cut method to add an attribute with the same name as its corresponding direct query key.
- addAttribute("attributeName", expBuilder.get("oneToOneMapping").get("directQueryKey")) is the full approach for get values through joined 1:1 relationships.
- addAttribute("attributeName", expBuilder.getField("TABLE.FIELD")) allows the addition of raw values or values which were not mapped in the object model directly (i.e.
|
ReportQueryResult.java | Class | Purpose: A single row (type) result for a ReportQuery
Description: Represents a single row of attribute values (converted using mapping) for
a ReportQuery. |
ResultSetMappingQuery.java | Class | Purpose:
Concrete class to perform read using raw SQL and the SQLResultSetMapping.
Responsibilities:
Execute a selecting raw SQL string.
Returns a List of results. |
SQLCall.java | Class | Purpose: Used as an abstraction of an SQL call. |
SQLResult.java | Class | |
SQLResultSetMapping.java | Class | Purpose:
Concrete class to represent the SQLResultSetMapping structure as defined by
the EJB 3.0 Persistence specification. |
UpdateAllQuery.java | Class | PUBLIC:
A Query Class used to perform a bulk update using TopLink's expression framework.
This class is provided to help optimize performance. |
UpdateObjectQuery.java | Class | Purpose:
Used for updating existing objects into the database. |
ValueReadQuery.java | Class | Purpose:
Concrete class to perform a read of a single data value.
Responsibilities:
Used in conjunction with CursoredStream size and Platform getSequence.
This can be used to read a single data value (i.e. |
WriteObjectQuery.java | Class | Purpose:
Used for inserting or updating objects
WriteObjectQuery determines whether to perform a insert or an update on the database. |