|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Mappings
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:
Nested Class Summary | |
---|---|
static class |
Mappings.PropertyReference
Represents a property-ref mapping. |
Method Summary | |
---|---|
void |
addAnyMetaDef(AnyMetaDef defAnn)
|
void |
addAuxiliaryDatabaseObject(AuxiliaryDatabaseObject auxiliaryDatabaseObject)
Add metadata pertaining to an auxiliary database object to this repository. |
void |
addClass(PersistentClass persistentClass)
Add entity mapping metadata. |
AnnotatedClassType |
addClassType(org.hibernate.annotations.common.reflection.XClass clazz)
FIXME should be private but will this break things? Add a class type. |
void |
addCollection(Collection collection)
Add collection mapping metadata to this repository. |
void |
addColumnBinding(String logicalName,
Column physicalColumn,
Table table)
Binds the given 'physicalColumn' to the give 'logicalName' within the given 'table'. |
void |
addDefaultGenerator(IdGenerator generator)
Adds a default id generator. |
void |
addDefaultQuery(String name,
NamedQueryDefinition query)
|
void |
addDefaultResultSetMapping(ResultSetMappingDefinition definition)
|
void |
addDefaultSQLQuery(String name,
NamedSQLQueryDefinition query)
|
Table |
addDenormalizedTable(String schema,
String catalog,
String name,
boolean isAbstract,
String subselect,
Table includedTable)
Adds a 'denormalized table' to this repository. |
void |
addFilterDefinition(FilterDefinition definition)
Adds a filter definition to this repository. |
void |
addGenerator(IdGenerator generator)
Add a generator. |
void |
addGeneratorTable(String name,
Properties params)
Add a generator table properties. |
void |
addImport(String entityName,
String rename)
Adds an import (HQL entity rename) to the repository. |
void |
addJoins(PersistentClass persistentClass,
Map<String,Join> joins)
Add join metadata for a persistent entity. |
void |
addMappedBy(String entityName,
String propertyName,
String inversePropertyName)
|
void |
addMappedSuperclass(Class type,
MappedSuperclass mappedSuperclass)
add a new MappedSuperclass This should not be called if the MappedSuperclass already exists (it would be erased) |
void |
addPropertyAnnotatedWithMapsId(org.hibernate.annotations.common.reflection.XClass entityType,
PropertyData property)
|
void |
addPropertyAnnotatedWithMapsIdSpecj(org.hibernate.annotations.common.reflection.XClass entityType,
PropertyData property,
String mapsIdValue)
|
void |
addPropertyReference(String referencedClass,
String propertyName)
Adds a property reference binding to this repository. |
void |
addPropertyReferencedAssociation(String entityName,
String propertyName,
String propertyRef)
|
void |
addQuery(String name,
NamedQueryDefinition query)
Adds metadata for a named query to this repository. |
void |
addResultSetMapping(ResultSetMappingDefinition sqlResultSetMapping)
Adds the metadata for a named SQL result set mapping to this repository. |
void |
addSecondPass(SecondPass sp)
Adds a second-pass to the end of the current queue. |
void |
addSecondPass(SecondPass sp,
boolean onTopOfTheQueue)
Adds a second pass. |
void |
addSQLQuery(String name,
NamedSQLQueryDefinition query)
Adds metadata for a named SQL query to this repository. |
Table |
addTable(String schema,
String catalog,
String name,
String subselect,
boolean isAbstract)
Adds table metadata to this repository returning the created metadata instance. |
void |
addTableBinding(String schema,
String catalog,
String logicalName,
String physicalName,
Table denormalizedSuperTable)
Adds a table binding to this repository. |
void |
addToExtendsQueue(ExtendsQueueEntry entry)
Adds an entry to the extends queue queue. |
void |
addToOneAndIdProperty(org.hibernate.annotations.common.reflection.XClass entity,
PropertyData property)
|
void |
addTypeDef(String typeName,
String typeClass,
Properties paramMap)
Adds a type definition to this metadata repository. |
void |
addUniqueConstraintHolders(Table table,
List<UniqueConstraintHolder> uniqueConstraintHolders)
|
void |
addUniqueConstraints(Table table,
List uniqueConstraints)
Deprecated. Use addUniqueConstraintHolders(org.hibernate.mapping.Table, java.util.List instead |
void |
addUniquePropertyReference(String referencedClass,
String propertyName)
Adds a property reference binding to this repository where said proeprty reference is marked as unique. |
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). |
AnyMetaDef |
getAnyMetaDef(String name)
|
String |
getCatalogName()
Returns the currently bound default catalog name. |
PersistentClass |
getClass(String entityName)
Retrieves the entity mapping metadata for the given entity name. |
Map |
getClasses()
|
AnnotatedClassType |
getClassType(org.hibernate.annotations.common.reflection.XClass clazz)
Get and maintain a cache of class type. |
Collection |
getCollection(String role)
Retrieves the collection mapping metadata for the given collection role. |
Properties |
getConfigurationProperties()
Retrieve the configuration properties currently in effect. |
String |
getDefaultAccess()
Get the current default property access style. |
String |
getDefaultCascade()
Get the current default cascade style. |
String |
getDefaultPackage()
Get the currently bound default package name. |
FilterDefinition |
getFilterDefinition(String name)
Retrieves a filter definition by name. |
Map |
getFilterDefinitions()
Retrieves the copmplete map of filter definitions. |
String |
getFromMappedBy(String entityName,
String propertyName)
|
IdGenerator |
getGenerator(String name)
Retrieve the id-generator by name. |
IdGenerator |
getGenerator(String name,
Map<String,IdGenerator> localGenerators)
Try to find the generator from the localGenerators and then from the global generator list |
Properties |
getGeneratorTableProperties(String name,
Map<String,Properties> localGeneratorTables)
Retrieve the properties related to a generator table. |
DefaultIdentifierGeneratorFactory |
getIdentifierGeneratorFactory()
Retrieve the IdentifierGeneratorFactory in effect for this mapping. |
Map<String,Join> |
getJoins(String entityName)
Retrieve join metadata for a particular persistent entity. |
String |
getLogicalColumnName(String physicalName,
Table table)
Find the logical column name against whcih the given physical column name was bound within the given table. |
String |
getLogicalTableName(Table table)
Get the logical table name mapped for the given physical table. |
MappedSuperclass |
getMappedSuperclass(Class type)
Get a MappedSuperclass or null if not mapped |
NamingStrategy |
getNamingStrategy()
Get the current naming strategy. |
ObjectNameNormalizer |
getObjectNameNormalizer()
Retrieve the database identifier normalizer for this context. |
PersisterClassProvider |
getPersisterClassProvider()
Get the current persister class provider implementation |
String |
getPhysicalColumnName(String logicalName,
Table table)
Find the physical column name for the given logical column name within the given table. |
PropertyData |
getPropertyAnnotatedWithIdAndToOne(org.hibernate.annotations.common.reflection.XClass entityType,
String propertyName)
Return the property annotated with @ToOne and @Id if any. |
PropertyData |
getPropertyAnnotatedWithMapsId(org.hibernate.annotations.common.reflection.XClass entityType,
String propertyName)
Return the property annotated with @MapsId("propertyName") if any. |
String |
getPropertyReferencedAssociation(String entityName,
String propertyName)
|
NamedQueryDefinition |
getQuery(String name)
Get named query metadata by name. |
org.hibernate.annotations.common.reflection.ReflectionManager |
getReflectionManager()
|
ResultSetMappingDefinition |
getResultSetMapping(String name)
Get the metadata for a named SQL result set mapping. |
String |
getSchemaName()
Returns the currently bound default schema name. |
NamedSQLQueryDefinition |
getSQLQuery(String name)
Get named SQL query metadata. |
Table |
getTable(String schema,
String catalog,
String name)
Returns the named table metadata. |
Map<Table,List<String[]>> |
getTableUniqueConstraints()
Deprecated. Use getUniqueConstraintHoldersByTable() instead |
TypeDef |
getTypeDef(String typeName)
Retrieve a type definition by name. |
TypeResolver |
getTypeResolver()
Retrieve the type resolver in effect. |
Map<Table,List<UniqueConstraintHolder>> |
getUniqueConstraintHoldersByTable()
|
boolean |
isAutoImport()
Determine whether auto importing of entity names is currently enabled. |
boolean |
isDefaultLazy()
Determine whether default laziness is currently enabled. |
boolean |
isInSecondPass()
|
boolean |
isSpecjProprietarySyntaxEnabled()
|
Iterator<AuxiliaryDatabaseObject> |
iterateAuxiliaryDatabaseObjects()
Retrieves an iterator over the metadata pertaining to all auxiliary database objects int this repository. |
ListIterator<AuxiliaryDatabaseObject> |
iterateAuxiliaryDatabaseObjectsInReverse()
Same as iterateAuxiliaryDatabaseObjects() except that here the iterator is reversed. |
Iterator<AuxiliaryDatabaseObject> |
iterateAuxliaryDatabaseObjects()
Deprecated. To fix misspelling; use iterateAuxiliaryDatabaseObjects() instead |
ListIterator<AuxiliaryDatabaseObject> |
iterateAuxliaryDatabaseObjectsInReverse()
Deprecated. To fix misspelling; use iterateAuxiliaryDatabaseObjectsInReverse() instead |
Iterator<PersistentClass> |
iterateClasses()
Retrieves an iterator over the entity metadata present in this repository. |
Iterator<Collection> |
iterateCollections()
Returns an iterator over collection metadata. |
Iterator<Table> |
iterateTables()
Returns an iterator over table metadata. |
PersistentClass |
locatePersistentClassByEntityName(String entityName)
Retrieves the entity mapping metadata for the given entity name, potentially accounting for imports. |
void |
setAutoImport(boolean autoImport)
Set whether to enable auto importing of entity names. |
void |
setCatalogName(String catalogName)
Sets the currently bound default catalog name. |
void |
setDefaultAccess(String defaultAccess)
Sets the current default property access style. |
void |
setDefaultCascade(String defaultCascade)
Sets the current default cascade style. |
void |
setDefaultLazy(boolean defaultLazy)
Set whether to enable default laziness. |
void |
setDefaultPackage(String defaultPackage)
Set the current default package name. |
void |
setNamingStrategy(NamingStrategy namingStrategy)
Set the current naming strategy. |
void |
setPersisterClassProvider(PersisterClassProvider persisterClassProvider)
Set the current persister class provider implementation |
void |
setSchemaName(String schemaName)
Sets the currently bound default schema name. |
boolean |
useNewGeneratorMappings()
Should we use the new generator strategy mappings. |
Method Detail |
---|
TypeResolver getTypeResolver()
NamingStrategy getNamingStrategy()
void setNamingStrategy(NamingStrategy namingStrategy)
namingStrategy
- The naming strategy to use.PersisterClassProvider getPersisterClassProvider()
void setPersisterClassProvider(PersisterClassProvider persisterClassProvider)
String getSchemaName()
void setSchemaName(String schemaName)
schemaName
- The schema name to bind as the current default.String getCatalogName()
void setCatalogName(String catalogName)
catalogName
- The catalog name to use as the current default.String getDefaultPackage()
void setDefaultPackage(String defaultPackage)
defaultPackage
- The package name to set as the current default.boolean isAutoImport()
void setAutoImport(boolean autoImport)
autoImport
- True to enable; false to diasable.addImport(java.lang.String, java.lang.String)
boolean isDefaultLazy()
void setDefaultLazy(boolean defaultLazy)
defaultLazy
- True to enable, false to disable.String getDefaultCascade()
void setDefaultCascade(String defaultCascade)
defaultCascade
- The cascade style to set as the current default.String getDefaultAccess()
void setDefaultAccess(String defaultAccess)
defaultAccess
- The access style to use as the current default.Iterator<PersistentClass> iterateClasses()
PersistentClass getClass(String entityName)
entityName
- The entity name for which to retrieve the metadata.
PersistentClass locatePersistentClassByEntityName(String entityName)
entityName
- The entity name for which to retrieve the metadata.
void addClass(PersistentClass persistentClass) throws DuplicateMappingException
persistentClass
- The entity metadata
DuplicateMappingException
- Indicates there4 was already an extry
corresponding to the given entity name.void addImport(String entityName, String rename) throws DuplicateMappingException
entityName
- The entity name being renamed.rename
- The rename
DuplicateMappingException
- If rename already is mapped to another
entity name in this repository.Collection getCollection(String role)
role
- The collection role for which to retrieve the metadata.
Iterator<Collection> iterateCollections()
void addCollection(Collection collection) throws DuplicateMappingException
collection
- The collection metadata
DuplicateMappingException
- Indicates there was already an entry
corresponding to the given collection roleTable getTable(String schema, String catalog, String name)
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
Iterator<Table> iterateTables()
Table addTable(String schema, String catalog, String name, String subselect, boolean isAbstract)
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 namesubselect
- 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)?
Table addDenormalizedTable(String schema, String catalog, String name, boolean isAbstract, String subselect, Table includedTable) throws DuplicateMappingException
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 nameisAbstract
- 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
- ???
DuplicateMappingException
- If such a table mapping already exists.NamedQueryDefinition getQuery(String name)
name
- The named query name
void addQuery(String name, NamedQueryDefinition query) throws DuplicateMappingException
name
- The namequery
- The metadata
DuplicateMappingException
- If a query already exists with that name.NamedSQLQueryDefinition getSQLQuery(String name)
name
- The named SQL query name.
void addSQLQuery(String name, NamedSQLQueryDefinition query) throws DuplicateMappingException
name
- The namequery
- The metadata
DuplicateMappingException
- If a query already exists with that name.ResultSetMappingDefinition getResultSetMapping(String name)
name
- The mapping name.
void addResultSetMapping(ResultSetMappingDefinition sqlResultSetMapping) throws DuplicateMappingException
sqlResultSetMapping
- The metadata
DuplicateMappingException
- If metadata for another SQL result mapping was
already found under the given name.TypeDef getTypeDef(String typeName)
typeName
- The name of the type definition to retrieve.
void addTypeDef(String typeName, String typeClass, Properties paramMap)
typeName
- The type name.typeClass
- The class implementing the Type
contract.paramMap
- Map of parameters to be used to configure the type after instantiation.Map getFilterDefinitions()
FilterDefinition getFilterDefinition(String name)
name
- The name of the filter definition to retrieve.
void addFilterDefinition(FilterDefinition definition)
definition
- The filter definition to add.FetchProfile findOrCreateFetchProfile(String name, MetadataSource source)
name
- The name of the profile.source
- The source from which this profile is named.
@Deprecated Iterator<AuxiliaryDatabaseObject> iterateAuxliaryDatabaseObjects()
iterateAuxiliaryDatabaseObjects()
instead
Iterator<AuxiliaryDatabaseObject> iterateAuxiliaryDatabaseObjects()
@Deprecated ListIterator<AuxiliaryDatabaseObject> iterateAuxliaryDatabaseObjectsInReverse()
iterateAuxiliaryDatabaseObjectsInReverse()
instead
ListIterator<AuxiliaryDatabaseObject> iterateAuxiliaryDatabaseObjectsInReverse()
iterateAuxiliaryDatabaseObjects()
except that here the iterator is reversed.
void addAuxiliaryDatabaseObject(AuxiliaryDatabaseObject auxiliaryDatabaseObject)
auxiliaryDatabaseObject
- The metadata.String getLogicalTableName(Table table) throws MappingException
table
- The table for which to determine the logical name.
MappingException
- Indicates that no logical name was bound for the given physical table.void addTableBinding(String schema, String catalog, String logicalName, String physicalName, Table denormalizedSuperTable) throws DuplicateMappingException
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
- ???
DuplicateMappingException
- Indicates physical table was already bound to another logical name.void addColumnBinding(String logicalName, Column physicalColumn, Table table) throws DuplicateMappingException
logicalName
- The logical column name binding.physicalColumn
- The physical column metadata.table
- The table metadata.
DuplicateMappingException
- Indicates a duplicate binding for either the physical column name
or the logical column name.String getPhysicalColumnName(String logicalName, Table table) throws MappingException
logicalName
- The logical name binding.table
- The table metatdata.
MappingException
- Indicates that no such binding was found.String getLogicalColumnName(String physicalName, Table table) throws MappingException
physicalName
- The physical column nametable
- The table metadata.
MappingException
- Indicates that no such binding was found.void addSecondPass(SecondPass sp)
sp
- The second pass to add.void addSecondPass(SecondPass sp, boolean onTopOfTheQueue)
sp
- The second pass to add.onTopOfTheQueue
- True to add to the beginning of the queue; false to add to the end.void addPropertyReference(String referencedClass, String propertyName)
referencedClass
- The referenced entity name.propertyName
- The referenced property name.void addUniquePropertyReference(String referencedClass, String propertyName)
referencedClass
- The referenced entity name.propertyName
- The referenced property name.void addToExtendsQueue(ExtendsQueueEntry entry)
entry
- The entry to add.DefaultIdentifierGeneratorFactory getIdentifierGeneratorFactory()
void addMappedSuperclass(Class type, MappedSuperclass mappedSuperclass)
type
- type corresponding to the MappedsuperclassmappedSuperclass
- MappedSuperclassMappedSuperclass getMappedSuperclass(Class type)
type
- class corresponding to the MappedSuperclass
ObjectNameNormalizer getObjectNameNormalizer()
Properties getConfigurationProperties()
void addDefaultGenerator(IdGenerator generator)
generator
- The id generatorIdGenerator getGenerator(String name)
name
- The generator name.
IdGenerator getGenerator(String name, Map<String,IdGenerator> localGenerators)
name
- generator namelocalGenerators
- local generators
void addGenerator(IdGenerator generator)
generator
- The generator to add.void addGeneratorTable(String name, Properties params)
name
- The generator nameparams
- The generator table properties.Properties getGeneratorTableProperties(String name, Map<String,Properties> localGeneratorTables)
name
- generator namelocalGeneratorTables
- local generator tables
Map<String,Join> getJoins(String entityName)
entityName
- The entity name
void addJoins(PersistentClass persistentClass, Map<String,Join> joins)
persistentClass
- The persistent entity metadata.joins
- The join metadata to add.
MappingException
AnnotatedClassType getClassType(org.hibernate.annotations.common.reflection.XClass clazz)
clazz
- The XClass mapping
AnnotatedClassType addClassType(org.hibernate.annotations.common.reflection.XClass clazz)
clazz
- The XClass mapping.
Map<Table,List<String[]>> getTableUniqueConstraints()
getUniqueConstraintHoldersByTable()
instead
Map<Table,List<UniqueConstraintHolder>> getUniqueConstraintHoldersByTable()
void addUniqueConstraints(Table table, List uniqueConstraints)
addUniqueConstraintHolders(org.hibernate.mapping.Table, java.util.List)
instead
void addUniqueConstraintHolders(Table table, List<UniqueConstraintHolder> uniqueConstraintHolders)
void addMappedBy(String entityName, String propertyName, String inversePropertyName)
String getFromMappedBy(String entityName, String propertyName)
void addPropertyReferencedAssociation(String entityName, String propertyName, String propertyRef)
String getPropertyReferencedAssociation(String entityName, String propertyName)
org.hibernate.annotations.common.reflection.ReflectionManager getReflectionManager()
void addDefaultQuery(String name, NamedQueryDefinition query)
void addDefaultSQLQuery(String name, NamedSQLQueryDefinition query)
void addDefaultResultSetMapping(ResultSetMappingDefinition definition)
Map getClasses()
void addAnyMetaDef(AnyMetaDef defAnn) throws AnnotationException
AnnotationException
AnyMetaDef getAnyMetaDef(String name)
boolean isInSecondPass()
PropertyData getPropertyAnnotatedWithMapsId(org.hibernate.annotations.common.reflection.XClass entityType, String propertyName)
void addPropertyAnnotatedWithMapsId(org.hibernate.annotations.common.reflection.XClass entityType, PropertyData property)
void addPropertyAnnotatedWithMapsIdSpecj(org.hibernate.annotations.common.reflection.XClass entityType, PropertyData property, String mapsIdValue)
boolean isSpecjProprietarySyntaxEnabled()
boolean useNewGeneratorMappings()
Configuration.USE_NEW_ID_GENERATOR_MAPPINGS
setting.
PropertyData getPropertyAnnotatedWithIdAndToOne(org.hibernate.annotations.common.reflection.XClass entityType, String propertyName)
void addToOneAndIdProperty(org.hibernate.annotations.common.reflection.XClass entity, PropertyData property)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |