Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Interfaces

Interface and Description
org.apache.cayenne.dba.DbAdapterFactory since 3.1 in favor of DbAdapterFactory configured via dependency injection.
org.apache.cayenne.cache.QueryCacheFactory since 3.1 QueryCacheFactory is unused and replaced by corresponding Provider implementation for various types of QueryCache.
org.apache.cayenne.conf.ResourceFinder since 3.1 deprecated in favor of injectable org.apache.cayenne.resource.ResourceLocator.
org.apache.cayenne.xml.XMLSerializable since 3.1 this XML serialization package is deprecated and will be removed in the following releases. It has a number of functional and performance limitations that make it impossible to evolve further. A replacement may be provided in an undefined future. For now we recommend the users to implement XML serialization of persistent objects based JAXB, XStream or other similar frameworks.

Deprecated Classes

Class and Description
org.apache.cayenne.map.AshwoodEntitySorter since 3.1 moved to "org.apache.cayenne.ashwood" package.
org.apache.cayenne.conn.ContainerPoolFactory since 3.1. This class does not belong in Cayenne, as Cayenne no longer attempts to provide appserver pieces. End users should not need this class and should use their container's preferred approach to map a DataSource instead.
org.apache.cayenne.DataObjectUtils since 3.1 Cayenne class is used instead
org.apache.cayenne.remote.hessian.service.HessianServlet since 3.1 use ROPHessianServlet.
org.apache.cayenne.cache.MapQueryCacheFactory since 3.1 MapQueryCacheFactory and QueryCacheFactory are unused. Analog of MapQueryCacheFactory is DI-friendly MapQueryCacheProvider.
org.apache.cayenne.cache.OSQueryCacheFactory since 3.1 OSQueryCacheFactory and QueryCacheFactory are unused.
org.apache.cayenne.access.QueryLogger since 3.1 replaced by injectable JdbcEventLogger.
org.apache.cayenne.util.ResourceLocator since 3.1 deprecated in favor of injectable org.apache.cayenne.resource.ResourceLocator.
org.apache.cayenne.conf.WebApplicationContextFilter since 3.0 CayenneFilter should be used.
org.apache.cayenne.xml.XMLDecoder since 3.1 this XML serialization package is deprecated and will be removed in the following releases. It has a number of functional and performance limitations that make it impossible to evolve further. A replacement may be provided in an undefined future. For now we recommend the users to implement XML serialization of persistent objects based JAXB, XStream or other similar frameworks.
org.apache.cayenne.xml.XMLEncoder since 3.1 this XML serialization package is deprecated and will be removed in the following releases. It has a number of functional and performance limitations that make it impossible to evolve further. A replacement may be provided in an undefined future. For now we recommend the users to implement XML serialization of persistent objects based JAXB, XStream or other similar frameworks.
org.apache.cayenne.util.ZipUtil since 3.1. This class is unused and will be removed in the future versions..

Deprecated Fields

Field and Description
org.apache.cayenne.query.PrefetchSelectQuery.parentQuery since 3.1 unused

Deprecated Methods

