public interface

Mappings

org.hibernate.cfg.Mappings
Known Indirect Subclasses

Class Overview

A collection of mappings from classes and collections to relational database tables. Represents a single <hibernate-mapping> element.

todo : the statement about this representing a single mapping element is simply not true if it was ever the case. this contract actually represents 3 scopes of information:

  1. bounded state : this is information which is indeed scoped by a single mapping
  2. unbounded state : this is information which is Configuration wide (think of metadata repository)
  3. transient state : state which changed at its own pace (naming strategy)

Summary

Nested Classes
class Mappings.PropertyReference Represents a property-ref mapping. 
Public Methods
abstract void addAnyMetaDef(AnyMetaDef defAnn)
abstract void addAuxiliaryDatabaseObject(AuxiliaryDatabaseObject auxiliaryDatabaseObject)
Add metadata pertaining to an auxiliary database object to this repository.
abstract void addClass(PersistentClass persistentClass)
Add entity mapping metadata.
abstract AnnotatedClassType addClassType(XClass clazz)
FIXME should be private but will this break things? Add a class type.
abstract void addCollection(Collection collection)
Add collection mapping metadata to this repository.
abstract void addColumnBinding(String logicalName, Column physicalColumn, Table table)
Binds the given 'physicalColumn' to the give 'logicalName' within the given 'table'.
abstract void addDefaultGenerator(IdGenerator generator)
Adds a default id generator.
abstract void addDefaultQuery(String name, NamedQueryDefinition query)
abstract void addDefaultResultSetMapping(ResultSetMappingDefinition definition)
abstract void addDefaultSQLQuery(String name, NamedSQLQueryDefinition query)
abstract Table addDenormalizedTable(String schema, String catalog, String name, boolean isAbstract, String subselect, Table includedTable)
Adds a 'denormalized table' to this repository.
abstract void addFilterDefinition(FilterDefinition definition)
Adds a filter definition to this repository.
abstract void addGenerator(IdGenerator generator)
Add a generator.
abstract void addGeneratorTable(String name, Properties params)
Add a generator table properties.
abstract void addImport(String entityName, String rename)
Adds an import (HQL entity rename) to the repository.
abstract void addJoins(PersistentClass persistentClass, Map<String, Join> joins)
Add join metadata for a persistent entity.
abstract void addMappedBy(String entityName, String propertyName, String inversePropertyName)
abstract void addMappedSuperclass(Class type, MappedSuperclass mappedSuperclass)
add a new MappedSuperclass This should not be called if the MappedSuperclass already exists (it would be erased)
abstract void addPropertyAnnotatedWithMapsId(XClass entityType, PropertyData property)
abstract void addPropertyAnnotatedWithMapsIdSpecj(XClass entityType, PropertyData property, String mapsIdValue)
abstract void addPropertyReference(String referencedClass, String propertyName)
Adds a property reference binding to this repository.
abstract void addPropertyReferencedAssociation(String entityName, String propertyName, String propertyRef)
abstract void addQuery(String name, NamedQueryDefinition query)
Adds metadata for a named query to this repository.
abstract void addResultSetMapping(ResultSetMappingDefinition sqlResultSetMapping)
Adds the metadata for a named SQL result set mapping to this repository.
abstract void addSQLQuery(String name, NamedSQLQueryDefinition query)
Adds metadata for a named SQL query to this repository.
abstract void addSecondPass(SecondPass sp)
Adds a second-pass to the end of the current queue.
abstract void addSecondPass(SecondPass sp, boolean onTopOfTheQueue)
Adds a second pass.
abstract Table addTable(String schema, String catalog, String name, String subselect, boolean isAbstract)
Adds table metadata to this repository returning the created metadata instance.
abstract void addTableBinding(String schema, String catalog, String logicalName, String physicalName, Table denormalizedSuperTable)
Adds a table binding to this repository.
abstract void addToExtendsQueue(ExtendsQueueEntry entry)
Adds an entry to the extends queue queue.
abstract void addToOneAndIdProperty(XClass entity, PropertyData property)
abstract void addTypeDef(String typeName, String typeClass, Properties paramMap)
Adds a type definition to this metadata repository.
abstract void addUniqueConstraintHolders(Table table, List<UniqueConstraintHolder> uniqueConstraintHolders)
abstract void addUniqueConstraints(Table table, List uniqueConstraints)
This method is deprecated. Use addUniqueConstraintHolders(Table, List) instead
abstract void addUniquePropertyReference(String referencedClass, String propertyName)
Adds a property reference binding to this repository where said proeprty reference is marked as unique.
abstract FetchProfile findOrCreateFetchProfile(String name, MetadataSource source)
Retrieves a fetch profile by either finding one currently in this repository matching the given name or by creating one (and adding it).
abstract AnyMetaDef getAnyMetaDef(String name)
abstract String getCatalogName()
Returns the currently bound default catalog name.
abstract PersistentClass getClass(String entityName)
Retrieves the entity mapping metadata for the given entity name.
abstract AnnotatedClassType getClassType(XClass clazz)
Get and maintain a cache of class type.
abstract Map getClasses()
abstract Collection getCollection(String role)
Retrieves the collection mapping metadata for the given collection role.
abstract Properties getConfigurationProperties()
Retrieve the configuration properties currently in effect.
abstract String getDefaultAccess()
Get the current default property access style.
abstract String getDefaultCascade()
Get the current default cascade style.
abstract String getDefaultPackage()
Get the currently bound default package name.
abstract FilterDefinition getFilterDefinition(String name)
Retrieves a filter definition by name.
abstract Map getFilterDefinitions()
Retrieves the copmplete map of filter definitions.
abstract String getFromMappedBy(String entityName, String propertyName)
abstract IdGenerator getGenerator(String name, Map<String, IdGenerator> localGenerators)
Try to find the generator from the localGenerators and then from the global generator list
abstract IdGenerator getGenerator(String name)
Retrieve the id-generator by name.
abstract Properties getGeneratorTableProperties(String name, Map<String, Properties> localGeneratorTables)
Retrieve the properties related to a generator table.
abstract DefaultIdentifierGeneratorFactory getIdentifierGeneratorFactory()
Retrieve the IdentifierGeneratorFactory in effect for this mapping.
abstract Map<String, Join> getJoins(String entityName)
Retrieve join metadata for a particular persistent entity.
abstract String getLogicalColumnName(String physicalName, Table table)
Find the logical column name against whcih the given physical column name was bound within the given table.
abstract String getLogicalTableName(Table table)
Get the logical table name mapped for the given physical table.
abstract MappedSuperclass getMappedSuperclass(Class type)
Get a MappedSuperclass or null if not mapped
abstract NamingStrategy getNamingStrategy()
Get the current naming strategy.
abstract ObjectNameNormalizer getObjectNameNormalizer()
Retrieve the database identifier normalizer for this context.
abstract PersisterClassProvider getPersisterClassProvider()
Get the current persister class provider implementation
abstract String getPhysicalColumnName(String logicalName, Table table)
Find the physical column name for the given logical column name within the given table.
abstract PropertyData getPropertyAnnotatedWithIdAndToOne(XClass entityType, String propertyName)
Return the property annotated with @ToOne and @Id if any.
abstract PropertyData getPropertyAnnotatedWithMapsId(XClass entityType, String propertyName)
Return the property annotated with @MapsId("propertyName") if any.
abstract String getPropertyReferencedAssociation(String entityName, String propertyName)
abstract NamedQueryDefinition getQuery(String name)
Get named query metadata by name.
abstract ReflectionManager getReflectionManager()
abstract ResultSetMappingDefinition getResultSetMapping(String name)
Get the metadata for a named SQL result set mapping.
abstract NamedSQLQueryDefinition getSQLQuery(String name)
Get named SQL query metadata.
abstract String getSchemaName()
Returns the currently bound default schema name.
abstract Table getTable(String schema, String catalog, String name)
Returns the named table metadata.
abstract Map<Table, List<String[]>> getTableUniqueConstraints()
This method is deprecated. Use getUniqueConstraintHoldersByTable() instead
abstract TypeDef getTypeDef(String typeName)
Retrieve a type definition by name.
abstract TypeResolver getTypeResolver()
Retrieve the type resolver in effect.
abstract Map<Table, List<UniqueConstraintHolder>> getUniqueConstraintHoldersByTable()
abstract boolean isAutoImport()
Determine whether auto importing of entity names is currently enabled.
abstract boolean isDefaultLazy()
Determine whether default laziness is currently enabled.
abstract boolean isInSecondPass()
abstract boolean isSpecjProprietarySyntaxEnabled()
abstract Iterator<AuxiliaryDatabaseObject> iterateAuxiliaryDatabaseObjects()
Retrieves an iterator over the metadata pertaining to all auxiliary database objects int this repository.
abstract ListIterator<AuxiliaryDatabaseObject> iterateAuxiliaryDatabaseObjectsInReverse()
Same as iterateAuxiliaryDatabaseObjects() except that here the iterator is reversed.
abstract Iterator<AuxiliaryDatabaseObject> iterateAuxliaryDatabaseObjects()
This method is deprecated. To fix misspelling; use iterateAuxiliaryDatabaseObjects() instead
abstract ListIterator<AuxiliaryDatabaseObject> iterateAuxliaryDatabaseObjectsInReverse()
This method is deprecated. To fix misspelling; use iterateAuxiliaryDatabaseObjectsInReverse() instead
abstract Iterator<PersistentClass> iterateClasses()
Retrieves an iterator over the entity metadata present in this repository.
abstract Iterator<Collection> iterateCollections()
Returns an iterator over collection metadata.
abstract Iterator<Table> iterateTables()
Returns an iterator over table metadata.
abstract PersistentClass locatePersistentClassByEntityName(String entityName)
Retrieves the entity mapping metadata for the given entity name, potentially accounting for imports.
abstract void setAutoImport(boolean autoImport)
Set whether to enable auto importing of entity names.
abstract void setCatalogName(String catalogName)
Sets the currently bound default catalog name.
abstract void setDefaultAccess(String defaultAccess)
Sets the current default property access style.
abstract void setDefaultCascade(String defaultCascade)
Sets the current default cascade style.
abstract void setDefaultLazy(boolean defaultLazy)
Set whether to enable default laziness.
abstract void setDefaultPackage(String defaultPackage)
Set the current default package name.
abstract void setNamingStrategy(NamingStrategy namingStrategy)
Set the current naming strategy.
abstract void setPersisterClassProvider(PersisterClassProvider persisterClassProvider)
Set the current persister class provider implementation
abstract void setSchemaName(String schemaName)
Sets the currently bound default schema name.
abstract boolean useNewGeneratorMappings()
Should we use the new generator strategy mappings.

