EclipseLink 2.1.2, build 'v20101206-r8635' API Reference

Package org.eclipse.persistence.queries

Interface Summary
Call Call defines the interface used primarily by EclipseLink queries and query mechanisms to perform the necessary actions (read, insert, update, delete) on the data store.
FetchGroupTracker Purpose: The fetch group tracker interface provides a set of APIs which the domain object must implement, in order to take advantage of the EclipseLink fetch group performance enhancement feature.
QueryRedirector Purpose: Query redirection allows for a named or parameterized query (or finder) to dynamically determine how the query is to be executed based on the arguments.
 

Class Summary
AttributeGroup Purpose: An AttributeGroup represents a set of mappings and nested AttributeGroups for relationship mappings for an entity type.
BatchFetchPolicy BatchFetchPolicy defines batch reading configuration.
ColumnResult Purpose: Concrete class to represent the ColumnResult structure as defined by the EJB 3.0 Persistence specification.
ComplexQueryResult Purpose: Used to return multiple sets of information from a query.
ConstructorReportItem Purpose: An item specifying a class constructor method to be used in a ReportQuery's returned results.
Cursor Purpose: Abstract class for CursoredStream and ScrolableCursor
CursoredStream Purpose: Stream class which is used to deal with large collections returned from TOPLink queries more efficiently.
CursoredStreamPolicy Purpose: Used to support cursored streams in a read query.
CursorPolicy Purpose: Abstract class for all Cursor-related policy objects
DatabaseQuery Purpose: Abstract class for all database query objects.
DataModifyQuery Purpose: Concrete class used for executing non selecting SQL strings.
DataReadQuery Purpose: Concrete class to perform read using raw SQL.
DeleteAllQuery Purpose: Query used to delete a collection of objects Responsibilities: Stores & retrieves the objects to delete.
DeleteObjectQuery Purpose: Used for deleting objects.
DirectReadQuery Purpose: Concrete class to perform a direct read.
DoesExistQuery Purpose: This should only be used by the descriptor, this should not be executed directly.
EntityResult Purpose: Concrete class to represent the EntityResult structure as defined by the EJB 3.0 Persistence specification.
FetchGroup A FetchGroup 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.
FieldResult Purpose: Concrete class to represent the FieldResult structure as defined by the EJB 3.0 Persistence specification.
InMemoryQueryIndirectionPolicy Purpose: Provide a means of controlling the behavior of in-memory and conforming queries that access un-instantiated indirection objects in processing the query against cached objects.
InsertObjectQuery Purpose: Used for inserting new objects into the database.
JPQLCall Purpose: Used as an abstraction of a database invocation.
LoadGroup Purpose: Used to load specified relationship attributes and nested relationship attributes.
MethodBaseQueryRedirector Purpose: Allows a class to be a QueryRedirector without implementing QueryRedirector.
ModifyAllQuery PUBLIC: Query used to perform a bulk delete using TopLink's expression framework.
ModifyQuery Purpose: Abstract class for all modify queries.
ObjectBuildingQuery Purpose: Abstract class for all read queries that build objects and potentially manipulate the TopLink cache.
ObjectLevelModifyQuery Purpose: Abstract class for all object modify queries.
ObjectLevelReadQuery Purpose: Abstract class for all read queries using objects.
QueryByExamplePolicy Purpose: This policy defines the configuration options for a Query By Example query.
QueryRedirectorHelper Purpose: The purpose of this class is to provide the query redirector with some helper methods for general EclipseLink operations (such as checking a query against the cache) which may not occur because the query is being redirected.
QueryResultsCachePolicy PUBLIC: A QueryResultsCache policy dictates how a query's results will be cached.
ReadAllQuery Purpose: Concrete class for all read queries involving a collection of objects.
ReadObjectQuery Purpose: Concrete class for all read queries involving a single object.
ReadQuery Purpose: Abstract class for all read queries.
ReportQuery Purpose: Query for information about a set of objects instead of the objects themselves.
ReportQueryResult Purpose: A single row (type) result for a ReportQuery Description: Represents a single row of attribute values (converted using mapping) for a ReportQuery.
ReportQueryResult.RecordEntry Entry class for implementing Map interface.
ResultSetMappingQuery Purpose: Concrete class to perform read using raw SQL and the SQLResultSetMapping.
ScrollableCursor  
ScrollableCursorPolicy PUBLIC: ScrollableCursorPolicy allows for additional options to be specified for ReadAllQuery or DataReadQuery.
SQLCall Purpose: Used as an abstraction of an SQL call.
SQLResult Purpose: An abstract superclass that represents the commonalities between the main result types of the SQLResultSetMapping
SQLResultSetMapping Purpose: Concrete class to represent the SQLResultSetMapping structure as defined by the EJB 3.0 Persistence specification.
StoredFunctionCall Purpose: Used to define a platform independent function call.
StoredProcedureCall Purpose: Used to define a platform independent procedure call.
UpdateAllQuery PUBLIC: A Query Class used to perform a bulk update using TopLink's expression framework.
UpdateObjectQuery Purpose: Used for updating existing objects into the database.
ValueReadQuery Purpose: Concrete class to perform a read of a single data value.
WriteObjectQuery Purpose: Used for inserting or updating objects WriteObjectQuery determines whether to perform a insert or an update on the database.
 


EclipseLink 2.1.2, build 'v20101206-r8635' API Reference