Method and Description
org.apache.cayenne.access.DataDomain.addMap(DataMap) since 3.1 use a more consistently named DataDomain.addDataMap(DataMap).
org.apache.cayenne.access.DataDomain.clearDataMaps() since 3.1 unused and unneeded
org.apache.cayenne.util.Util.copy(File, File) since 3.1 this method is not used by Cayenne
org.apache.cayenne.util.Util.copy(URL, File) since 3.1 this method is not used by Cayenne.
org.apache.cayenne.util.Util.copyPipe(InputStream, OutputStream, int) since 3.1 this method is unused by Cayenne.
org.apache.cayenne.access.DataContext.createChildContext() Since 3.1 replaced by CayenneRuntime.getContext(DataChannel)
org.apache.cayenne.CayenneContext.createChildContext() Since 3.1 replaced by CayenneRuntime.getContext(DataChannel)
org.apache.cayenne.ObjectContext.createChildContext() Since 3.1 replaced by CayenneRuntime.getContext(DataChannel)
org.apache.cayenne.access.DataDomain.createDataContext() since 3.1 as context creation is done via ObjectContextFactory and injection.
org.apache.cayenne.access.DataDomain.createDataContext(boolean) since 3.1 as context creation is done via ObjectContextFactory and injection.
org.apache.cayenne.map.MapLoader.createResourceFinder() since 3.1 as MapLoader should not bother itself with looking up resources.
org.apache.cayenne.CayenneDataObject.decodeFromXML(XMLDecoder) since 3.1 XML serialization package is deprecated and will be removed in the following releases. It has a number of functional and performance limitations that make it impossible to evolve further. A replacement may be provided in an undefined future. For now we recommend the users to implement XML serialization of persistent objects based JAXB, XStream or other similar frameworks.
org.apache.cayenne.util.Util.delete(String, boolean) since 3.1 this method is unused by Cayenne.
org.apache.cayenne.conn.PoolManager.dispose() since 3.1 replaced with PoolManager.shutdown() method for naming consistency.
org.apache.cayenne.map.DataMap.encodeAsXML(PrintWriter) since 3.1, as XMLSerializable objects should only save XML segments. Saving full XML files is responsibilty of the callers.
org.apache.cayenne.CayenneDataObject.encodeAsXML(XMLEncoder) since 3.1 XML serialization package is deprecated and will be removed in the following releases. It has a number of functional and performance limitations that make it impossible to evolve further. A replacement may be provided in an undefined future. For now we recommend the users to implement XML serialization of persistent objects based JAXB, XStream or other similar frameworks.
org.apache.cayenne.ejbql.parser.JavaCharStream.getColumn()
org.apache.cayenne.exp.parser.JavaCharStream.getColumn()
org.apache.cayenne.access.jdbc.ColumnDescriptor.getDefaultJavaClass(int, int) use TypesMapping.getJavaBySqlType(int type) instead
org.apache.cayenne.dba.TypesMapping.getJavaBySqlType(int, int, int) since 3.0. use getJavaBySqlType(int) instead. Not usable since "0" can mean "undefined", not really zero.
org.apache.cayenne.ejbql.parser.JavaCharStream.getLine()
org.apache.cayenne.exp.parser.JavaCharStream.getLine()
org.apache.cayenne.access.DataDomain.getMap(String) since 3.1 use a more consistently named DataDomain.getDataMap(String).
org.apache.cayenne.access.DataDomain.getNode(String) since 3.1, use a more consistently named DataDomain.getDataNode(String).
org.apache.cayenne.PersistentObject.getObjEntity() since 3.1 Cayenne.getObjEntity(Persistent) is used
org.apache.cayenne.query.PrefetchSelectQuery.getParentQuery() since 3.1
org.apache.cayenne.access.DataDomain.getQueryBuilderFactory() since 3.1 BatchQueryBuilderFactory is injected into JdbcAdapter.
org.apache.cayenne.map.MapLoader.loadDataMap(String) since 3.1 MapLoader.loadDataMap(InputSource) should be used.
org.apache.cayenne.BaseContext.localObject(ObjectId, Object) since 3.1 Cayenne users should use BaseContext.localObject(Object); the internal code has been refactored to avoid using this method all together.
org.apache.cayenne.ObjectContext.localObject(ObjectId, Object) since 3.1 Cayenne users should use ObjectContext.localObject(Object); the internal code has been refactored to avoid using this method all together.
org.apache.cayenne.map.EntityResolver.lookupInheritanceTree(ObjEntity) since 3.1 use EntityResolver.lookupInheritanceTree(String).
org.apache.cayenne.util.DeepMergeOperation.merge(Object, ClassDescriptor) since 3.1 use DeepMergeOperation.merge(Persistent).
org.apache.cayenne.access.DataContext.objectFromDataRow(Class, DataRow, boolean) Use objectFromDataRow(Class objectClass, DataRow dataRow) instead.
org.apache.cayenne.access.DataContext.objectFromDataRow(String, DataRow, boolean) Use objectFromDataRow(String entityName, DataRow dataRow) instead.
org.apache.cayenne.access.DataDomain.reindexNodes() since 3.1 - unneeded and unused.
org.apache.cayenne.access.DataDomain.removeMap(String) since 3.1 use a more consistently named DataDomain.removeDataMap(String).
org.apache.cayenne.access.DataDomain.reset() since 3.1 unused and unneeded
org.apache.cayenne.util.DeepMergeOperation.reset() since 3.1 - unused as the object is now stateless
org.apache.cayenne.ashwood.AshwoodEntitySorter.setDataMaps(Collection) since 3.1, AshwoodEntitySorter.setEntityResolver(EntityResolver) is used instead.
org.apache.cayenne.map.EntitySorter.setDataMaps(Collection) since 3.1 EntitySorter.setEntityResolver(EntityResolver) is used, and this method is never called.
org.apache.cayenne.query.PrefetchSelectQuery.setParentQuery(SelectQuery) since 3.1
org.apache.cayenne.access.DataDomain.setQueryBuilderFactory(BatchQueryBuilderFactory) since 3.1 BatchQueryBuilderFactory is injected into JdbcAdapter.
org.apache.cayenne.access.DataNode.shutdown() since 3.1 does nothing as pool shutdown is performed by the DI container.
org.apache.cayenne.util.Util.stripLineBreaks(String, String) since 3.1 in favor of Util.stripLineBreaks(String, char).

Deprecated Constructors

Constructor and Description
org.apache.cayenne.ashwood.AshwoodEntitySorter(Collection) since 3.1. Use AshwoodEntitySorter.AshwoodEntitySorter() constructor together with AshwoodEntitySorter.setDataMaps(Collection) instead.
org.apache.cayenne.access.trans.BatchQueryBuilder() since 3.1 unused
org.apache.cayenne.remote.ClientChannel(ClientConnection) since 3.1 use ClientChannel.ClientChannel(ClientConnection, boolean, EventManager, boolean)
org.apache.cayenne.remote.ClientChannel(ClientConnection, boolean) since 3.1 use ClientChannel.ClientChannel(ClientConnection, boolean, EventManager, boolean)
org.apache.cayenne.remote.ClientChannel(ClientConnection, boolean, EventManager) since 3.1 use ClientChannel.ClientChannel(ClientConnection, boolean, EventManager, boolean)
org.apache.cayenne.access.ClientServerChannel(DataDomain) since 3.1 as context creation is now factory based.
org.apache.cayenne.access.jdbc.ColumnDescriptor(String, int, String) since 3.1 use ColumnDescriptor(String columnName, int jdbcType) instead
org.apache.cayenne.access.DbGenerator(DbAdapter, DataMap) since 3.1 use DbGenerator.DbGenerator(DbAdapter, DataMap, JdbcEventLogger)
org.apache.cayenne.access.DbGenerator(DbAdapter, DataMap, Collection) since 3.1 use DbGenerator.DbGenerator(DbAdapter, DataMap, Collection, DataDomain, JdbcEventLogger)
org.apache.cayenne.access.IncrementalFaultList(DataContext, Query) since 3.1 use IncrementalFaultList.IncrementalFaultList(DataContext, Query, int).
org.apache.cayenne.access.ObjectStore() since 3.1
org.apache.cayenne.access.ObjectStore(DataRowStore) since 3.1
org.apache.cayenne.query.PrefetchSelectQuery(SelectQuery, String, ObjRelationship) Since 3.1 use another constructor without parentQuery parameter instead.
org.apache.cayenne.query.SQLTemplate(DataMap, String) since 3.1, use SQLTemplate(DataMap rootMap, String defaultTemplate, boolean isFetchingDataRows) instead