Public Methods

public abstract void addAnyMetaDef (AnyMetaDef defAnn)

Throws
AnnotationException

public abstract void addAuxiliaryDatabaseObject (AuxiliaryDatabaseObject auxiliaryDatabaseObject)

Add metadata pertaining to an auxiliary database object to this repository.

Parameters
auxiliaryDatabaseObject The metadata.

public abstract void addClass (PersistentClass persistentClass)

Add entity mapping metadata.

Parameters
persistentClass The entity metadata
Throws
DuplicateMappingException Indicates there4 was already an extry corresponding to the given entity name.

public abstract AnnotatedClassType addClassType (XClass clazz)

FIXME should be private but will this break things? Add a class type.

Parameters
clazz The XClass mapping.
Returns
  • The class type.

public abstract void addCollection (Collection collection)

Add collection mapping metadata to this repository.

Parameters
collection The collection metadata
Throws
DuplicateMappingException Indicates there was already an entry corresponding to the given collection role

public abstract void addColumnBinding (String logicalName, Column physicalColumn, Table table)

Binds the given 'physicalColumn' to the give 'logicalName' within the given 'table'.

Parameters
logicalName The logical column name binding.
physicalColumn The physical column metadata.
table The table metadata.
Throws
DuplicateMappingException Indicates a duplicate binding for either the physical column name or the logical column name.

