|Home >> All >> org >> objectstyle >> [ cayenne Javadoc ]|
Page 1 2
org.objectstyle.cayenne: Javadoc index of package org.objectstyle.cayenne.
org.objectstyle.cayenne.map.event: Contains O/R mapping classes that store relational database metadata information and map it to Java classes.
org.objectstyle.cayenne.dba.sybase: Provides default implementation of DbAdapter architecture.
org.objectstyle.cayenne.dba.db2: Provides default implementation of DbAdapter architecture.
org.objectstyle.cayenne.access.util: Contains core Cayenne container classes.
org.objectstyle.cayenne.access.event: Contains core Cayenne container classes.
org.objectstyle.cayenne.event: Core Cayenne classes and interfaces.
ContainerPoolFactory: Basic JNDI object factory that creates an instance of PoolManager that has been configured based on the RefAddr values of the specified Reference . Here is a sample Tomcat 4.0.x configuration that sets this class as a default factory for javax.sql.DataSource objects: <ResourceParams name="jdbc/mydb"> <parameter> <name>factory</name> <value>org.objectstyle.cayenne.conn.ContainerPoolFactory</value> </parameter> <parameter> <name>username</name> <value>andrei</value> </parameter> <parameter> <name>password</name> <value>bla-bla</value> ...
ServletConfiguration: ServletConfiguration is a Configuration that uses ServletContext to locate resources. This class can only be used in a context of a servlet/jsp container. It resolves configuration file paths relative to the web application "WEB-INF" directory. It performs the following tasks: Loads Cayenne configuration when the application is started within container. Assigns new DataContext to every new session created within the application. ServletConfiguration must be configured in web.xml deployment descriptor as a listener of context and session events: <listener> <listener-class>org.objectstyle.cayenne.conf.ServletConfiguration</listener-class> ...
WebApplicationListener: WebApplicationListener utilizes Servlet specification 2.3 features to react on webapplication container events inializing Cayenne. It performs the following tasks: Loads Cayenne configuration when the application is started within container. Assigns new DataContext to every new session created within the application. CayenneWebappListener must be configured in web.xml deployment descriptor as a listener of context and session events: <listener> <listener-class>org.objectstyle.cayenne.conf.WebApplicationListener</listener-class> </listener> Note that to set WebApplicationListener ...
AbstractHandler: The common superclass for all SAX event handlers used to parse the configuration file. Each method just throws an exception, so subclasses should override what they can handle. Each type of XML element (map, node, etc.) has a specific subclass. In the constructor, this class takes over the handling of SAX events from the parent handler and returns control back to the parent in the endElement method. The idea to use nested handlers for XML document parsing (and code to implement it) were taken from org.apache.tools.ant.ProjectHelper from Jakarta-Ant project (Copyright: Apache Software Foundation). ...
ChooseDbRelationshipDialog: Used to select the DbRelationship for ObjRelationship mapping. Allows selecting the relationship, canceling, edit the relationship and create new relationship. It is needed for the cases when there is more than one DbRelationship between start and end entities, like in the case when the DbRelationship starts and ends in the same DbEntity. The choice is returned in getChoice() method. If choice is SELECT or EDIT, the selected DbRelationship may be retrieved by getDbRelationship(), which will return the list with one DbRelationship. List is used for the future expansion, when one ObjRelaitonship ...
Configuration: This class is an entry point to Cayenne. It loads all configuration files and instantiates main Cayenne objects. Used as a singleton via the getSharedConfiguration() 55 method. To use a custom subclass of Configuration, Java applications must call initializeSharedConfiguration() 55 with the subclass as argument. This will create and initialize a Configuration singleton instance of the specified class. By default DefaultConfiguration is instantiated.
DataPort: Engine to port data between two DataNodes. These nodes can potentially connect to databases from different vendors. The only assumption is that all of the DbEntities (tables) being ported are present in both source and destination databases, and are adequately described by Cayenne mapping. DataPort implements a Cayenne-based algorithm to read data from one data node and write to another. It uses DataPortDelegate interface to decouple porting logic from such things like filtering entities (include/exclude from port based on some criteria), logging the progress of port operation, qualifying the queries, ...
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.
OracleQualifierTranslator: Sequence-based primary key generator implementation for Oracle. Uses Oracle sequences to generate primary key values. This approach is at least 50% faster when tested with Oracle compared to the lookup table approach. When using Cayenne key caching mechanism, make sure that sequences in the database have "INCREMENT BY" greater or equal to OraclePkGenerator "pkCacheSize" property value. If this is not the case, you will need to adjust PkGenerator value accordingly. For example when sequence is incremented by 1 each time, use the following code: dataNode.getAdapter().getPkGenerator().setPkCacheS ...
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.
OraclePkGenerator: Sequence-based primary key generator implementation for Oracle. Uses Oracle sequences to generate primary key values. This approach is at least 50% faster when tested with Oracle compared to the lookup table approach. When using Cayenne key caching mechanism, make sure that sequences in the database have "INCREMENT BY" greater or equal to OraclePkGenerator "pkCacheSize" property value. If this is not the case, you will need to adjust PkGenerator value accordingly. For example when sequence is incremented by 1 each time, use the following code: dataNode.getAdapter().getPkGenerator().setPkCacheS ...
ObjRelationship: Metadata for the navigational association between the data objects. For example, if class "Employee" you may need to get to the department entity by calling "employee.getDepartment()". In this case you navigate from data object class Employee to Department. In this case Employee is source and Department is target. The navigation from Department to the list of employees would be expressed by another instance of ObjRelationship. ObjRelationship class also stores the navigation information in terms of the database entity relationships. The ObjRelationship objects are stored in the ObjEntities.
NamedObjectFactory: Factory class that generates various Cayenne objects with default names that are unique in their corresponding context. Supports creation of the following objects: DataMap ObjEntity ObjAttribute ObjRelationship DbEntity DerivedDbEntity DbAttribute DerivedDbAttribute DbRelationship DataNode DataDomain Procedure ProcedureParameter This is a helper class used mostly by GUI and database reengineering classes.
PersistenceState: Defines a set of persistence states for DataObjects. PersistenceState describes the state of data stored in a DataObject relative to the external persistence store. If an object's state matches the state of the persistence store, the object is COMMITTED. If object is not intended to be persistent or is not explicitly made persistent, the state is TRANSIENT, and so on. DataObject persistence states should not be modified directly. Rather it is a responsibility of a DataContext to maintain correct state of the objects that it manages.
FirebirdAdapter: DbAdapter implementation for Firebird RDBMS . Sample connection settings to use with Firebird are shown below: test-firebird.cayenne.adapter = org.objectstyle.cayenne.dba.firebird.FirebirdAdapter test-firebird.jdbc.username = sysdba test-firebird.jdbc.password = masterkey test-firebird.jdbc.url = jdbc:firebirdsql:[host[/port]/] test-firebird.jdbc.driver = org.firebirdsql.jdbc.FBDriver
PostgresAdapter: DbAdapter implementation for PostgreSQL RDBMS . Sample connection settings to use with PostgreSQL are shown below: test-postgresql.cayenne.adapter = org.objectstyle.cayenne.dba.postgres.PostgresAdapter test-postgresql.jdbc.username = test test-postgresql.jdbc.password = secret test-postgresql.jdbc.url = jdbc:postgresql://serverhostname/cayenne test-postgresql.jdbc.driver = org.postgresql.Driver
DerivedDbAttribute: A DerivedDbAttribute is a DbAttribute that resolves to an SQL expression based on a set of other attributes. DerivedDbAttribute's allow to build expressions like " count(id) ", " sum(price) ", etc. Internally DerivedDbAttribute is defined as a specification string and a set of substitution DbAttribute parameters. Specification string is an SQL expression that contains placeholders ( %@ ) for attribute parameters, for example: sum(%@) + sum(%@)
OracleAdapter: DbAdapter implementation for Oracle RDBMS . Sample connection settings to use with Oracle are shown below: test-oracle.cayenne.adapter = org.objectstyle.cayenne.dba.oracle.OracleAdapter test-oracle.jdbc.username = test test-oracle.jdbc.password = secret test-oracle.jdbc.url = jdbc:oracle:thin:@192.168.0.20:1521:ora1 test-oracle.jdbc.driver = oracle.jdbc.driver.OracleDriver
HSQLDBAdapter: DbAdapter implementation for the HSQLDB RDBMS . Sample connection settings to use with HSQLDB are shown below: test-hsqldb.cayenne.adapter = org.objectstyle.cayenne.dba.hsqldb.HSQLDBAdapter test-hsqldb.jdbc.username = test test-hsqldb.jdbc.password = secret test-hsqldb.jdbc.url = jdbc:hsqldb:hsql://serverhostname test-hsqldb.jdbc.driver = org.hsqldb.jdbcDriver
RequestQueue: RequestQueue implements a FIFO queue for threads waiting for a particular event, resource, etc. Each thread will wait in the queue until either of the following events happen: Thread is already #1 in the queue and an awaited event occurrs. Thread timeout interval expired. Thread was interrupted (this is a quick way to remove thread from the queue). If any of the conditions above ocurrs, thread will be removed from the queue.
MySQLAdapter: DbAdapter implementation for MySQL RDBMS . Sample connection settings to use with MySQL are shown below: test-mysql.cayenne.adapter = org.objectstyle.cayenne.dba.mysql.MySQLAdapter test-mysql.jdbc.username = test test-mysql.jdbc.password = secret test-mysql.jdbc.url = jdbc:mysql://serverhostname/cayenne test-mysql.jdbc.driver = org.gjt.mm.mysql.Driver
DB2Adapter: DbAdapter implementation for the DB2 RDBMS . Sample connection settings to use with DB2 are shown below: test-db2.cayenne.adapter = org.objectstyle.cayenne.dba.db2.DB2Adapter test-db2.jdbc.username = test test-db2.jdbc.password = secret test-db2.jdbc.url = jdbc:db2://servername:50000/databasename test-db2.jdbc.driver = com.ibm.db2.jcc.DB2Driver
BasicServletConfiguration: BasicServletConfiguration is a Configuration that uses ServletContext to locate resources. This class can only be used in a context of a servlet/jsp container. It resolves configuration file paths relative to the web application "WEB-INF" directory. BasicServletConfiguration is compatible with Servlet Specification 2.2 and higher. Also look at ServletConfiguration for the information how to utilize listeners introduced in Servlet Specification 2.3.