diff --git a/openjpa-project/src/doc/manual/jpa_overview_arch.xml b/openjpa-project/src/doc/manual/jpa_overview_arch.xml index ec10f1947..42bca9dab 100644 --- a/openjpa-project/src/doc/manual/jpa_overview_arch.xml +++ b/openjpa-project/src/doc/manual/jpa_overview_arch.xml @@ -305,7 +305,7 @@ additional details on JPA exceptions. All exceptions thrown by OpenJPA implement - + org.apache.openjpa.util.ExceptionInfo to provide you with additional error information. diff --git a/openjpa-project/src/doc/manual/jpa_overview_em.xml b/openjpa-project/src/doc/manual/jpa_overview_em.xml index 3b7a44c03..1fd8191b7 100644 --- a/openjpa-project/src/doc/manual/jpa_overview_em.xml +++ b/openjpa-project/src/doc/manual/jpa_overview_em.xml @@ -45,7 +45,7 @@ an ellipsis (...) are overloaded to take multiple parameter types. OpenJPA extends the standard EntityManager interface with the - + org.apache.openjpa.persistence.OpenJPAEntityManager interface to provide additional functionality. diff --git a/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml b/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml index beaf26e15..79f5be0c9 100644 --- a/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml +++ b/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml @@ -41,7 +41,7 @@ EntityManager instances for application use. OpenJPA extends the standard EntityManagerFactory interface with the - + OpenJPAEntityManagerFactory to provide additional functionality. @@ -162,7 +162,7 @@ createEntityManager: openjpa.<property>, where <property> is any JavaBean property of the - + org.apache.openjpa.persistence.OpenJPAEntityManager. diff --git a/openjpa-project/src/doc/manual/jpa_overview_meta.xml b/openjpa-project/src/doc/manual/jpa_overview_meta.xml index 54fdce7a6..a93701dc9 100644 --- a/openjpa-project/src/doc/manual/jpa_overview_meta.xml +++ b/openjpa-project/src/doc/manual/jpa_overview_meta.xml @@ -1037,7 +1037,7 @@ http://www.ics.uci.edu/~ejw/authoring/uuid-guid/ These string constants are defined in - + org.apache.openjpa.persistence.Generator. diff --git a/openjpa-project/src/doc/manual/jpa_overview_persistence.xml b/openjpa-project/src/doc/manual/jpa_overview_persistence.xml index 105d2cbed..001ea499f 100644 --- a/openjpa-project/src/doc/manual/jpa_overview_persistence.xml +++ b/openjpa-project/src/doc/manual/jpa_overview_persistence.xml @@ -59,7 +59,7 @@ OpenJPA also includes the - + OpenJPAPersistence helper class to provide additional utility methods. diff --git a/openjpa-project/src/doc/manual/jpa_resources.xml b/openjpa-project/src/doc/manual/jpa_resources.xml index 2eb8a6dec..074bfcafa 100644 --- a/openjpa-project/src/doc/manual/jpa_resources.xml +++ b/openjpa-project/src/doc/manual/jpa_resources.xml @@ -41,7 +41,7 @@ javax.persistence Javadoc -OpenJPA Javadoc +OpenJPA Javadoc diff --git a/openjpa-project/src/doc/manual/migration_considerations.xml b/openjpa-project/src/doc/manual/migration_considerations.xml index ce523ab38..1d8fbcb71 100644 --- a/openjpa-project/src/doc/manual/migration_considerations.xml +++ b/openjpa-project/src/doc/manual/migration_considerations.xml @@ -110,7 +110,7 @@ In addition, a new method has been provided on the - + OpenJPAEntityManager interface to return a copy of the entity: @@ -399,7 +399,7 @@ Additionally, if the CACHE clause has to be emitted in sequence definition, this can be accomplished by overriding the - + DBDictionary.getCreateSequenceSQL method. diff --git a/openjpa-project/src/doc/manual/ref_guide_caching.xml b/openjpa-project/src/doc/manual/ref_guide_caching.xml index e8263fc20..756364bba 100644 --- a/openjpa-project/src/doc/manual/ref_guide_caching.xml +++ b/openjpa-project/src/doc/manual/ref_guide_caching.xml @@ -282,7 +282,7 @@ public class Employee { -See the +See the org.apache.openjpa.persistence.DataCache Javadoc for more information on the DataCache annotation. @@ -472,7 +472,7 @@ is defaulted to concurrent though explicitly mentioned in thi The org.apache.openjpa.datacache package defines OpenJPA's data caching framework. While you may use this framework directly (see its - + Javadoc for details), its APIs are meant primarily for service providers. In fact, below has tips on how to use this package to extend OpenJPA's caching service yourself. @@ -482,7 +482,7 @@ Rather than use the low-level org.apache.openjpa.datacache package APIs, JPA users should typically access the data cache through the JPA standard javax.persistence.Cache interface, or OpenJPA's high-level - + org.apache.openjpa.persistence.StoreCache facade. @@ -605,7 +605,7 @@ cache.evict(Magazine.class, changedMag.getId()); See the StoreCache - + Javadoc for information on additional functionality it provides. Also, discusses OpenJPA's other extensions to the standard set of JPA runtime interfaces. @@ -652,7 +652,7 @@ oem.evict(changedMag); // will evict from data cache also Number of requests to read and write requests and hit ratio of the data cache is available via - + org.apache.openjpa.datacache.CacheStatistics interface. The collection of cache statistics is disabled by default and needs to be enabled on a per cache basis. By default all counts returned from the CacheStatistics interface will return 0. @@ -750,7 +750,7 @@ execution time is fully traversed. OpenJPA exposes a high-level interface to the query cache through the - + org.apache.openjpa.persistence.QueryResultCache class. You can access this class through the OpenJPAEntityManagerFactory. @@ -1187,7 +1187,7 @@ their parsed form. This property accepts the following aliases: The default option. Uses a - + CacheMap to store compilation data. CacheMap maintains a fixed number of cache entries, and an optional soft reference map for entries that are moved out of the LRU space. @@ -1251,7 +1251,7 @@ optionally collected as <property name="openjpa.jdbc.QuerySQLCache" value="true(EnableStatistics=true)"> -The +The QueryStatistics can be accessed via PreparedQueryCache.getStatistics(). @@ -1280,7 +1280,7 @@ The The default option. Uses a - + CacheMap to store SQL string. CacheMap maintains a fixed number of cache entries, and an optional soft reference map for entries that are moved out of the LRU space. diff --git a/openjpa-project/src/doc/manual/ref_guide_conf.xml b/openjpa-project/src/doc/manual/ref_guide_conf.xml index 98aa1413d..0dcb8e92f 100644 --- a/openjpa-project/src/doc/manual/ref_guide_conf.xml +++ b/openjpa-project/src/doc/manual/ref_guide_conf.xml @@ -131,14 +131,14 @@ configuration resource to use, and to override any property. Internally, the OpenJPA runtime environment and development tools manipulate property settings through a general - + Configuration interface, and in particular its - + OpenJPAConfiguration and - + JDBCConfiguration subclasses. For advanced customization, OpenJPA's extended runtime interfaces and its development tools -allow you to access these interfaces directly. See the +allow you to access these interfaces directly. See the Javadoc for details. @@ -463,7 +463,7 @@ openjpa.AggregateListeners Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getAggregateListeners @@ -477,7 +477,7 @@ AggregateListeners Description: A comma-separated list of plugin strings (see ) describing custom - + org.apache.openjpa.jdbc.kernel.exps.JDBCAggregateListener s to make available to all queries, in addition to the standard set of listeners. See @@ -511,7 +511,7 @@ standard set of listeners. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getAutoClear @@ -558,7 +558,7 @@ transaction. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getAutoDetach @@ -604,7 +604,7 @@ managed objects after the transaction and/or the context ends e.g. typical batch Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getBrokerFactory @@ -622,7 +622,7 @@ BrokerFactory Description: A plugin string (see ) describing the - + org.apache.openjpa.kernel.BrokerFactory type to use. @@ -650,7 +650,7 @@ use. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getBrokerImpl @@ -664,7 +664,7 @@ BrokerImpl Description: A plugin string (see ) describing the - + org.apache.openjpa.kernel.Broker type to use at runtime. See on for details. @@ -684,7 +684,7 @@ org.apache.openjpa.kernel.Broker type to use at runtime. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getCallbackOptionsInstance @@ -739,7 +739,7 @@ properties related to callbacks. The plug-in supports two boolean properties: Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getClassResolver @@ -753,7 +753,7 @@ ClassResolver Description: A plugin string (see ) describing the - + org.apache.openjpa.util.ClassResolver implementation to use for class name resolution. You may wish to plug in your own resolver if you have special classloading needs. @@ -779,7 +779,7 @@ special classloading needs. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getCompatibility @@ -818,7 +818,7 @@ openjpa.ConnectionDriverName Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionDriverName @@ -860,7 +860,7 @@ openjpa.Connection2DriverName Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2DriverName @@ -903,7 +903,7 @@ openjpa.ConnectionFactory Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory @@ -943,7 +943,7 @@ openjpa.ConnectionFactory2 Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory2 @@ -983,7 +983,7 @@ openjpa.ConnectionFactoryName Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactoryName @@ -1024,7 +1024,7 @@ openjpa.ConnectionFactory2Name Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory2Name @@ -1065,7 +1065,7 @@ openjpa.ConnectionFactoryMode Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactoryMode @@ -1110,7 +1110,7 @@ openjpa.ConnectionFactoryProperties Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactoryProperties @@ -1152,7 +1152,7 @@ openjpa.ConnectionFactory2Properties Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory2Properties @@ -1195,7 +1195,7 @@ openjpa.ConnectionPassword Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionPassword @@ -1235,7 +1235,7 @@ openjpa.Connection2Password Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2Password @@ -1277,7 +1277,7 @@ openjpa.ConnectionProperties Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionProperties @@ -1319,7 +1319,7 @@ openjpa.Connection2Properties Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2Properties @@ -1362,7 +1362,7 @@ alternate connection factory used for unmanaged connections. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionURL @@ -1401,7 +1401,7 @@ ConnectionURL Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2URL @@ -1443,7 +1443,7 @@ openjpa.ConnectionUserName Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionUserName @@ -1483,7 +1483,7 @@ openjpa.Connection2UserName Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2UserName @@ -1525,7 +1525,7 @@ openjpa.ConnectionRetainMode Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionRetainMode @@ -1566,7 +1566,7 @@ sessions. See for details. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getDataCache @@ -1580,7 +1580,7 @@ DataCache Description: A plugin list string (see ) describing the - + org.apache.openjpa.datacache.DataCaches to use for data caching. See for details. @@ -1608,7 +1608,7 @@ openjpa.DataCacheManager Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheManager @@ -1622,7 +1622,7 @@ DataCacheManager Description: A plugin string (see ) describing the - + openjpa.datacache.DataCacheManager that manages the system data caches. See for details on data caching. @@ -1651,7 +1651,7 @@ openjpa.DataCacheMode Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheMode @@ -1663,7 +1663,7 @@ DataCacheMode Default: DataCacheMode.UNSPECIFIED (see javadoc for details) -Description:Determines which entities will be included in the DataCache. May be any of the values defined in . +Description:Determines which entities will be included in the DataCache. May be any of the values defined in . @@ -1690,7 +1690,7 @@ openjpa.DataCacheTimeout Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheTimeout @@ -1735,7 +1735,7 @@ classes. See for details. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfigurationImpl.getDetachState @@ -1787,7 +1787,7 @@ openjpa.DynamicDataStructs Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getDynamicDataStructs @@ -1819,7 +1819,7 @@ memory and speed optimization over time. Configuration API: - org.apache.openjpa.conf.OpenJPAConfiguration.getDynamicEnhancementAgent + org.apache.openjpa.conf.OpenJPAConfiguration.getDynamicEnhancementAgent Resource adaptor config property: @@ -1864,7 +1864,7 @@ memory and speed optimization over time. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getFetchBatchSize @@ -1901,7 +1901,7 @@ runtime. See for details. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getEncryptionProvider @@ -1915,7 +1915,7 @@ runtime. See for details. Description: A plugin list string (see ) describing the - + org.apache.openjpa.lib.encryption.EncryptionProviders to use for connection password encryption. See for details. @@ -1940,7 +1940,7 @@ encryption. See for details. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getFetchGroups @@ -1982,7 +1982,7 @@ Fetch groups can also be set at runtime. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getFilterListeners @@ -1996,7 +1996,7 @@ FilterListeners Description: A comma-separated list of full plugin strings (see ) for custom - + org.apache.openjpa.jdbc.kernel.exps.JDBCFilterListener s to make available to all queries, in addition to the standard set of listeners. You can also add filter listeners to individual queries. See @@ -2039,7 +2039,7 @@ openjpa.FlushBeforeQueries Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getFlushBeforeQueries @@ -2071,7 +2071,7 @@ query. See for details. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getIgnoreChanges @@ -2139,7 +2139,7 @@ or flush before running it against the datastore. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.isInitializeEagerly @@ -2185,7 +2185,7 @@ openjpa.Instrumentation Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getInstrumentation @@ -2204,7 +2204,7 @@ Instrumentation Description: A plugin string (see ) describing one or more instances of - + org.apache.openjpa.lib.instrumentation.InstrumentationProvider and specific instruments to enable. See for details. @@ -2233,7 +2233,7 @@ specific instruments to enable. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getInverseManager @@ -2251,7 +2251,7 @@ InverseManager Description: A plugin string (see ) describing a - + org.apache.openjpa.kernel.InverseManager to use for managing bidirectional relations upon a flush. See for usage documentation. @@ -2280,7 +2280,7 @@ for managing bidirectional relations upon a flush. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getLockManager @@ -2298,7 +2298,7 @@ LockManager Description: A plugin string (see ) describing a - + org.apache.openjpa.kernel.LockManager to use for acquiring locks on persistent instances during transactions. See for more information. @@ -2327,7 +2327,7 @@ locks on persistent instances during transactions. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getLockTimeout @@ -2366,7 +2366,7 @@ for an object lock before throwing an exception, or -1 for no limit. See Configuration API: - + org.apache.openjpa.lib.conf.Configuration.getLog @@ -2385,7 +2385,7 @@ for an object lock before throwing an exception, or -1 for no limit. See Description: A plugin string (see ) describing a - + org.apache.openjpa.lib.log.LogFactory to use for logging. For details on logging, see . @@ -2416,7 +2416,7 @@ For details on logging, see . Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getManagedRuntime @@ -2430,7 +2430,7 @@ ManagedRuntime Description: A plugin string (see ) describing the - + org.apache.openjpa.ee.ManagedRuntime implementation to use for obtaining a reference to the TransactionManager in an enterprise environment. @@ -2451,7 +2451,7 @@ enterprise environment. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getMapping @@ -2490,7 +2490,7 @@ object-to-datastore mapping to use. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getMaxFetchDepth @@ -2530,7 +2530,7 @@ traverse when eager fetching. Use -1 for no limit. Defaults to no limit. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getMetaDataFactory @@ -2544,7 +2544,7 @@ MetaDataFactory Description: A plugin string (see ) describing the - + openjpa.meta.MetaDataFactory to use to store and retrieve metadata for your persistent classes. See for details. @@ -2574,7 +2574,7 @@ retrieve metadata for your persistent classes. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getMetaDataRepository @@ -2588,7 +2588,7 @@ MetaDataRepository Description: A plugin string (see ) describing the - + openjpa.meta.MetaDataRepository to use to store and retrieve metadata for your persistent classes. See for details. @@ -2620,7 +2620,7 @@ retrieve metadata for your persistent classes. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getMultithreaded @@ -2660,7 +2660,7 @@ will be accessed by multiple threads at once. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getOptimistic @@ -2699,7 +2699,7 @@ pessimistic (datastore) transactional modes. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getOptimizeIdCopy @@ -2748,7 +2748,7 @@ openjpa.OrphanedKeyAction Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getOrphanedKeyAction @@ -2766,7 +2766,7 @@ OrphanedKeyAction Description: A plugin string (see ) describing a - + org.apache.openjpa.event.OrphanedKeyAction to invoke when OpenJPA discovers an orphaned datastore key. See for details. @@ -2787,7 +2787,7 @@ openjpa.NontransactionalRead Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getNontransactionalRead @@ -2819,7 +2819,7 @@ openjpa.NontransactionalWrite Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getNontransactionalWrite @@ -2860,7 +2860,7 @@ will take effect on the next transaction. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getProxyManager @@ -2874,7 +2874,7 @@ ProxyManager Description: A plugin string (see ) describing a - + org.apache.openjpa.util.ProxyManager to use for proxying mutable second class objects. See for details. @@ -2896,7 +2896,7 @@ mutable second class objects. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getPostLoadOnMerge @@ -2941,7 +2941,7 @@ mutable second class objects. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getQueryCache @@ -2955,7 +2955,7 @@ QueryCache Description: A plugin string (see ) describing the - + org.apache.openjpa.datacache.QueryCache implementation to use for caching of queries loaded from the data store. See for details. @@ -3019,7 +3019,7 @@ query compilation. See for details. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getReadLockLevel @@ -3079,7 +3079,7 @@ openjpa.RemoteCommitProvider Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getRemoteCommitProvider @@ -3094,7 +3094,7 @@ RemoteCommitProvider Description: A plugin string (see ) describing the - + org.apache.openjpa.event.RemoteCommitProvider implementation to use for distributed event notification. See for more information. @@ -3115,7 +3115,7 @@ implementation to use for distributed event notification. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getRestoreState @@ -3150,7 +3150,7 @@ to their pre-transaction values when a rollback occurs. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getRetainState @@ -3189,7 +3189,7 @@ openjpa.RetryClassRegistration Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getRetryClassRegistration @@ -3218,7 +3218,7 @@ serious problems. Configuration API: - org.apache.openjpa.conf.OpenJPAConfiguration.getRuntimeUnenhancedClasses + org.apache.openjpa.conf.OpenJPAConfiguration.getRuntimeUnenhancedClasses Resource adaptor config property: @@ -3270,7 +3270,7 @@ openjpa.SavepointManager Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getSavepointManager @@ -3287,7 +3287,7 @@ SavepointManager Description: A plugin string (see ) describing a - + org.apache.openjpa.kernel.SavepointManager to use for managing transaction savepoints. See for details. @@ -3308,7 +3308,7 @@ use for managing transaction savepoints. See Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getSequence @@ -3322,7 +3322,7 @@ Sequence Description: A plugin string (see ) describing the - + org.apache.openjpa.kernel.Seq implementation to use for the system sequence. See for more information. @@ -3343,7 +3343,7 @@ information. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getSpecificationInstance @@ -3388,7 +3388,7 @@ See for more information. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getTransactionMode @@ -3431,7 +3431,7 @@ use. You can override this setting per-session. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getUseTCCLinSelectNew @@ -3478,7 +3478,7 @@ use. You can override this setting per-session. Configuration API: - + org.apache.openjpa.conf.OpenJPAConfiguration.getWriteLockLevel @@ -3546,7 +3546,7 @@ openjpa.jdbc.ConnectionDecorators Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getConnectionDecorators @@ -3561,7 +3561,7 @@ ConnectionDecorators Description: A comma-separated list of plugin strings (see ) describing - + org.apache.openjpa.lib.jdbc.ConnectionDecorator instances to install on the connection factory. These decorators can wrap connections passed from the underlying DataSource to add @@ -3594,7 +3594,7 @@ openjpa.jdbc.DBDictionary Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getDBDictionary @@ -3611,7 +3611,7 @@ openjpa.ConnectionDriverName Description: A plugin string (see ) describing the - + org.apache.openjpa.jdbc.sql.DBDictionary to use for database interaction. OpenJPA typically auto-configures the dictionary based on the JDBC URL, but you may have to set this property explicitly if you are @@ -3644,7 +3644,7 @@ openjpa.jdbc.DriverDataSource Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getDriverDataSource @@ -3662,7 +3662,7 @@ DriverDataSource Description: The alias or full class name of the - + org.apache.openjpa.jdbc.schema.DriverDataSource implementation to use to wrap JDBC Driver classes with javax.sql.DataSource instances. The org.apache.openjpa.jdbc.schema.AutoDriverDataSource implementation is the default and will select either the DBCPDriverDataSource or SimpleDriverDataSource based on if Apache Commons DBCP is available @@ -3693,7 +3693,7 @@ openjpa.jdbc.EagerFetchMode Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getEagerFetchMode @@ -3737,7 +3737,7 @@ openjpa.jdbc.FetchDirection Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getFetchDirection @@ -3781,7 +3781,7 @@ openjpa.jdbc.JDBCListeners Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getJDBCListeners @@ -3795,7 +3795,7 @@ JDBCListeners Description: A comma-separated list of plugin strings (see ) describing - + org.apache.openjpa.lib.jdbc.JDBCListener event listeners to install. These listeners will be notified on various JDBC-related events. @@ -3824,7 +3824,7 @@ events. Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getLRSSize @@ -3868,7 +3868,7 @@ openjpa.jdbc.MappingDefaults Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getMappingDefaults @@ -3882,7 +3882,7 @@ MappingDefaults Description: A plugin string (see ) describing the - + org.apache.openjpa.jdbc.meta.MappingDefaults to use to define default column names, table names, and constraints for your persistent classes. See for @@ -3912,7 +3912,7 @@ openjpa.jdbc.MappingFactory Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getMappingFactory @@ -3926,7 +3926,7 @@ MappingFactory Description: A plugin string (see ) describing the - + org.apache.openjpa.meta.MetaDataFactory to use to store and retrieve object-relational mapping information for your persistent classes. See for details. @@ -3991,7 +3991,7 @@ openjpa.jdbc.ResultSetType Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getResultSetType @@ -4030,7 +4030,7 @@ when fetching result lists. This property can also be varied at runtime. See Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getSchema @@ -4070,7 +4070,7 @@ openjpa.jdbc.SchemaFactory Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getSchemaFactory @@ -4089,7 +4089,7 @@ others Description: A plugin string (see ) describing the - + org.apache.openjpa.jdbc.schema.SchemaFactory to use to store and retrieve information about the database schema. See for details. @@ -4113,7 +4113,7 @@ use to store and retrieve information about the database schema. See Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getSchemas @@ -4153,7 +4153,7 @@ schemas and/or tables used for your persistent data. See Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getSQLFactory @@ -4167,7 +4167,7 @@ SQLFactory Description: A plugin string (see ) describing the - + org.apache.openjpa.jdbc.sql.SQLFactory to use to abstract common SQL constructs. @@ -4203,7 +4203,7 @@ openjpa.jdbc.SubclassFetchMode Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getSubclassFetchMode @@ -4247,7 +4247,7 @@ openjpa.jdbc.SynchronizeMappings Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getSynchronizeMappings @@ -4297,7 +4297,7 @@ openjpa.jdbc.TransactionIsolation Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getTransactionIsolation @@ -4344,7 +4344,7 @@ openjpa.jdbc.UpdateManager Configuration API: - + org.apache.openjpa.jdbc.conf.JDBCConfiguration.getUpdateManager @@ -4362,11 +4362,11 @@ batching-constraint, batching-operation-order Description: The full class name of the - + org.apache.openjpa.jdbc.kernel.UpdateManager to use to flush persistent object changes to the datastore. The provided default implementation is - + org.apache.openjpa.jdbc.kernel.BatchingConstraintUpdateManager . diff --git a/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml b/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml index eb027c978..64c033465 100644 --- a/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml +++ b/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml @@ -694,7 +694,7 @@ configuration properties. If OpenJPA cannot detect what type of database you are using, or if you are using an unsupported database, you will have to tell OpenJPA what - + org.apache.openjpa.jdbc.sql.DBDictionary to use. The DBDictionary abstracts away the differences between databases. You can plug a dictionary into OpenJPA using the @@ -713,7 +713,7 @@ below. If you are using an unsupported database, you may have to write your own access: Dictionary for Microsoft Access. This is an alias for the - + org.apache.openjpa.jdbc.sql.AccessDictionary class. @@ -726,7 +726,7 @@ class. db2: Dictionary for IBM's DB2 database. This is an alias for -the +the org.apache.openjpa.jdbc.sql.DB2Dictionary class. @@ -739,7 +739,7 @@ the derby: Dictionary for the Apache Derby database. This is an alias for the - + org.apache.openjpa.jdbc.sql.DerbyDictionary class. @@ -753,7 +753,7 @@ alias for the empress: Dictionary for Empress database This is an alias for the - + org.apache.openjpa.jdbc.sql.EmpressDictionary class. @@ -767,7 +767,7 @@ class. foxpro: Dictionary for Microsoft Visual FoxPro. This is an alias for the - + org.apache.openjpa.jdbc.sql.FoxProDictionary class. @@ -781,7 +781,7 @@ class. h2: Dictionary for the H2 Database Engine. This is an alias for the - + org.apache.openjpa.jdbc.sql.H2Dictionary class. @@ -794,7 +794,7 @@ alias for the hsql: Dictionary for the Hypersonic SQL database. This is an alias for the - + org.apache.openjpa.jdbc.sql.HSQLDictionary class. @@ -807,7 +807,7 @@ alias for the informix: Dictionary for the Informix database. This is an alias for the - + org.apache.openjpa.jdbc.sql.InformixDictionary class. @@ -820,7 +820,7 @@ class. ingres: Dictionary for Ingres. This is an alias for the - + org.apache.openjpa.jdbc.sql.IngresDictionary class. @@ -834,7 +834,7 @@ class. jdatastore: Dictionary for Borland JDataStore. This is an alias for the - + org.apache.openjpa.jdbc.sql.JDataStoreDictionary class. @@ -848,7 +848,7 @@ class. mariadb: Dictionary for the MariaDB database. This is an alias for the - + org.apache.openjpa.jdbc.sql.MariaDBDictionary class. @@ -862,7 +862,7 @@ class. mysql: Dictionary for the MySQL database. This is an alias for the - + org.apache.openjpa.jdbc.sql.MySQLDictionary class. @@ -875,7 +875,7 @@ class. oracle: Dictionary for Oracle. This is an alias for the - + org.apache.openjpa.jdbc.sql.OracleDictionary class. @@ -889,7 +889,7 @@ class. pointbase: Dictionary for Pointbase Embedded database. This is an alias for the - + org.apache.openjpa.jdbc.sql.PointbaseDictionary class. @@ -902,7 +902,7 @@ class. postgres: Dictionary for PostgreSQL. This is an alias for -the +the org.apache.openjpa.jdbc.sql.PostgresDictionary class. @@ -916,7 +916,7 @@ class. soliddb: Dictionary for IBM's SolidDB database. This is an alias for the - + org.apache.openjpa.jdbc.sql.SolidDBDictionary class. @@ -930,7 +930,7 @@ class. sqlserver: Dictionary for Microsoft's SQL Server database. This is an alias for the - + org.apache.openjpa.jdbc.sql.SQLServerDictionary class. @@ -943,7 +943,7 @@ class. sybase: Dictionary for Sybase. This is an alias for the - + org.apache.openjpa.jdbc.sql.SybaseDictionary class. @@ -1169,7 +1169,7 @@ generated by the mappingtool. BooleanRepresentation: The overridden default representation for java.lang.Boolean or boolean fields in JPA Entities. A - + org.apache.openjpa.jdbc.sql.BooleanRepresentation describes how Boolean values in entities get mapped into the database by default. Note that you additionally might need to define the BooleanTypeName @@ -5230,7 +5230,7 @@ Oracle, for example, requires names in all upper case. OpenJPA relies on the - + openjpa.jdbc.SchemaFactory interface for runtime schema information. You can control the schema factory OpenJPA uses through the openjpa.jdbc.SchemaFactory property. There are several @@ -5240,7 +5240,7 @@ built-in options to choose from: dynamic: This is the default setting. It is an alias for the - + org.apache.openjpa.jdbc.schema.DynamicSchemaFactory. The DynamicSchemaFactory is the most performant @@ -5255,7 +5255,7 @@ that OpenJPA can order its SQL statements to meet them. native: This is an alias for the - + org.apache.openjpa.jdbc.schema.LazySchemaFactory . As persistent classes are loaded by the application, OpenJPA reads their metadata and object-relational mapping information. This factory uses the @@ -5277,7 +5277,7 @@ read foreign key information during schema validation. table: This is an alias for the - + org.apache.openjpa.jdbc.schema.TableSchemaFactory . This schema factory stores schema information as an XML document in a database table it creates for this purpose. If your JDBC driver doesn't support the @@ -5312,7 +5312,7 @@ holding the schema definition as an XML string. Defaults to SCHEMA_DEF file: This is an alias for the - + org.apache.openjpa.jdbc.schema.FileSchemaFactory . This factory is a lot like the TableSchemaFactory, and has the same advantages and disadvantages. Instead of storing its XML schema @@ -5410,7 +5410,7 @@ schemas. You can invoke the schema tool through its Java class, - + org.apache.openjpa.jdbc.schema.SchemaTool. In addition to the universal flags of the configuration framework, the schema tool accepts the following command diff --git a/openjpa-project/src/doc/manual/ref_guide_deploy.xml b/openjpa-project/src/doc/manual/ref_guide_deploy.xml index 2774b2566..6fad4f2b6 100644 --- a/openjpa-project/src/doc/manual/ref_guide_deploy.xml +++ b/openjpa-project/src/doc/manual/ref_guide_deploy.xml @@ -58,7 +58,7 @@ The JPA Overview describes the javax.persistence.Persistence Persistence to add additional EntityManagerFactory creation methods. The org.apache.openjpa.persistence.OpenJPAPersistence class - + Javadoc details these extensions. @@ -164,7 +164,7 @@ manager for an unrecognized or non-standard application server setup. This is accomplished through the openjpa.ManagedRuntime configuration property. This property describes an - + org.apache.openjpa.ee.ManagedRuntime implementation to use for transaction manager discovery. You can specify your own implementation, or use one of the built-ins: @@ -173,7 +173,7 @@ or use one of the built-ins: auto: This is the default. It is an alias for the - + org.apache.openjpa.ee.AutomaticManagedRuntime class. This managed runtime is able to automatically integrate with several common application servers. @@ -182,7 +182,7 @@ common application servers. invocation: An alias for the - + org.apache.openjpa.ee.InvocationManagedRuntime class. You can configure this runtime to invoke any static method in order to obtain the appserver's transaction manager. @@ -191,7 +191,7 @@ method in order to obtain the appserver's transaction manager. jndi: An alias for the - + org.apache.openjpa.ee.JNDIManagedRuntime class. You can configure this runtime to look up the transaction manager at any JNDI location. diff --git a/openjpa-project/src/doc/manual/ref_guide_encryption.xml b/openjpa-project/src/doc/manual/ref_guide_encryption.xml index 1225fae73..42c084c63 100644 --- a/openjpa-project/src/doc/manual/ref_guide_encryption.xml +++ b/openjpa-project/src/doc/manual/ref_guide_encryption.xml @@ -25,7 +25,7 @@ OpenJPA provides an interface for a provider to implement connection password encryption. Whenever a connection password is needed, the decrypt(String) method will be invoked. See - + org.apache.openjpa.lib.encryption.EncryptionProvider for the detailed Javadoc. diff --git a/openjpa-project/src/doc/manual/ref_guide_instrumentation.xml b/openjpa-project/src/doc/manual/ref_guide_instrumentation.xml index 6729d87cc..1cd09e09d 100644 --- a/openjpa-project/src/doc/manual/ref_guide_instrumentation.xml +++ b/openjpa-project/src/doc/manual/ref_guide_instrumentation.xml @@ -114,9 +114,9 @@ OpenJPA includes built-in support for a JMX Platform MBean provider, but a custom instrumentation providers can be created by implementing the - + InstrumentationProvider interface or more simply by extending - + AbstractInstrumentationProvider. To use the custom instrumentation provider, include the class in your classpath and specify the class name as the base value on the openjpa.Instrumentation configuration property. @@ -124,12 +124,12 @@ OpenJPA includes instruments for various caches, but you can also create your own instruments. To create a custom instrument you need to implement the - + Instrument interface or more simply extend - + AbstractInstrument. If you are building a Platform MBean JMX-based instrument this effort can be simplified by extending - + JMXInstrument. If you create your own custom provider, class name aliases can be registered within the provider to simplify configuration. For example, the instrument com.my.app.MySQLInstrument could be aliased as diff --git a/openjpa-project/src/doc/manual/ref_guide_integration.xml b/openjpa-project/src/doc/manual/ref_guide_integration.xml index 6a3902656..c4193945e 100644 --- a/openjpa-project/src/doc/manual/ref_guide_integration.xml +++ b/openjpa-project/src/doc/manual/ref_guide_integration.xml @@ -98,7 +98,7 @@ environment. All OpenJPA tasks accept a nested config element, which defines the configuration environment in which the specified task will run. The attributes for the config tag are defined by the - + JDBCConfiguration bean methods. Note that excluding the config element will cause the Ant task to use the default system configuration mechanism, such as the configuration defined in diff --git a/openjpa-project/src/doc/manual/ref_guide_logging.xml b/openjpa-project/src/doc/manual/ref_guide_logging.xml index df5caf3ae..f63fdfe1b 100644 --- a/openjpa-project/src/doc/manual/ref_guide_logging.xml +++ b/openjpa-project/src/doc/manual/ref_guide_logging.xml @@ -549,7 +549,7 @@ logging to a graphical component for GUI applications. A custom logging framework must include an implementation of the - + org.apache.openjpa.lib.log.LogFactory interface. We present a custom LogFactory below. diff --git a/openjpa-project/src/doc/manual/ref_guide_mapping.xml b/openjpa-project/src/doc/manual/ref_guide_mapping.xml index d092bd04d..0d76f0345 100644 --- a/openjpa-project/src/doc/manual/ref_guide_mapping.xml +++ b/openjpa-project/src/doc/manual/ref_guide_mapping.xml @@ -66,7 +66,7 @@ their corresponding database schema from your object model. OpenJPA supports forward mapping through the mapping tool. The next section presents several common mapping tool use cases. You can invoke the tool through its Java class, - + org.apache.openjpa.jdbc.meta.MappingTool. @@ -502,7 +502,7 @@ proper relations between the persistent classes it creates. Run the reverse mapping tool on the finished schema file. If you do not supply the schema file to reverse map, the tool will run directly against the schema in the database. The tool can be run via its Java class, - + org.apache.openjpa.jdbc.meta.ReverseMappingTool. @@ -689,11 +689,11 @@ OpenJPA is examining. -customizerClass/-cc <class name>: The full class name of a - + org.apache.openjpa.jdbc.meta.ReverseCustomizer customization plugin. If you do not specify a reverse customizer of your own, the system defaults to a - + PropertiesReverseCustomizer. This customizer allows you to specify simple customization options in the properties file given with the -customizerProperties flag below. We present the @@ -753,7 +753,7 @@ Your persistent classes are now ready to access your existing schema. The org.apache.openjpa.jdbc.meta.ReverseCustomizer plugin interface allows you to customize the reverse mapping process. See the class - + Javadoc for details on the hooks that this interface provides. Specify the concrete plugin implementation to use with the -customizerClass/-cc command-line flag, described in the preceding @@ -761,7 +761,7 @@ section. By default, the reverse mapping tool uses a - + org.apache.openjpa.jdbc.meta.PropertiesReverseCustomizer . This customizer allows you to perform relatively simple customizations through the properties file named with the @@ -996,7 +996,7 @@ database's tools to bring the schema up-to-date. The previous sections showed how to use the mapping tool to generate default mappings. But how does the mapping tool know what mappings to generate? The answer lies in the - + org.apache.openjpa.jdbc.meta.MappingDefaults interface. OpenJPA uses an instance of this interface to decide how to name tables and columns, where to put foreign keys, and generally how to create a @@ -1025,7 +1025,7 @@ OpenJPA includes the following standard implementations: jpa: Provides defaults in compliance with the JPA standard. This is an alias for the - + org.apache.openjpa.persistence.jdbc.PersistenceMappingDefaults class. This class extends the MappingDefaultsImpl class described below, so it has all the same @@ -1045,7 +1045,7 @@ compatibility with older OpenJPA versions which did not prepend the field name. default: This is an alias for the - + org.apache.openjpa.jdbc.meta.MappingDefaultsImpl class. This default implementation is highly configurable. It has the following properties: @@ -1079,7 +1079,7 @@ classes. You can specify a built-in strategy alias or the full class name of a You can also use OpenJPA's plugin format (see ) to pass arguments to the strategy instance. See the - + org.apache.openjpa.jdbc.meta.strats package for available strategies. @@ -1093,7 +1093,7 @@ You can also use OpenJPA's plugin format (see ) to pass arguments to the strategy instance. Common strategies are vertical and flat, the default. See the - + org.apache.openjpa.jdbc.meta.strats package for all available strategies. @@ -1108,7 +1108,7 @@ version strategy. You can also use OpenJPA's plugin format (see strategy instance. Common strategies are none, state-comparison, timestamp, and version-number, the default. See the - + org.apache.openjpa.jdbc.meta.strats package for all available strategies. @@ -1125,7 +1125,7 @@ strategy instance. Common strategies are final for a base class without subclasses, none to use joins to subclass tables rather than a discriminator column, and class-name, the default. See the - + org.apache.openjpa.jdbc.meta.strats package for all available strategies. @@ -1379,7 +1379,7 @@ In a non-primary key join, at least one of the target columns is not a primary key. Once again, OpenJPA supports this join type with the same syntax as a primary key join. There is one restriction, however: each non-primary key column you are joining to must be controlled by a field mapping that implements the - + org.apache.openjpa.jdbc.meta.Joinable interface. All built in basic mappings implement this interface, including basic fields of embedded objects. OpenJPA will also respect any custom mappings that implement this @@ -1540,7 +1540,7 @@ to map entities using these strategies to the database. describes how to use datastore identity in JPA. OpenJPA requires a single numeric primary key column to hold datastore identity values. The - + org.apache.openjpa.persistence.jdbc.DataStoreIdColumn annotation customizes the datastore identity column. This annotation has the following properties: @@ -1633,10 +1633,10 @@ public class LogEntry { OpenJPA supports version fields as defined by the JPA specification, but allows you to use a surrogate version column in place of a version field if you like. You map the surrogate version column with the - + org.apache.openjpa.persistence.jdbc.VersionColumn annotation. You can also use the - + org.apache.openjpa.persistence.jdbc.VersionColumns annotation to declare an array of VersionColumn values. Each VersionColumn has the following properties: @@ -1774,7 +1774,7 @@ OpenJPA makes it easy to create multi-column specification includes a Column annotation, but is missing a way to declare multiple columns for a single field. OpenJPA remedies this with the - + org.apache.openjpa.persistence.jdbc.Columns annotation, which contains an array of Column values. @@ -1803,7 +1803,7 @@ OpenJPA rectifies this by allowing you to declare which attribute in the related type each join column links to, rather than which column. If the attribute is mapped differently in various subclass tables, OpenJPA automatically forms the proper join for the subclass record at hand. The - + org.apache.openjpa.persistence.jdbc.XJoinColumn annotation has all the same properties as the standard JoinColumn annotation, but adds an additional @@ -1813,7 +1813,7 @@ referencedAttributeName property for this purpose. Simply use a For compound keys, use the - + org.apache.openjpa.persistence.jdbc.XJoinColumns annotation. The value of this annotation is an array of individual XJoinColumns. @@ -1833,7 +1833,7 @@ a null embedded object and one with default values for all of its fields. OpenJPA overcomes these shortcomings with the - + org.apache.openjpa.persistence.jdbc.EmbeddedMapping annotation. This annotation has the following properties: @@ -1885,7 +1885,7 @@ allows you to override multiple mapped superclass mappings. Each - + org.apache.openjpa.persistence.jdbc.MappingOverride annotation has the following properties: @@ -2004,7 +2004,7 @@ We explore the annotations below. The - + org.apache.openjpa.persistence.jdbc.ContainerTable annotation describes a database table that holds collection (or map) elements. This annotation has the following properties: @@ -2075,11 +2075,11 @@ of the next sections. Element join columns are equivalent to standard JPA join columns, except that they represent a join to a collection or map element entity rather than a direct relation. You represent an element join column with OpenJPA's - + org.apache.openjpa.persistence.jdbc.ElementJoinColumn annotation. To declare a compound join, enclose an array of ElementJoinColumns in the - + org.apache.openjpa.persistence.jdbc.ElementJoinColumns annotation. @@ -2112,13 +2112,13 @@ Relational databases do not guarantee that records are returned in insertion order. If you want to make sure that your collection elements are loaded in the same order they were in when last stored, you must declare an order column. An order column can be declared using OpenJPA's - + org.apache.openjpa.persistence.jdbc.OrderColumn annotation or the JPA 2.0 javax.persistence.OrderColumn annotation or order-column orm element as defined in . OpenJPA's - + org.apache.openjpa.persistence.jdbc.OrderColumn annotation has the following properties: @@ -2274,11 +2274,11 @@ also use this annotation to represent a map table. join columns described in serve for collection elements. OpenJPA's - + org.apache.openjpa.persistence.jdbc.KeyColumn annotation represents a map key. To map custom multi-column keys, use the - + org.apache.openjpa.persistence.jdbc.KeyColumns annotation, whose value is an array of KeyColumns. @@ -2302,10 +2302,10 @@ also use this annotation to represent a map table. Key join columns are equivalent to standard JPA join columns, except that they represent a join to a map key entity rather than a direct relation. You represent a key join column with OpenJPA's - + org.apache.openjpa.persistence.jdbc.KeyJoinColumn annotation. To declare a compound join, enclose an array of KeyJoinColumns in the - + org.apache.openjpa.persistence.jdbc.KeyJoinColumns annotation. @@ -2328,7 +2328,7 @@ also use this annotation to represent a map table. The - + org.apache.openjpa.persistence.jdbc.KeyEmbeddedMapping annotation allows you to map your map field's embedded key type to your container table. This annotation has exactly @@ -2420,13 +2420,13 @@ presented in the following sections. -The +The org.apache.openjpa.persistence.jdbc.Index annotation represents an index on the columns of a field. It is also used within the ContainerTable annotation to index join columns. To index the columns of a collection element, use the - + org.apache.openjpa.persistence.jdbc.ElementIndex annotation. These annotations have the following properties: @@ -2470,14 +2470,14 @@ to false. -The +The org.apache.openjpa.persistence.jdbc.ForeignKey annotation represents a foreign key on the columns of a field. It is also used within the ContainerTable annotation to set a database foreign key on join columns. To set a constraint to the columns of a collection element, use the - + org.apache.openjpa.persistence.jdbc.ElementForeignKey annotation. These annotations have the following properties: @@ -2517,7 +2517,7 @@ does not manifest as a database foreign key constraint. ForeignKeyAction deleteAction: Value from the - + org.apache.openjpa.persistence.jdbc.ForeignKeyAction enum identifying the desired delete action. Defaults to RESTRICT. @@ -2526,7 +2526,7 @@ RESTRICT. ForeignKeyAction updateAction: Value from the - + org.apache.openjpa.persistence.jdbc.ForeignKeyAction enum identifying the desired update action. Defaults to RESTRICT. @@ -2561,7 +2561,7 @@ to discover existing foreign keys (see -The +The org.apache.openjpa.persistence.jdbc.Unique annotation represents a unique constraint on the columns of a field. It is more convenient than using the uniqueConstraints property of @@ -2986,7 +2986,7 @@ restrictions. To persist a stream, apply the - + org.apache.openjpa.persistence.Persistent annotation to either java.io.InputStream or java.io.Reader field. @@ -3119,10 +3119,10 @@ OpenJPA recognizes the following class extensions. This extension specifies how to eagerly fetch subclass state. It overrides the global openjpa.jdbc.SubclassFetchMode property. Set the OpenJPA - + org.apache.openjpa.persistence.jdbc.SubclassFetchMode annotation to a value from the - + org.apache.openjpa.persistence.jdbc.FetchMode enum: JOIN, PARALLEL, or NONE. See @@ -3148,7 +3148,7 @@ openjpa.jdbc.SubclassFetchMode property. Set the OpenJPA -The +The org.apache.openjpa.persistence.jdbc.Strategy class annotation allows you to specify a custom mapping strategy for your class. See for information on custom @@ -3175,7 +3175,7 @@ mappings. The - + org.apache.openjpa.persistence.jdbc.DiscriminatorStrategy class annotation allows you to specify a custom discriminator strategy. See for information on custom @@ -3202,7 +3202,7 @@ mappings. The - + org.apache.openjpa.persistence.jdbc.VersionStrategy class annotation allows you to specify a custom version strategy. See for information on custom @@ -3239,10 +3239,10 @@ OpenJPA recognizes the following field extensions. This extension specifies how to eagerly fetch related objects. It overrides the global openjpa.jdbc.EagerFetchMode property. Set the OpenJPA - + org.apache.openjpa.persistence.jdbc.EagerFetchMode annotation to a value from the - + org.apache.openjpa.persistence.jdbc.FetchMode enum: JOIN, PARALLEL, or NONE. See @@ -3285,14 +3285,14 @@ OpenJPA defines the following extensions for nonpolymorphic values: - + org.apache.openjpa.persistence.jdbc.Nonpolymorphic - + org.apache.openjpa.persistence.jdbc.ElementNonpolymorphic @@ -3300,7 +3300,7 @@ OpenJPA defines the following extensions for nonpolymorphic values: The value of these extensions is a constant from the - + org.apache.openjpa.persistence.jdbc.NonpolymorphicType enumeration. The default value, EXACT, indicates that the relation will always be of the exact declared type. A value of @@ -3353,13 +3353,13 @@ array or collection element relations, respectively: - + org.apache.openjpa.persistence.jdbc.ClassCriteria - + org.apache.openjpa.persistence.jdbc.ElementClassCriteria @@ -3386,7 +3386,7 @@ array or collection element relations, respectively: OpenJPA's - + org.apache.openjpa.persistence.jdbc.Strategy extension allows you to specify a custom mapping strategy or value handler for a field. See @@ -3428,14 +3428,14 @@ strategies. To create a custom class mapping, write an implementation of the - + org.apache.openjpa.jdbc.meta.ClassStrategy interface. You will probably want to extend one of the existing abstract or concrete strategies in the org.apache.openjpa.jdbc.meta.strats package. -The +The org.apache.openjpa.persistence.jdbc.Strategy annotation allows you to declare a custom class mapping strategy in JPA mapping metadata. Set the value of the annotation to the full class name of your custom @@ -3449,10 +3449,10 @@ OpenJPA's plugin syntax, detailed in . To define a custom discriminator or version strategy, implement the - + org.apache.openjpa.jdbc.meta.DiscriminatorStrategy or - + org.apache.openjpa.jdbc.meta.VersionStrategy interface, respectively. You might extend one of the existing abstract or concrete strategies in the org.apache.openjpa.jdbc.meta.strats @@ -3460,10 +3460,10 @@ concrete strategies in the org.apache.openjpa.jdbc.meta.strats OpenJPA includes the - + org.apache.openjpa.persistence.jdbc.DiscriminatorStrategy and - + org.apache.openjpa.persistence.jdbc.VersionStrategy class annotations for declaring a custom discriminator or version strategy in JPA mapping metadata. Set the string value of these annotations to @@ -3513,7 +3513,7 @@ sections examine each. Value handlers make it trivial to map any type that you can break down into one or more simple values. All value handlers implement the org.apache.openjpa.jdbc.meta.ValueHandler interface; see its - Javadoc + Javadoc for details. Also, examine the built-in handlers in the src/openjpa/jdbc/meta/strats directory of your OpenJPA source distribution. Use these functional implementations as examples when you @@ -3537,7 +3537,7 @@ create your own value handlers. OpenJPA interacts with persistent fields through the - + org.apache.openjpa.jdbc.meta.FieldStrategy interface. You can implement this interface yourself to create a custom field strategy, or extend one of the existing abstract or concrete strategies in the @@ -3576,7 +3576,7 @@ defaults in detail. Your other option is to explicitly install a custom value handler or strategy on a particular field. To do so, specify the full name of your implementation class in the proper mapping metadata extension. OpenJPA includes the - + org.apache.openjpa.persistence.jdbc.Strategy annotation. You can configure the named strategy or handler's bean properties in these extensions using OpenJPA's plugin format (see @@ -3610,7 +3610,7 @@ openjpa.OrphanedKeyAction configuration property controls what action to take when OpenJPA encounters an orphaned key. You can set this plugin string (see ) to a custom implementation of the - + org.apache.openjpa.event.OrphanedKeyAction interface, or use one of the built-in options: @@ -3619,7 +3619,7 @@ interface, or use one of the built-in options: log: This is the default setting. This option logs a message for each orphaned key. It is an alias for the - + org.apache.openjpa.event.LogOrphanedKeyAction class, which has the following additional properties: @@ -3643,7 +3643,7 @@ openjpa.Runtime. exception: Throw an EntityNotFoundException when OpenJPA discovers an orphaned key. This is an alias for the - + org.apache.openjpa.event.ExceptionOrphanedKeyAction class. @@ -3651,7 +3651,7 @@ orphaned key. This is an alias for the none: Ignore orphaned keys. This is an alias for the - + org.apache.openjpa.event.NoneOrphanedKeyAction class. diff --git a/openjpa-project/src/doc/manual/ref_guide_meta.xml b/openjpa-project/src/doc/manual/ref_guide_meta.xml index 987ee3a94..dd5df4e10 100644 --- a/openjpa-project/src/doc/manual/ref_guide_meta.xml +++ b/openjpa-project/src/doc/manual/ref_guide_meta.xml @@ -45,7 +45,7 @@ The openjpa.MetaDataFactory configuration property controls metadata loading and storing. This property takes a plugin string (see ) describing a concrete - + org.apache.openjpa.meta.MetaDataFactory implementation. A metadata factory can load mapping information as well as persistence metadata, or it can leave mapping information to a separate @@ -57,7 +57,7 @@ following built-in metadata factories: jpa: Standard JPA metadata. This is an alias for the - + org.apache.openjpa.persistence.PersistenceMetaDataFactory. @@ -220,7 +220,7 @@ JPA defines Basic, Lob, Embedded , ManyToOne, and OneToOne persistence strategies for direct field values. OpenJPA supports all of these standard strategies, but adds one of its own: Persistent. -The +The org.apache.openjpa.persistence.Persistent metadata annotation can represent any direct field value, including custom types. It has the following properties: @@ -286,7 +286,7 @@ JPA standardizes support for collections of entities with the OneToMany and ManyToMany persistence strategies. OpenJPA supports these strategies, and may be extended for other strategies as well. For extended strategies, use the - + org.apache.openjpa.persistence.PersistentCollection metadata annotation to represents any persistent collection field. It has the following properties: @@ -342,7 +342,7 @@ ManyToMany. Defaults to empty array. JPA has limited support for maps. If you extend JPA's standard map support to encompass new mappings, use the - + org.apache.openjpa.persistence.PersistentMap metadata annotation to represent your custom persistent map fields. It has the following properties: @@ -448,9 +448,9 @@ OpenJPA recognizes the following class extensions: -The +The org.apache.openjpa.persistence.FetchGroups and - + org.apache.openjpa.persistence.FetchGroup annotations allow you to define fetch groups in your JPA entities. discusses OpenJPA's support for fetch @@ -482,7 +482,7 @@ extensions allow individual classes to override system caching defaults. OpenJPA defines the - + org.apache.openjpa.persistence.DataCache annotation for caching information. This annotation has the following properties: @@ -536,7 +536,7 @@ modifications. OpenJPA defines the - + org.apache.openjpa.persistence.DetachedState annotation for controlling detached state. When used to annotate a class, DetachedState recognizes the following properties: @@ -611,21 +611,21 @@ JPA entities: - + org.apache.openjpa.persistence.Dependent: Marks a direct relation as dependent. - + org.apache.openjpa.persistence.ElementDependent : Marks the entity elements of a collection, array, or map field as dependent. - + org.apache.openjpa.persistence.KeyDependent: Marks the key entities in a map field as dependent. @@ -656,7 +656,7 @@ Marks the key entities in a map field as dependent. -The +The org.apache.openjpa.persistence.LoadFetchGroup annotation specifies a field's load fetch group. discusses OpenJPA's support for fetch groups @@ -684,7 +684,7 @@ annotation in particular. This boolean extension, denoted by the OpenJPA - + org.apache.openjpa.persistence.LRS annotation, indicates that a field should use OpenJPA's special large result set collection or map proxies. A complete description of large result set proxies is available @@ -712,7 +712,7 @@ in . This extension names the inverse field in a logical bidirectional relation. To create a logical bidirectional relation in OpenJPA, use the - + org.apache.openjpa.persistence.InverseLogical annotation. We discuss logical bidirectional relations and this extension in detail in . @@ -750,10 +750,10 @@ existing persistent objects; new object fields are always writeable. To mark a field read-only in JPA metadata, set the - + org.apache.openjpa.persistence.ReadOnly annotation to an - + org.apache.openjpa.persistence.UpdateAction enum value. The UpdateAction enum includes: @@ -851,19 +851,19 @@ array, and map elements, and map keys, respectively: - + org.apache.openjpa.persistence.Type - + org.apache.openjpa.persistence.ElementType - + org.apache.openjpa.persistence.KeyType @@ -889,7 +889,7 @@ org.apache.openjpa.persistence.KeyType The OpenJPA - + org.apache.openjpa.persistence.Externalizer annotation names a method to transform a field value into a value of another type. See for details. @@ -915,7 +915,7 @@ another type. See for details. The OpenJPA - + org.apache.openjpa.persistence.Factory annotation names a method to re-create a field value from its externalized form. See for details. @@ -941,7 +941,7 @@ names a method to re-create a field value from its externalized form. See The OpenJPA - + org.apache.openjpa.persistence.ExternalValues annotation declares values for transformation of simple fields to different constant values in the datastore. See diff --git a/openjpa-project/src/doc/manual/ref_guide_optimization.xml b/openjpa-project/src/doc/manual/ref_guide_optimization.xml index 20234af97..b7cb0f96e 100644 --- a/openjpa-project/src/doc/manual/ref_guide_optimization.xml +++ b/openjpa-project/src/doc/manual/ref_guide_optimization.xml @@ -159,7 +159,7 @@ features in a transaction that will delete, modify, or create a very large number of objects you can set LargeTransaction to true and perform periodic flushes during your transaction to reduce its memory requirements. See the Javadoc: - + OpenJPAEntityManager.setTrackChangesByType. Note that transactions in large mode have to more aggressively flush items from the data cache. @@ -168,7 +168,7 @@ accessed by other transactions, for example an exhaustive report run only once a month, you can turn off population of the data cache so that the transaction doesn't fill the entire data cache with objects that won't be accessed again. Again, see the Javadoc: - + OpenJPAEntityManager.setPopulateDataCache diff --git a/openjpa-project/src/doc/manual/ref_guide_pc.xml b/openjpa-project/src/doc/manual/ref_guide_pc.xml index 9a65547c9..90b00112e 100644 --- a/openjpa-project/src/doc/manual/ref_guide_pc.xml +++ b/openjpa-project/src/doc/manual/ref_guide_pc.xml @@ -629,7 +629,7 @@ persistent objects for you through a surrogate key in the database. You can control how your JPA datastore identity value is generated through OpenJPA's - + org.apache.openjpa.persistence.DataStoreId class annotation. This annotation has strategy and generator properties that mirror the same-named properties on the @@ -659,7 +659,7 @@ public class LineItem { Internally, OpenJPA uses the public - + org.apache.openjpa.util.Id class for datastore identity objects. When writing OpenJPA plugins, you can manipulate datastore identity objects by casting them to this class. You can also create your own @@ -882,7 +882,7 @@ class code, you can set the @IdClass annotation. The application identity tool can be invoked via its Java class, - + org.apache.openjpa.enhance.ApplicationIdTool. @@ -1056,7 +1056,7 @@ relations that also share datastore storage in JPA. OpenJPA also allows you to define purely logical bidirectional relations. The - + org.apache.openjpa.persistence.InverseLogical annotation names a logical inverse in JPA metadata. @@ -1388,7 +1388,7 @@ collection and map methods, and to update the field's database record on commit. In order to use large result set proxies in JPA, add the - + org.apache.openjpa.persistence.LRS annotation to the persistent field. @@ -1463,7 +1463,7 @@ public class Company { OpenJPA manages proxies through the - + org.apache.openjpa.util.ProxyManager interface. OpenJPA includes a default proxy manager, the org.apache.openjpa.util.ProxyManagerImpl (with a plugin alias name @@ -1494,7 +1494,7 @@ improve performance of some applications by allowing them to perform simple add operations on collections without requiring them to be loaded. Delayed proxies are loaded when an operation is performed that requires loading, such as iteration, size, serialization, and indexOf. They can also be loaded by casting the -proxy to a +proxy to a org.apache.openjpa.util.DelayedProxy and invoking the load method. If a broker factory is available after detaching the owning entity, a collection may be available for delayed loading after the persistence context has been @@ -1539,7 +1539,7 @@ each of B's setters with the value from the corresponding getter on A. If you have custom classes that must be proxied and do not meet these requirements, OpenJPA allows you to define your own proxy classes and your own proxy manager. See the openjpa.util package -Javadoc for details on the interfaces involved, +Javadoc for details on the interfaces involved, and the utility classes OpenJPA provides to assist you. @@ -1651,14 +1651,14 @@ JPA cannot have externalizers. The OpenJPA - + org.apache.openjpa.persistence.Externalizer annotation sets the name of a method that will be invoked to convert the field into its external form for database storage. You can specify either the name of a non-static method, which will be invoked on the field value, or a static method, which will be invoked with the field value as a parameter. Each method can also take an optional - + StoreContext parameter for access to a persistence context. The return value of the method is the field's external form. By default, OpenJPA assumes that all named methods belong to the field value's class (or its @@ -1743,13 +1743,13 @@ public static String AnyClass.toString(CustomType ct, StoreContext ctx) The OpenJPA - + org.apache.openjpa.persistence.Factory annotation contains the name of a method that will be invoked to instantiate the field from the external form stored in the database. Specify a static method name. The method will be invoked with the externalized value and must return an instance of the field type. The method can also take an optional - + StoreContext parameter for access to a persistence context. If a factory is not specified, OpenJPA will use the constructor of the field type that takes a single argument of the external type, or will throw an @@ -1851,7 +1851,7 @@ If your custom field type is mutable and is not a standard collection, map, or date class, OpenJPA will not be able to detect changes to the field. You must mark the field dirty manually, or create a custom field proxy. See - + OpenJPAEntityManager.dirty for how to mark a field dirty manually in JPA. See for a discussion of proxies. @@ -1983,7 +1983,7 @@ primitive wrappers, and Strings), to other pre-defined simple values. Use the OpenJPA - + org.apache.openjpa.persistence.ExternalValues annotation to define external value translations. The values are defined in a format similar to that of @@ -1995,7 +1995,7 @@ true=T,false=F. If the type of the datastore value is different from the field's type, use the - + org.apache.openjpa.persistence.Type annotation to define the datastore type. @@ -2057,11 +2057,11 @@ active fetch groups when loading objects from the datastore. You create fetch groups with the - + org.apache.openjpa.persistence.FetchGroup annotation. If your class only has one custom fetch group, you can place this annotation directly on the class declaration. Otherwise, use the - + org.apache.openjpa.persistence.FetchGroups annotation to declare an array of individual FetchGroup values. The FetchGroup annotation has the following @@ -2100,7 +2100,7 @@ include in this group. As you might expect, listing a - + org.apache.openjpa.persistence.FetchAttribute within a FetchGroup includes the corresponding persistent field or property in the fetch group. Each FetchAttribute @@ -2166,7 +2166,7 @@ accessed. Use OpenJPA's - + org.apache.openjpa.persistence.LoadFetchGroup annotation to specify the load fetch group of any persistent field. The value of the annotation is the name of a declared fetch group whose members should be @@ -2244,7 +2244,7 @@ the fetch depth to something less than the configured maximum. OpenJPA's OpenJPAEntityManager and OpenJPAQuery extensions to the standard EntityManager and Query interfaces provide access to a - + org.apache.openjpa.persistence.FetchPlan object. The FetchPlan maintains the set of active fetch groups and the maximum fetch depth. It begins with the groups and depth defined in the diff --git a/openjpa-project/src/doc/manual/ref_guide_remote.xml b/openjpa-project/src/doc/manual/ref_guide_remote.xml index 7d8ec2a8e..39bb354f7 100644 --- a/openjpa-project/src/doc/manual/ref_guide_remote.xml +++ b/openjpa-project/src/doc/manual/ref_guide_remote.xml @@ -108,7 +108,7 @@ the following javax.persistence.EntityManager method: public void detach(Object) - + OpenJPAEntityManager, however, provides additional detach methods. @@ -400,7 +400,7 @@ all Large Result Sets will be removed. You can also alter the set of fields that will be included in the detached graph at runtime. - + OpenJPAEntityManagers expose the following APIs for controlling detached state: @@ -521,7 +521,7 @@ To enable remote events, you must configure the EntityManagerFactory When a RemoteCommitProvider is properly configured, you can register - + RemoteCommitListeners that will be alerted with a list of modified object ids whenever a transaction on a remote machine successfully commits. @@ -784,10 +784,10 @@ provider, we modify the previous example as follows: You can develop additional mechanisms for remote event notification be by creating an implementation of the - + RemoteCommitProvider interface, possibly by extending the - + AbstractRemoteCommitProvider abstract class.. diff --git a/openjpa-project/src/doc/manual/ref_guide_runtime.xml b/openjpa-project/src/doc/manual/ref_guide_runtime.xml index 7ec7d142f..9dae26469 100644 --- a/openjpa-project/src/doc/manual/ref_guide_runtime.xml +++ b/openjpa-project/src/doc/manual/ref_guide_runtime.xml @@ -171,7 +171,7 @@ Defaults to false. Additionally, some advanced users may want to add capabilities to OpenJPA's -internal +internal org.apache.openjpa.kernel.BrokerImpl. You can configure OpenJPA to use a custom subclass of BrokerImpl with the openjpa.BrokerImpl @@ -180,9 +180,9 @@ name of your custom subclass. When implementing your subclass, consider the finalization issues mentioned in . It may be appropriate to create a subtype of both - + org.apache.openjpa.kernel.BrokerImpl and - + org.apache.openjpa.kernel.FinalizingBrokerImpl. @@ -244,7 +244,7 @@ javax.persistence.EntityManagerFactory with OpenJPA-specific features. The OpenJPAEntityManagerFactory offers APIs to access the OpenJPA data and query caches and to perform other OpenJPA-specific operations. See the - + interface Javadoc for details. @@ -270,7 +270,7 @@ interface Javadoc for details. All OpenJPA EntityManagers implement the - + org.apache.openjpa.persistence.OpenJPAEntityManager interface. This interface extends the standard javax.persistence.EntityManager. Just as the standard @@ -303,7 +303,7 @@ extensions this interface contains. OpenJPA extends JPA's standard query functionality with the org.apache.openjpa.persistence.OpenJPAQuery interface. See its -Javadoc +Javadoc for details on the convenience methods it provides. @@ -330,7 +330,7 @@ org.apache.openjpa.persistence.OpenJPAQuery interface. See its An Extent is a logical view of all persistent instances of a given entity class, possibly including subclasses. OpenJPA adds the - + org.apache.openjpa.persistence.Extent class to the set of Java Persistence APIs. The following code illustrates iterating over all instances of the Magazine entity, without subclasses: @@ -365,7 +365,7 @@ In addition to the EntityManager object cache the JPA specification provides access to a second level cache via the javax.persistence.Cache interface. OpenJPA provides further extensions via the org.apache.openjpa.persistence.StoreCache interface documented at - + org.apache.openjpa.persistence.StoreCache. has detailed information on OpenJPA's data caching system, including the StoreCache facade. @@ -382,7 +382,7 @@ data caching system, including the StoreCache facade. OpenJPA can cache query results as well as persistent object data. The - + org.apache.openjpa.persistence.QueryResultCache is an JPA-flavored facade to OpenJPA's internal query cache. See for details on query caching in @@ -416,7 +416,7 @@ groups, and lock levels. OpenJPA goes one step further, extending FetchPlan with - + org.apache.openjpa.persistence.jdbc.JDBCFetchPlan to add additional JDBC-specific tuning methods. Unless you have customized OpenJPA to use a non-relational back-end (see @@ -452,7 +452,7 @@ FetchPlans. - + org.apache.openjpa.persistence.OpenJPAEntityTransaction extends javax.persistence.EntityTransaction to provide additional transaction-debugging capabilities and some concurrency-related @@ -469,7 +469,7 @@ commit and rollback features. - + org.apache.openjpa.persistence.OpenJPAPersistence is a static helper class that adds OpenJPA-specific utility methods to javax.persistence.Persistence. @@ -661,7 +661,7 @@ In addition to the standard EntityManager.lock(Object, LockModeType) method, the - + OpenJPAEntityManager exposes the following methods to lock objects explicitly: @@ -722,7 +722,7 @@ oem.getTransaction().commit(); OpenJPA delegates the actual work of locking objects to the system's - + org.apache.openjpa.kernel.LockManager. This plugin is controlled by the openjpa.LockManager configuration property. You can write your @@ -732,7 +732,7 @@ own lock manager, or use one of the bundled options: mixed: This is an alias for the - + org.apache.openjpa.jdbc.kernel.MixedLockManager , which implements the JPA 2.0 specification entity locking behaviors. It combines both the optimistic and pessimistic semantics controlled by @@ -753,7 +753,7 @@ This is the default openjpa.LockManager setting in OpenJPA. pessimistic: This is an alias for the +url="../../apidocs/org/apache/openjpa/jdbc/kernel/PessimisticLockManager.html"> org.apache.openjpa.jdbc.kernel.PessimisticLockManager , which uses SELECT FOR UPDATE statements (or the database's equivalent) to lock the @@ -775,7 +775,7 @@ properties: version: This is an alias for the - + org.apache.openjpa.kernel.VersionLockManager. This lock manager does not perform any exclusive locking, but instead ensures read consistency by verifying that the version of all read-locked instances is @@ -788,7 +788,7 @@ behavior. none: This is an alias for the - + org.apache.openjpa.kernel.NoneLockManager, which does not perform any locking at all. @@ -983,7 +983,7 @@ changes. This chapter describes how to use and configure OpenJPA savepoints. OpenJPA's - + OpenJPAEntityManager have the following methods to control savepoint behavior. Note that the savepoints work in tandem with the current transaction. This means that savepoints require an open @@ -1063,7 +1063,7 @@ oem.getTransaction().commit(); OpenJPA uses the - + org.apache.openjpa.kernel.SavepointManager plugin to handle preserving the savepoint state. OpenJPA includes the following SavepointManager @@ -1073,7 +1073,7 @@ savepoint state. OpenJPA includes the following SavepointManager in-mem: The default. This is an alias for the - + org.apache.openjpa.kernel.InMemorySavepointManager. This plugin stores all state, including field values, in memory. Due to this behavior, each set savepoint is designed for small to medium transactional @@ -1083,7 +1083,7 @@ object counts. jdbc: This is an alias for the - + org.apache.openjpa.jdbc.kernel.JDBC3SavepointManager. This plugin requires JDBC 3 and java.sql.Savepoint support to operate. Note that this plugin implements savepoints by @@ -1244,7 +1244,7 @@ select p from Product p where p.price < ext:sql ('(SELECT AVG(PRICE) FROM PRO You can write your own extensions by implementing the - + org.apache.openjpa.jdbc.kernel.exps.JDBCFilterListener interface. View the Javadoc documentation for details. Additionally, the source for all of OpenJPA's built-in query extensions is included in your @@ -1293,7 +1293,7 @@ registration for very specific extensions that do not apply globally. See the OpenJPAQuery - + Javadoc for details. @@ -1315,7 +1315,7 @@ Javadoc for details. Just as you can write your own filter methods, you can write your own query aggregates by implementing the - + org.apache.openjpa.jdbc.kernel.exps.JDBCAggregateListener interface. View the Javadoc documentation for details. When using your custom aggregates in result or having query clauses, you can optionally prefix @@ -1361,7 +1361,7 @@ registration for very specific aggregates that do not apply globally. See the OpenJPAQuery - + Javadoc for details. @@ -1432,7 +1432,7 @@ import org.apache.openjpa.persistence.*; For datastore queries, the method must have the following signature: -public static ResultObjectProvider xxx(StoreContext ctx, ClassMetaData meta, boolean subclasses, Map params, FetchConfiguration fetch) +public static ResultObjectProvider xxx(StoreContext ctx, ClassMetaData meta, boolean subclasses, Map params, FetchConfiguration fetch) The returned result object provider should produce objects of the candidate @@ -1446,7 +1446,7 @@ In-memory execution is slightly different, taking in one object at a time and returning a boolean on whether the object matches the query: -public static boolean xxx(StoreContext ctx, ClassMetaData meta, boolean subclasses, Object obj, Map params, FetchConfiguration fetch) +public static boolean xxx(StoreContext ctx, ClassMetaData meta, boolean subclasses, Object obj, Map params, FetchConfiguration fetch) In both method versions, the given params map contains the @@ -1474,12 +1474,12 @@ generators to automatically populate identity fields in JPA. OpenJPA represents all generators internally with the - + org.apache.openjpa.kernel.Seq interface. This interface supplies all the context you need to create your own custom generators, including the current persistence environment, the JDBC DataSource , and other essentials. The - + org.apache.openjpa.jdbc.kernel.AbstractJDBCSeq helps you create custom JDBC-based sequences. OpenJPA also supplies the following built-in Seqs: @@ -1497,7 +1497,7 @@ following built-in Seqs: table: This is OpenJPA's default implementation. It is an alias for the - + org.apache.openjpa.jdbc.kernel.TableJDBCSeq class. The TableJDBCSeq uses a special single-row table to store a global sequence number. If the table does not already exist, it is @@ -1554,7 +1554,7 @@ requests. class-table: This is an alias for the - + org.apache.openjpa.jdbc.kernel.ClassTableJDBCSeq . This Seq is like the TableJDBCSeq above, but maintains a separate table row, and therefore a separate @@ -1597,7 +1597,7 @@ tool runs. However, you can manually manipulate the table through the class' value-table: This is an alias for the - + org.apache.openjpa.jdbc.kernel.ValueTableJDBCSeq . This Seq is like the ClassTableJDBCSeq above, but has an arbitrary number of rows for sequence values, @@ -1631,7 +1631,7 @@ tool runs. However, you can manually manipulate the table through the class' native: This is an alias for the - + org.apache.openjpa.jdbc.kernel.NativeJDBCSeq. Many databases have a concept of "native sequences" - a built-in mechanism for obtaining incrementing numbers. For example, in Oracle database, you can create a @@ -1681,7 +1681,7 @@ requests. time: This is an alias for the - + org.apache.openjpa.kernel.TimeSeededSeq. This type uses an in-memory static counter, initialized to the current time in milliseconds and monotonically incremented for each value requested. It is only @@ -1789,7 +1789,7 @@ public Generator getNamedGenerator(String name); The returned - + org.apache.openjpa.persistence.Generator is a facade over an internal OpenJPA Seq. @@ -1799,7 +1799,7 @@ retrieve the identity generator of any class, or the generator of any field. With these APIs, you do not have to know the generator name. Additionally, they allow you to access the implicit generator used by default for datastore identity classes. See the - + Javadoc for the OpenJPAEntityManager.getIdentityGenerator and OpenJPAEntityManager.getFieldGenerator methods for API details. @@ -1821,7 +1821,7 @@ Javadoc for the OpenJPAEntityManager.getIdentityGenerator The OpenJPA runtime supports broadcasting transaction-related events. By registering one or more - + org.apache.openjpa.event.TransactionListener s, you can receive notifications when transactions begin, flush, rollback, commit, and more. Where appropriate, event notifications include the set of @@ -1838,7 +1838,7 @@ and remove listeners. These methods are outside the bounds of the published Open For details on the transaction framework, see the org.apache.openjpa.event package -Javadoc. +Javadoc. Also see for a description of OpenJPA's remote event support. @@ -1850,11 +1850,11 @@ remote event support. It is possible to adapt OpenJPA to access a non-relational datastore by creating an implementation of the - + org.apache.openjpa.kernel.StoreManager interface. OpenJPA provides an abstract StoreManager implementation to facilitate this process. See the org.apache.openjpa.abstractstore - package + package Javadoc for details. diff --git a/openjpa-project/src/doc/manual/ref_guide_slice.xml b/openjpa-project/src/doc/manual/ref_guide_slice.xml index 7d78171fc..ac63ed462 100644 --- a/openjpa-project/src/doc/manual/ref_guide_slice.xml +++ b/openjpa-project/src/doc/manual/ref_guide_slice.xml @@ -502,7 +502,7 @@ the JDBC connection URL of a slice. This mandatory plug-in property determines how newly persistent instances are distributed across individual slices. The value of this property is a fully-qualified class name that implements - + org.apache.openjpa.slice.DistributionPolicy interface.