public abstract void addDefaultGenerator (IdGenerator generator)

Adds a default id generator.

Parameters
generator The id generator

public abstract void addDefaultQuery (String name, NamedQueryDefinition query)

public abstract void addDefaultResultSetMapping (ResultSetMappingDefinition definition)

public abstract void addDefaultSQLQuery (String name, NamedSQLQueryDefinition query)

public abstract Table addDenormalizedTable (String schema, String catalog, String name, boolean isAbstract, String subselect, Table includedTable)

Adds a 'denormalized table' to this repository.

Parameters
schema The named schema in which the table belongs (or null).
catalog The named catalog in which the table belongs (or null).
name The table name
isAbstract Is the table abstract (i.e. not really existing in the DB)?
subselect A select statement which defines a logical table, much like a DB view.
includedTable ???
Returns
  • The created table metadata.
Throws
DuplicateMappingException If such a table mapping already exists.

public abstract void addFilterDefinition (FilterDefinition definition)

Adds a filter definition to this repository.

Parameters
definition The filter definition to add.

public abstract void addGenerator (IdGenerator generator)

Add a generator.

Parameters
generator The generator to add.

public abstract void addGeneratorTable (String name, Properties params)

Add a generator table properties.

Parameters
name The generator name
params The generator table properties.

public abstract void addImport (String entityName, String rename)

