## Uses of Class
org.apache.cayenne.map.DataMap

- Packages that use DataMap
  Package | Description
  --- | ---
  org.apache.cayenne.access | Contains classes that make up Cayenne ORM stack.
  org.apache.cayenne.access.trans | Provides translators for Cayenne queries.
  org.apache.cayenne.ashwood |
  org.apache.cayenne.configuration |
  org.apache.cayenne.map | Contains O/R mapping classes that store relational database metadata information and map it to Java classes.
  org.apache.cayenne.map.event |
  org.apache.cayenne.merge |
  org.apache.cayenne.query | Defines standard queries supported by Cayenne and extension mechanism to create custom queries.
  org.apache.cayenne.util | General utility classes.

- - ### Uses of DataMap in org.apache.cayenne.access

    Fields in org.apache.cayenne.access declared as DataMap
    Modifier and Type | Field and Description
    --- | ---
    `protected DataMap` | DbGenerator.`map`

    Fields in org.apache.cayenne.access with type parameters of type DataMap
    Modifier and Type | Field and Description
    --- | ---
    `protected Map<String,DataMap>` | DataNode.`dataMaps`

    Methods in org.apache.cayenne.access that return DataMap
    Modifier and Type | Method and Description
    --- | ---
    `DataMap` | DataDomain.`getDataMap(String mapName)`
    `DataMap` | DataNode.`getDataMap(String name)` Returns datamap with specified name, null if none present
    `DataMap` | DataDomain.`getMap(String mapName)` Deprecated. since 3.1 use a more consistently named `DataDomain.getDataMap(String)`.
    `DataMap` | DbLoader.`loadDataMapFromDB(String schemaName, String tablePattern, DataMap dataMap)` Performs database reverse engineering and generates DataMap that contains default mapping of the tables and views.
    `DataMap` | DbLoader.`loadDataMapFromDB(String schemaName, String tablePattern, String[] tableTypes, DataMap dataMap)` Performs database reverse engineering and generates DataMap object that contains default mapping of the tables and views.

    Methods in org.apache.cayenne.access that return types with arguments of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `Collection<DataMap>` | DataDomain.`getDataMaps()` Returns a collection of registered DataMaps.
    `Collection<DataMap>` | DataNode.`getDataMaps()` Returns an unmodifiable collection of DataMaps handled by this DataNode.

    Methods in org.apache.cayenne.access with parameters of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `void` | DataDomain.`addDataMap(DataMap dataMap)`
    `void` | DataNode.`addDataMap(DataMap map)` Adds a DataMap to be handled by this node.
    `void` | DataDomain.`addMap(DataMap map)` Deprecated. since 3.1 use a more consistently named `DataDomain.addDataMap(DataMap)`.
    `DataMap` | DbLoader.`loadDataMapFromDB(String schemaName, String tablePattern, DataMap dataMap)` Performs database reverse engineering and generates DataMap that contains default mapping of the tables and views.
    `DataMap` | DbLoader.`loadDataMapFromDB(String schemaName, String tablePattern, String[] tableTypes, DataMap dataMap)` Performs database reverse engineering and generates DataMap object that contains default mapping of the tables and views.
    `boolean` | DbLoader.`loadDbEntities(DataMap map, List<? extends DbEntity> tables)` Loads dbEntities for the specified tables.
    `void` | DbLoader.`loadDbRelationships(DataMap map)` Loads database relationships into a DataMap.
    `void` | DbLoader.`loadObjEntities(DataMap map)` Creates an ObjEntity for each DbEntity in the map.
    `void` | DbLoader.`loadProceduresFromDB(String schemaPattern, String namePattern, DataMap dataMap)` Loads database stored procedures into the DataMap.
    `DataNode` | DataDomain.`lookupDataNode(DataMap map)` Returns a DataNode that should handle queries for all entities in a DataMap.
    `DataNode` | DataNode.`lookupDataNode(DataMap dataMap)` Returns a DataNode that should handle queries for all DataMap components.
    `void` | DataNode.`removeDataMap(DataMap map)`

    Method parameters in org.apache.cayenne.access with type arguments of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `void` | DataNode.`setDataMaps(Collection<DataMap> dataMaps)`

    Constructors in org.apache.cayenne.access with parameters of type DataMap
    Constructor and Description
    `DbGenerator(DbAdapter adapter, DataMap map)` Deprecated. since 3.1 use `DbGenerator.DbGenerator(DbAdapter, DataMap, JdbcEventLogger)`
    `DbGenerator(DbAdapter adapter, DataMap map, Collection<DbEntity> excludedEntities)` Deprecated. since 3.1 use `DbGenerator.DbGenerator(DbAdapter, DataMap, Collection, DataDomain, JdbcEventLogger)`
    `DbGenerator(DbAdapter adapter, DataMap map, Collection<DbEntity> excludedEntities, DataDomain domain, JdbcEventLogger logger)` Creates and initializes new DbGenerator instance.
    `DbGenerator(DbAdapter adapter, DataMap map, JdbcEventLogger logger)`
    `DbGenerator(DbAdapter adapter, DataMap map, JdbcEventLogger logger, Collection<DbEntity> excludedEntities)`

  - ### Uses of DataMap in org.apache.cayenne.access.trans

    Constructors in org.apache.cayenne.access.trans with parameters of type DataMap
    Constructor and Description
    `JoinStack(DbAdapter dbAdapter, DataMap dataMap, QueryAssembler assembler)`

  - ### Uses of DataMap in org.apache.cayenne.ashwood

    Method parameters in org.apache.cayenne.ashwood with type arguments of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `void` | AshwoodEntitySorter.`setDataMaps(Collection<DataMap> dataMaps)` Deprecated. since 3.1, `AshwoodEntitySorter.setEntityResolver(EntityResolver)` is used instead.

    Constructor parameters in org.apache.cayenne.ashwood with type arguments of type DataMap
    Constructor and Description
    `AshwoodEntitySorter(Collection<DataMap> dataMaps)` Deprecated. since 3.1. Use `AshwoodEntitySorter.AshwoodEntitySorter()` constructor together with `AshwoodEntitySorter.setDataMaps(Collection)` instead.

  - ### Uses of DataMap in org.apache.cayenne.configuration

    Fields in org.apache.cayenne.configuration with type parameters of type DataMap
    Modifier and Type | Field and Description
    --- | ---
    `protected Collection<DataMap>` | DataChannelDescriptor.`dataMaps`

    Methods in org.apache.cayenne.configuration that return DataMap
    Modifier and Type | Method and Description
    --- | ---
    `DataMap` | DataChannelDescriptor.`getDataMap(String name)`
    `DataMap` | DataMapLoader.`load(Resource configurationResource)`
    `DataMap` | XMLDataMapLoader.`load(Resource configurationResource)`

    Methods in org.apache.cayenne.configuration that return types with arguments of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `Collection<DataMap>` | DataChannelDescriptor.`getDataMaps()`

    Methods in org.apache.cayenne.configuration with parameters of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `T` | BaseConfigurationNodeVisitor.`visitDataMap(DataMap dataMap)`
    `T` | ConfigurationNodeVisitor.`visitDataMap(DataMap dataMap)`

  - ### Uses of DataMap in org.apache.cayenne.map

    Fields in org.apache.cayenne.map declared as DataMap
    Modifier and Type | Field and Description
    --- | ---
    `protected DataMap` | Embeddable.`dataMap`
    `protected DataMap` | Entity.`dataMap`
    `protected DataMap` | Procedure.`dataMap`

    Fields in org.apache.cayenne.map with type parameters of type DataMap
    Modifier and Type | Field and Description
    --- | ---
    `protected Collection<DataMap>` | EntityResolver.`maps`

    Methods in org.apache.cayenne.map that return DataMap
    Modifier and Type | Method and Description
    --- | ---
    `DataMap` | DataMap.`getClientDataMap(EntityResolver serverResolver)` Returns a DataMap stripped of any server-side information, such as DbEntity mapping, or ObjEntities that are not allowed in the client tier.
    `DataMap` | Embeddable.`getDataMap()`
    `DataMap` | Entity.`getDataMap()`
    `DataMap` | Procedure.`getDataMap()`
    `DataMap` | EntityResolver.`getDataMap(String mapName)` Returns a DataMap matching the name.
    `DataMap` | MapLoader.`loadDataMap(InputSource src)` Loads a DataMap from XML input source.
    `DataMap` | MapLoader.`loadDataMap(String uri)` Deprecated. since 3.1 `MapLoader.loadDataMap(InputSource)` should be used.

    Methods in org.apache.cayenne.map that return types with arguments of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `Collection<DataMap>` | EntityResolver.`getDataMaps()` Returns an unmodifiable collection of DataMaps.

    Methods in org.apache.cayenne.map with parameters of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `void` | EntityResolver.`addDataMap(DataMap map)`
    `int` | DataMap.`compareTo(DataMap o)`
    `void` | DataMap.`mergeWithDataMap(DataMap map)` Adds all Object and DB entities and Queries from another map to this map.
    `void` | EntityResolver.`removeDataMap(DataMap map)`
    `void` | Embeddable.`setDataMap(DataMap dataMap)`
    `void` | Entity.`setDataMap(DataMap dataMap)` Sets parent DataMap of this entity.
    `void` | Procedure.`setDataMap(DataMap dataMap)` Sets parent DataMap of this entity.

    Method parameters in org.apache.cayenne.map with type arguments of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `void` | EntityResolver.`setDataMaps(Collection<DataMap> maps)`
    `void` | EntitySorter.`setDataMaps(Collection<DataMap> dataMaps)` Deprecated. since 3.1 `EntitySorter.setEntityResolver(EntityResolver)` is used, and this method is never called.

    Constructor parameters in org.apache.cayenne.map with type arguments of type DataMap
    Constructor and Description
    `AshwoodEntitySorter(Collection<DataMap> dataMaps)` Deprecated.
    `EntityResolver(Collection<DataMap> dataMaps)` Creates new EntityResolver that indexes a collection of DataMaps.

  - ### Uses of DataMap in org.apache.cayenne.map.event

    Methods in org.apache.cayenne.map.event with parameters of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `void` | EmbeddableListener.`embeddableAdded(EmbeddableEvent e, DataMap map)` New EmbeddableAttribute has been created/added.
    `void` | EmbeddableListener.`embeddableChanged(EmbeddableEvent e, DataMap map)` EmbeddableAttribute property changed.
    `void` | EmbeddableListener.`embeddableRemoved(EmbeddableEvent e, DataMap map)` EmbeddableAttribute has been removed.

  - ### Uses of DataMap in org.apache.cayenne.merge

    Methods in org.apache.cayenne.merge that return DataMap
    Modifier and Type | Method and Description
    --- | ---
    `DataMap` | ExecutingMergerContext.`getDataMap()`
    `DataMap` | MergerContext.`getDataMap()`

    Methods in org.apache.cayenne.merge with parameters of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `List<MergerToken>` | DbMerger.`createMergeTokens(DataNode dataNode, DataMap dataMap)` Create and return a `List` of `MergerToken`s to alter the given `DataNode` to match the given `DataMap`
    `List<MergerToken>` | DbMerger.`createMergeTokens(DbAdapter adapter, DataSource dataSource, DataMap dataMap)` Create and return a `List` of `MergerToken`s to alter the given `DataNode` to match the given `DataMap`

    Constructors in org.apache.cayenne.merge with parameters of type DataMap
    Constructor and Description
    `ExecutingMergerContext(DataMap map, DataNode node)`
    `ExecutingMergerContext(DataMap map, DataSource dataSource, JdbcAdapter adapter, ModelMergeDelegate delegate)`

  - ### Uses of DataMap in org.apache.cayenne.query

    Fields in org.apache.cayenne.query declared as DataMap
    Modifier and Type | Field and Description
    --- | ---
    `protected DataMap` | AbstractQuery.`dataMap`
    `protected DataMap` | BatchQuery.`dataMap`
    `protected DataMap` | EJBQLQuery.`dataMap`
    `protected DataMap` | IndirectQuery.`dataMap`
    `protected DataMap` | QueryChain.`dataMap`

    Methods in org.apache.cayenne.query that return DataMap
    Modifier and Type | Method and Description
    --- | ---
    `DataMap` | AbstractQuery.`getDataMap()`
    `DataMap` | BatchQuery.`getDataMap()`
    `DataMap` | EJBQLQuery.`getDataMap()`
    `DataMap` | IndirectQuery.`getDataMap()`
    `DataMap` | Query.`getDataMap()`
    `DataMap` | QueryChain.`getDataMap()`
    `DataMap` | QueryMetadata.`getDataMap()` Returns a DataMap associated with a query or null if no such DataMap exists.
    `DataMap` | RefreshQuery.`getDataMap()`

    Methods in org.apache.cayenne.query with parameters of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `QueryEngine` | QueryRouter.`engineForDataMap(DataMap map)` Returns a QueryEngine that is configured to handle a given DataMap.
    `void` | AbstractQuery.`setDataMap(DataMap dataMap)`
    `void` | BatchQuery.`setDataMap(DataMap dataMap)`
    `void` | EJBQLQuery.`setDataMap(DataMap dataMap)`
    `void` | IndirectQuery.`setDataMap(DataMap dataMap)`
    `void` | QueryChain.`setDataMap(DataMap dataMap)`

    Constructors in org.apache.cayenne.query with parameters of type DataMap
    Constructor and Description
    `SQLTemplate(DataMap rootMap, String defaultTemplate)` Deprecated. since 3.1, use SQLTemplate(DataMap rootMap, String defaultTemplate, boolean isFetchingDataRows) instead
    `SQLTemplate(DataMap rootMap, String defaultTemplate, boolean isFetchingDataRows)`

  - ### Uses of DataMap in org.apache.cayenne.util

    Fields in org.apache.cayenne.util declared as DataMap
    Modifier and Type | Field and Description
    --- | ---
    `protected DataMap` | EntityMergeSupport.`map`

    Methods in org.apache.cayenne.util that return DataMap
    Modifier and Type | Method and Description
    --- | ---
    `DataMap` | EntityMergeSupport.`getMap()`

    Methods in org.apache.cayenne.util with parameters of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `void` | EntityMergeSupport.`setMap(DataMap map)`
    `static void` | DeleteRuleUpdater.`updateDataMap(DataMap map)` Updates delete rules for all obj entities in a datamap

    Method parameters in org.apache.cayenne.util with type arguments of type DataMap
    Modifier and Type | Method and Description
    --- | ---
    `static Object` | NamedObjectFactory.`createObject(Class<? extends DataMap> objectClass, Object namingContext, String nameBase)`

    Constructors in org.apache.cayenne.util with parameters of type DataMap
    Constructor and Description
    `EntityMergeSupport(DataMap map)`
    `EntityMergeSupport(DataMap map, NamingStrategy namingStrategy, boolean removeMeaningfulPKs)`

Copyright © 2001–2018 Apache Cayenne. All rights reserved.