Home >> All >> org >> objectstyle >> cayenne >> [ access Javadoc ]

•	org.objectstyle.cayenne.access.event.* (3)	•	org.objectstyle.cayenne.access.trans.* (26)
•	org.objectstyle.cayenne.access.types.* (9)	•	org.objectstyle.cayenne.access.util.* (18)

• org.objectstyle.cayenne.access: Javadoc index of package org.objectstyle.cayenne.access.


Package Samples:

• org.objectstyle.cayenne.access.util: Contains core Cayenne container classes.  
• org.objectstyle.cayenne.access.event: Contains core Cayenne container classes.  
• org.objectstyle.cayenne.access.trans
• org.objectstyle.cayenne.access.types

Classes:

• OperationObserver: Defines a set of callback methods for a QueryEngine to notify interested object about different stages of queries execution. Superinterface, OperationHints, defines information methods that are needed to define query execution strategy. This Interface adds callback methods. Implementing objects are passed to a QueryEngine that will execute one or more queries. QueryEngine will pass results of the execution of any kind of queries - selects, updates, store proc. calls, etc.. to the interested objects. This includes result counts, created objects, thrown exceptions, etc. For more information see Cayenne ...
• IncrementalFaultList: A synchronized list that serves as a container of DataObjects. It is returned when a paged query is performed by DataContext. On creation, only the first "page" is fully resolved, for the rest of the objects only their ObjectIds are read. Pages following the first page are resolved on demand only. On access to an element, the list would ensure that this element as well as all its siblings on the same page are fully resolved. Note that this list would only allow addition of DataObjects. Attempts to add any other object types will result in an exception. Performance note: certain operations like ...
• QueryLogger: A QueryLogger is intended to log special events during query executions. This includes generated SQL statements, result counts, connection events etc. It is a single consistent place for that kind of logging and should be used by all Cayenne classes that work with the database directly. In many cases it is important to use this class as opposed to logging from the class that performs a particular operation, since QueryLogger will generate consistently formatted logs that are easy to analyze and turn on/off. For more information see Cayenne User Guide.
• SelectObserver: OperationObserver that accumulates select query results provided by callback methods. Later the results can be retrieved via different getResults methods. This class can serve as a helper for classes that work with DataNode directly, bypassing DataContext. Also it is used by DataContext to implement "data rows" functionality - retrieving data without instantiating and registering DataObjects. If exceptions happen during the execution, they are immediately rethrown. For more information see Cayenne User Guide.
• ResultIterator: Defines API of an iterator over the records returned as a result of SelectQuery execution. Usually a ResultIterator is supported by an open java.sql.ResultSet, therefore most of the methods would throw checked exceptions. ResultIterators must be explicitly closed when the user is done working with them. For more information see Cayenne User Guide.
• DataDomain: DataDomain performs query routing functions in Cayenne. DataDomain creates single data source abstraction hiding multiple physical data sources from the user. When a child DataContext sends a query to the DataDomain, it is transparently routed to an appropriate DataNode. For more information see Cayenne User Guide.
• ContextCommit: ContextCommit implements commit logic. It is used internally by DataContext as a commit delegate. Currently ContextCommit resolves primary key dependencies, referential integrity dependencies including multi-reflexive entities, generates primary keys, creates batches for massive data modifications, assigns operations to data nodes. It indirectly relies on graph algorithms provided by ASHWOOD.
• DataObjectTransactionEventListener: This interface declares methods that DataObject classes can implement to be notified about transactions of their DataContext. Note: explicit registration with EventManager is not necessary, since the events are simply forwarded by ContextCommitObserver; stricly speaking these methods are just regular 'callbacks'. The event argument is passed along for convenience.
• SnapshotManager: SnapshotManager handles snapshot (data row) operations on objects. This is a helper class that works in conjunction with DataContext. TODO: SnapshotManager is really stateless. All its state information (including relDataSource) does not span mthod calls and is really beloning to the DataContext, so switching to a singleton instance should be easy.
• DefaultOperationObserver: Simple implementation of OperationObserver interface. Useful as a superclass of other implementations of OperationObserver. This implementation only tracks transaction events and exceptions. Also it performs basic logging. For more information see Cayenne User Guide.
• DataContext: User-level Cayenne access class. Provides isolated object view of the datasource to the application code. Normal use pattern is to create one DataContext per session (whatever session may mean in a given application). For more information see Cayenne User Guide.
• DataNode: Describes a single physical data source. This can be a database server, LDAP server, etc. When the underlying connection layer is based on JDBC, DataNode works as a Cayenne wrapper of javax.sql.DataSource. For more information see Cayenne User Guide.
• RelationshipFault: This class represents a placeholder for an unresolved relationship from a source object. RelationshipFault is used in cases when it is impossible to create a HOLLOW object using the information from the relationship source object. These cases include dependent to-one relationships and flattened to-one relationships.
• ToManyList: Special List implementation to hold "to many" relationship data. To retain guaranteed immutable reference to the list, application might use "List.toArray()" method. For more information see Cayenne User Guide.
• OperationSorter: Class provides a set of sorting utilities for Cayenne. For instance it supports sorting of database operations to satisfy database referential integrity consraints. For more information see Cayenne User Guide.
• ShortType: Addresses bugs in certain JDBC drivers that do not handle java.lang.Short properly. Recasts java.lang.Short to java.lang.Integer when binding values to PreparedStatement. Drivers that are proven to have issues with short values are Sybase and Oracle (Mac OS X only).
• ByteType: Addresses bugs in certain JDBC drivers that do not handle java.lang.Byte properly. Recasts java.lang.Byte to java.lang.Integer when binding values to PreparedStatement. Drivers that are proven to have issues with short values are Sybase and Oracle (Mac OS X only).
• DefaultResultIterator: Default implementation of ResultIterator interface. Serves as a factory that creates data rows from java.sql.ResultSet . For more information see Cayenne User Guide.
• DefaultOperationObserver: Simple implementation of OperationObserver interface. Useful as a superclass of other implementations of OperationObserver. For more information see Cayenne User Guide.
• InsertTranslator: Class implements default translation mechanism of org.objectstyle.cayenne.query.InsertQuery objects to SQL INSERT statements. Note that in order for this query to execute successfully, ObjectId contained within InsertQuery must be fully initialized.
• PrimaryKeyHelper: PrimaryKeyHelper resolves primary key dependencies for entities related to the supported query engine via topological sorting. It is directly based on ASHWOOD. In addition it provides means for primary key generation relying on DbAdapter in this.
• DefaultSorter: DefaultSorter is a default implementation of DependencySorter based on ASHWOOD library. Presently it works for acyclic database schemas with possible multi-reflexive tables. The class uses topological sorting from ASHWOOD.
• ExtendedTypeMap: Contains a map of ExtendedType objects, that serve as handlers for converting values between Java application and JDBC layer. Class uses singleton model, since mapping is usually shared within the application.
• EntityResolver: EntityResolver encapsulates resolving between ObjEntities, DbEntities, DataObject Classes, and Entity names. An instance is typically obtained from a QueryEngine by getEntityResolver. EntityResolver is thread-safe.
• QueryTranslator: Defines API for translation Cayenne queries to JDBC PreparedStatements. For more information see Cayenne User Guide.

Home | Contact Us | Privacy Policy | Terms of Service