Adds an import (HQL entity rename) to the repository.

Parameters
entityName The entity name being renamed.
rename The rename
Throws
DuplicateMappingException If rename already is mapped to another entity name in this repository.

public abstract void addJoins (PersistentClass persistentClass, Map<String, Join> joins)

Add join metadata for a persistent entity.

Parameters
persistentClass The persistent entity metadata.
joins The join metadata to add.
Throws
MappingException

public abstract void addMappedBy (String entityName, String propertyName, String inversePropertyName)

public abstract void addMappedSuperclass (Class type, MappedSuperclass mappedSuperclass)

add a new MappedSuperclass This should not be called if the MappedSuperclass already exists (it would be erased)

Parameters
type type corresponding to the Mappedsuperclass
mappedSuperclass MappedSuperclass

public abstract void addPropertyAnnotatedWithMapsId (XClass entityType, PropertyData property)

public abstract void addPropertyAnnotatedWithMapsIdSpecj (XClass entityType, PropertyData property, String mapsIdValue)

public abstract void addPropertyReference (String referencedClass, String propertyName)

Adds a property reference binding to this repository.

Parameters
referencedClass The referenced entity name.
propertyName The referenced property name.

public abstract void addPropertyReferencedAssociation (String entityName, String propertyName, String propertyRef)

public abstract void addQuery (String name, NamedQueryDefinition query)

Adds metadata for a named query to this repository.

Parameters
name The name
query The metadata
Throws
DuplicateMappingException If a query already exists with that name.

public abstract void addResultSetMapping (ResultSetMappingDefinition sqlResultSetMapping)

Adds the metadata for a named SQL result set mapping to this repository.

Parameters
sqlResultSetMapping The metadata
Throws
DuplicateMappingException If metadata for another SQL result mapping was already found under the given name.

public abstract void addSQLQuery (String name, NamedSQLQueryDefinition query)

Adds metadata for a named SQL query to this repository.

Parameters
name The name
query The metadata
Throws
DuplicateMappingException If a query already exists with that name.

public abstract void addSecondPass (SecondPass sp)

Adds a second-pass to the end of the current queue.

Parameters
sp The second pass to add.

public abstract void addSecondPass (SecondPass sp, boolean onTopOfTheQueue)

Adds a second pass.

Parameters
sp The second pass to add.
onTopOfTheQueue True to add to the beginning of the queue; false to add to the end.

public abstract Table addTable (String schema, String catalog, String name, String subselect, boolean isAbstract)

Adds table metadata to this repository returning the created metadata instance.

Parameters
schema The named schema in which the table belongs (or null).
catalog The named catalog in which the table belongs (or null).
name The table name
subselect A select statement which defines a logical table, much like a DB view.
isAbstract Is the table abstract (i.e. not really existing in the DB)?
Returns
  • The created table metadata, or the existing reference.

public abstract void addTableBinding (String schema, String catalog, String logicalName, String physicalName, Table denormalizedSuperTable)

Adds a table binding to this repository.

Parameters
schema The schema in which the table belongs (may be null).
catalog The catalog in which the table belongs (may be null).
logicalName The logical table name.
physicalName The physical table name.
denormalizedSuperTable ???
Throws
DuplicateMappingException Indicates physical table was already bound to another logical name.

public abstract void addToExtendsQueue (ExtendsQueueEntry entry)

Adds an entry to the extends queue queue.

Parameters
entry The entry to add.

public abstract void addToOneAndIdProperty (XClass entity, PropertyData property)

public abstract void addTypeDef (String typeName, String typeClass, Properties paramMap)

Adds a type definition to this metadata repository.

Parameters
typeName The type name.
typeClass The class implementing the Type contract.
paramMap Map of parameters to be used to configure the type after instantiation.

public abstract void addUniqueConstraintHolders (Table table, List<UniqueConstraintHolder> uniqueConstraintHolders)

public abstract void addUniqueConstraints (Table table, List uniqueConstraints)

This method is deprecated.
Use addUniqueConstraintHolders(Table, List) instead

public abstract void addUniquePropertyReference (String referencedClass, String propertyName)

Adds a property reference binding to this repository where said proeprty reference is marked as unique.

Parameters
referencedClass The referenced entity name.
propertyName The referenced property name.

public abstract FetchProfile findOrCreateFetchProfile (String name, MetadataSource source)

Retrieves a fetch profile by either finding one currently in this repository matching the given name or by creating one (and adding it).

Parameters
name The name of the profile.
source The source from which this profile is named.
Returns
  • The fetch profile metadata.

public abstract AnyMetaDef getAnyMetaDef (String name)

public abstract String getCatalogName ()

Returns the currently bound default catalog name.

Returns
  • The currently bound catalog name, or null if none.

public abstract PersistentClass getClass (String entityName)

Retrieves the entity mapping metadata for the given entity name.

Parameters
entityName The entity name for which to retrieve the metadata.
Returns
  • The entity mapping metadata, or null if none found matching given entity name.

public abstract AnnotatedClassType getClassType (XClass clazz)

Get and maintain a cache of class type.

Parameters
clazz The XClass mapping
Returns
  • The class type.

public abstract Map getClasses ()

public abstract Collection getCollection (String role)

Retrieves the collection mapping metadata for the given collection role.

Parameters
role The collection role for which to retrieve the metadata.
Returns
  • The collection mapping metadata, or null if no matching collection role found.

public abstract Properties getConfigurationProperties ()

Retrieve the configuration properties currently in effect.

Returns
  • The configuration properties

public abstract String getDefaultAccess ()

Get the current default property access style.

Returns
  • The current default property access style.

public abstract String getDefaultCascade ()

Get the current default cascade style.

Returns
  • The current default cascade style.

public abstract String getDefaultPackage ()

Get the currently bound default package name.

Returns
  • The currently bound default package name

public abstract FilterDefinition getFilterDefinition (String name)

Retrieves a filter definition by name.

Parameters
name The name of the filter definition to retrieve.
Returns
  • The filter definition, or null.

public abstract Map getFilterDefinitions ()

Retrieves the copmplete map of filter definitions.

Returns
  • The filter definition map.

public abstract String getFromMappedBy (String entityName, String propertyName)

public abstract IdGenerator getGenerator (String name, Map<String, IdGenerator> localGenerators)

