## 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.configuration |
  org.apache.cayenne.configuration.xml |
  org.apache.cayenne.dba | Contains database adapter API (DbAdapter) and its default implementation.
  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.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 | Description
    --- | --- | ---
    `protected DataMap` | DbGenerator.`map` |

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

    Methods in org.apache.cayenne.access that return DataMap
    Modifier and Type | Method | Description
    --- | --- | ---
    `DataMap` | DataDomain.`getDataMap​(String mapName)` |
    `DataMap` | DataNode.`getDataMap​(String name)` | Returns datamap with specified name, null if none present

    Methods in org.apache.cayenne.access that return types with arguments of type DataMap
    Modifier and Type | Method | 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 | Description
    --- | --- | ---
    `void` | DataDomain.`addDataMap​(DataMap dataMap)` |
    `void` | DataNode.`addDataMap​(DataMap map)` | Adds a DataMap to be handled by this node.
    `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 | Description
    --- | --- | ---
    `void` | DataNode.`setDataMaps​(Collection<DataMap> dataMaps)` |

    Constructors in org.apache.cayenne.access with parameters of type DataMap
    Constructor | Description
    --- | ---
    `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.configuration

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

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

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

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

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

    Methods in org.apache.cayenne.configuration.xml that return DataMap
    Modifier and Type | Method | Description
    --- | --- | ---
    `DataMap` | DataMapHandler.`getDataMap()` |
    `DataMap` | XMLDataMapLoader.`load​(Resource configurationResource)` |

    Methods in org.apache.cayenne.configuration.xml with parameters of type DataMap
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | LoaderContext.`dataMapLoaded​(DataMap dataMap)` |
    `void` | DataMapLoaderListener.`onDataMapLoaded​(DataMap dataMap)` |

    Constructors in org.apache.cayenne.configuration.xml with parameters of type DataMap
    Constructor | Description
    --- | ---
    `DbEntityHandler​(NamespaceAwareNestedTagHandler parentHandler, DataMap dataMap)` |
    `DbRelationshipHandler​(NamespaceAwareNestedTagHandler parentHandler, DataMap map)` |
    `EmbeddableHandler​(NamespaceAwareNestedTagHandler parentHandler, DataMap map)` |
    `ObjEntityHandler​(NamespaceAwareNestedTagHandler parentHandler, DataMap map)` |
    `ObjRelationshipHandler​(NamespaceAwareNestedTagHandler parentHandler, DataMap map)` |
    `ProcedureHandler​(NamespaceAwareNestedTagHandler parentHandler, DataMap map)` |
    `QueryDescriptorHandler​(NamespaceAwareNestedTagHandler parentHandler, DataMap map)` |

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

    Methods in org.apache.cayenne.dba with parameters of type DataMap
    Modifier and Type | Method | Description
    --- | --- | ---
    `String` | DefaultQuotingStrategy.`quotedIdentifier​(DataMap dataMap, String... identifierParts)` |
    `String` | QuotingStrategy.`quotedIdentifier​(DataMap dataMap, String... identifierParts)` |

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

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

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

    Methods in org.apache.cayenne.map that return DataMap
    Modifier and Type | Method | 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` | EntityResolver.`getDataMap​(String mapName)` | Returns a DataMap matching the name.
    `DataMap` | Procedure.`getDataMap()` |
    `DataMap` | QueryDescriptor.`getDataMap()` |

    Methods in org.apache.cayenne.map that return types with arguments of type DataMap
    Modifier and Type | Method | 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 | 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.
    `void` | QueryDescriptor.`setDataMap​(DataMap dataMap)` |
    `void` | QueryDescriptorLoader.`setRoot​(DataMap dataMap, String rootType, String rootName)` | Sets the information pertaining to the root of the query.

    Method parameters in org.apache.cayenne.map with type arguments of type DataMap
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | EntityResolver.`setDataMaps​(Collection<DataMap> maps)` |

    Constructor parameters in org.apache.cayenne.map with type arguments of type DataMap
    Constructor | Description
    --- | ---
    `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 | 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.query

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

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

    Methods in org.apache.cayenne.query with parameters of type DataMap
    Modifier and Type | Method | Description
    --- | --- | ---
    `QueryEngine` | QueryRouter.`engineForDataMap​(DataMap map)` | Returns a QueryEngine that is configured to handle a given DataMap.

    Constructors in org.apache.cayenne.query with parameters of type DataMap
    Constructor | Description
    --- | ---
    `SQLTemplate​(DataMap rootMap, String defaultTemplate, boolean isFetchingDataRows)` |

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

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