Try to find the generator from the localGenerators and then from the global generator list

Parameters
name generator name
localGenerators local generators
Returns
  • the appropriate idgenerator or null if not found

public abstract IdGenerator getGenerator (String name)

Retrieve the id-generator by name.

Parameters
name The generator name.
Returns
  • The generator, or null.

public abstract Properties getGeneratorTableProperties (String name, Map<String, Properties> localGeneratorTables)

Retrieve the properties related to a generator table.

Parameters
name generator name
localGeneratorTables local generator tables
Returns
  • The properties, or null.

public abstract DefaultIdentifierGeneratorFactory getIdentifierGeneratorFactory ()

Retrieve the IdentifierGeneratorFactory in effect for this mapping.

Returns
  • The IdentifierGeneratorFactory

public abstract Map<String, Join> getJoins (String entityName)

Retrieve join metadata for a particular persistent entity.

Parameters
entityName The entity name
Returns
  • The join metadata

public abstract String getLogicalColumnName (String physicalName, Table table)

Find the logical column name against whcih the given physical column name was bound within the given table.

Parameters
physicalName The physical column name
table The table metadata.
Returns
  • The logical column name.
Throws
MappingException Indicates that no such binding was found.

public abstract String getLogicalTableName (Table table)

Get the logical table name mapped for the given physical table.

Parameters
table The table for which to determine the logical name.
Returns
  • The logical name.
Throws
MappingException Indicates that no logical name was bound for the given physical table.

public abstract MappedSuperclass getMappedSuperclass (Class type)

Get a MappedSuperclass or null if not mapped

Parameters
type class corresponding to the MappedSuperclass
Returns
  • the MappedSuperclass

public abstract NamingStrategy getNamingStrategy ()

Get the current naming strategy.

Returns
  • The current naming strategy.

public abstract ObjectNameNormalizer getObjectNameNormalizer ()

Retrieve the database identifier normalizer for this context.

Returns
  • The normalizer.

public abstract PersisterClassProvider getPersisterClassProvider ()

Get the current persister class provider implementation

public abstract String getPhysicalColumnName (String logicalName, Table table)

Find the physical column name for the given logical column name within the given table.

Parameters
logicalName The logical name binding.
table The table metatdata.
Returns
  • The physical column name.
Throws
MappingException Indicates that no such binding was found.

public abstract PropertyData getPropertyAnnotatedWithIdAndToOne (XClass entityType, String propertyName)

Return the property annotated with @ToOne and @Id if any. Null otherwise

public abstract PropertyData getPropertyAnnotatedWithMapsId (XClass entityType, String propertyName)

Return the property annotated with @MapsId("propertyName") if any. Null otherwise

public abstract String getPropertyReferencedAssociation (String entityName, String propertyName)

public abstract NamedQueryDefinition getQuery (String name)

Get named query metadata by name.

Parameters
name The named query name
Returns
  • The query metadata, or null.

public abstract ReflectionManager getReflectionManager ()

public abstract ResultSetMappingDefinition getResultSetMapping (String name)

Get the metadata for a named SQL result set mapping.

Parameters
name The mapping name.
Returns
  • The SQL result set mapping metadat, or null if none found.

public abstract NamedSQLQueryDefinition getSQLQuery (String name)

Get named SQL query metadata.

Parameters
name The named SQL query name.
Returns
  • The meatdata, or null if none found.

public abstract String getSchemaName ()

Returns the currently bound default schema name.

Returns
  • The currently bound schema name

public abstract Table getTable (String schema, String catalog, String name)

Returns the named table metadata.

Parameters
schema The named schema in which the table belongs (or null).
catalog The named catalog in which the table belongs (or null).
name The table name
Returns
  • The table metadata, or null.

public abstract Map<Table, List<String[]>> getTableUniqueConstraints ()

This method is deprecated.
Use getUniqueConstraintHoldersByTable() instead

public abstract TypeDef getTypeDef (String typeName)

Retrieve a type definition by name.

Parameters
typeName The name of the type definition to retrieve.
Returns
  • The type definition, or null if none found.

public abstract TypeResolver getTypeResolver ()

Retrieve the type resolver in effect.

Returns
  • The type resolver.

public abstract Map<Table, List<UniqueConstraintHolder>> getUniqueConstraintHoldersByTable ()

public abstract boolean isAutoImport ()

Determine whether auto importing of entity names is currently enabled.

Returns
  • True if currently enabled; false otherwise.

public abstract boolean isDefaultLazy ()

Determine whether default laziness is currently enabled.

Returns
  • True if enabled, false otherwise.

public abstract boolean isInSecondPass ()

public abstract boolean isSpecjProprietarySyntaxEnabled ()

public abstract Iterator<AuxiliaryDatabaseObject> iterateAuxiliaryDatabaseObjects ()

Retrieves an iterator over the metadata pertaining to all auxiliary database objects int this repository.

Returns
  • Iterator over the auxiliary database object metadata.

public abstract ListIterator<AuxiliaryDatabaseObject> iterateAuxiliaryDatabaseObjectsInReverse ()

Same as iterateAuxiliaryDatabaseObjects() except that here the iterator is reversed.

Returns
  • The reversed iterator.

public abstract Iterator<AuxiliaryDatabaseObject> iterateAuxliaryDatabaseObjects ()

This method is deprecated.
To fix misspelling; use iterateAuxiliaryDatabaseObjects() instead

public abstract ListIterator<AuxiliaryDatabaseObject> iterateAuxliaryDatabaseObjectsInReverse ()

This method is deprecated.
To fix misspelling; use iterateAuxiliaryDatabaseObjectsInReverse() instead

public abstract Iterator<PersistentClass> iterateClasses ()

Retrieves an iterator over the entity metadata present in this repository.

Returns
  • Iterator over class metadata.

public abstract Iterator<Collection> iterateCollections ()

Returns an iterator over collection metadata.

Returns
  • Iterator over collection metadata.

public abstract Iterator<Table> iterateTables ()

Returns an iterator over table metadata.

Returns
  • Iterator over table metadata.

public abstract PersistentClass locatePersistentClassByEntityName (String entityName)

Retrieves the entity mapping metadata for the given entity name, potentially accounting for imports.

Parameters
entityName The entity name for which to retrieve the metadata.
Returns
  • The entity mapping metadata, or null if none found matching given entity name.

public abstract void setAutoImport (boolean autoImport)

Set whether to enable auto importing of entity names.

Parameters
autoImport True to enable; false to diasable.
See Also

public abstract void setCatalogName (String catalogName)

Sets the currently bound default catalog name.

Parameters
catalogName The catalog name to use as the current default.

public abstract void setDefaultAccess (String defaultAccess)

Sets the current default property access style.

Parameters
defaultAccess The access style to use as the current default.

public abstract void setDefaultCascade (String defaultCascade)

Sets the current default cascade style. .

Parameters
defaultCascade The cascade style to set as the current default.

public abstract void setDefaultLazy (boolean defaultLazy)

Set whether to enable default laziness.

Parameters
defaultLazy True to enable, false to disable.

public abstract void setDefaultPackage (String defaultPackage)

Set the current default package name.

Parameters
defaultPackage The package name to set as the current default.

public abstract void setNamingStrategy (NamingStrategy namingStrategy)

Set the current naming strategy.

Parameters
namingStrategy The naming strategy to use.

public abstract void setPersisterClassProvider (PersisterClassProvider persisterClassProvider)

Set the current persister class provider implementation

public abstract void setSchemaName (String schemaName)

Sets the currently bound default schema name.

Parameters
schemaName The schema name to bind as the current default.

public abstract boolean useNewGeneratorMappings ()

Should we use the new generator strategy mappings. This is controlled by the USE_NEW_ID_GENERATOR_MAPPINGS setting.

Returns
  • True if the new generators should be used, false otherwise.