Interface EntitySource
-
- All Superinterfaces:
AttributeSourceContainer
,EntityNamingSourceContributor
,IdentifiableTypeSource
,ToolingHintContextContainer
- All Known Subinterfaces:
JoinedSubclassEntitySource
,SubclassEntitySource
public interface EntitySource extends IdentifiableTypeSource, ToolingHintContextContainer, EntityNamingSourceContributor
Contract describing source of information related to mapping an entity.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getBatchSize()
Obtain the batch-size to be applied when initializing proxies of this entity.java.lang.String
getCustomLoaderName()
Obtain the name of a named-query that will be used for loading this entityjava.lang.String
getCustomPersisterClassName()
Obtain the name of a custom persister class to be used.CustomSql
getCustomSqlDelete()
Obtain the custom SQL to be used for deletes for this entityCustomSql
getCustomSqlInsert()
Obtain the custom SQL to be used for inserts for this entityCustomSql
getCustomSqlUpdate()
Obtain the custom SQL to be used for updates for this entityjava.lang.String
getDiscriminatorMatchValue()
Get the actual discriminator value in case of a single table inheritanceFilterSource[]
getFilterSources()
Obtain the filters for this entity.java.util.List<JaxbHbmNamedNativeQueryType>
getNamedNativeQueries()
java.util.List<JaxbHbmNamedQueryType>
getNamedQueries()
TableSpecificationSource
getPrimaryTable()
Obtain the primary table for this entity.java.lang.String
getProxy()
Forlazy
entities, obtain the interface to use in constructing its proxies.java.util.Map<java.lang.String,SecondaryTableSource>
getSecondaryTableMap()
Obtain the secondary tables for this entityjava.lang.String[]
getSynchronizedTableNames()
Obtain any additional table names on which to synchronize (auto flushing) this entity.java.util.Map<EntityMode,java.lang.String>
getTuplizerClassMap()
Obtain the named custom tuplizer classes to be used.java.lang.String
getXmlNodeName()
java.lang.Boolean
isAbstract()
Is the entity abstract?boolean
isDynamicInsert()
Did the source specify dynamic inserts?boolean
isDynamicUpdate()
Did the source specify dynamic updates?boolean
isLazy()
Is this entity lazy (proxyable)?boolean
isSelectBeforeUpdate()
Did the source specify to perform selects to decide whether to perform (detached) updates?TruthValue
quoteIdentifiersLocalToEntity()
-
Methods inherited from interface org.hibernate.boot.model.source.spi.AttributeSourceContainer
attributeSources, getAttributePathBase, getAttributeRoleBase
-
Methods inherited from interface org.hibernate.boot.model.source.spi.EntityNamingSourceContributor
getEntityNamingSource
-
Methods inherited from interface org.hibernate.boot.model.source.spi.IdentifiableTypeSource
getHierarchy, getJpaCallbackClasses, getLocalMetadataBuildingContext, getOrigin, getSubTypes, getSuperType, getTypeName
-
Methods inherited from interface org.hibernate.boot.model.source.spi.ToolingHintContextContainer
getToolingHintContext
-
-
-
-
Method Detail
-
getPrimaryTable
TableSpecificationSource getPrimaryTable()
Obtain the primary table for this entity.- Returns:
- The primary table.
-
getSecondaryTableMap
java.util.Map<java.lang.String,SecondaryTableSource> getSecondaryTableMap()
Obtain the secondary tables for this entity- Returns:
- returns an iterator over the secondary tables for this entity
-
getXmlNodeName
java.lang.String getXmlNodeName()
-
getTuplizerClassMap
java.util.Map<EntityMode,java.lang.String> getTuplizerClassMap()
Obtain the named custom tuplizer classes to be used.- Returns:
- The custom tuplizer class names
-
getCustomPersisterClassName
java.lang.String getCustomPersisterClassName()
Obtain the name of a custom persister class to be used.- Returns:
- The custom persister class name
-
isLazy
boolean isLazy()
Is this entity lazy (proxyable)?- Returns:
true
indicates the entity is lazy;false
non-lazy.
-
getProxy
java.lang.String getProxy()
Forlazy
entities, obtain the interface to use in constructing its proxies.- Returns:
- The proxy interface name
-
getBatchSize
int getBatchSize()
Obtain the batch-size to be applied when initializing proxies of this entity.- Returns:
- returns the the batch-size.
-
isAbstract
java.lang.Boolean isAbstract()
Is the entity abstract? The implication is whether the entity maps to a database table.- Returns:
true
indicates the entity is abstract;false
non-abstract;null
indicates that a reflection check should be done when building the persister.
-
isDynamicInsert
boolean isDynamicInsert()
Did the source specify dynamic inserts?- Returns:
true
indicates dynamic inserts will be used;false
otherwise.
-
isDynamicUpdate
boolean isDynamicUpdate()
Did the source specify dynamic updates?- Returns:
true
indicates dynamic updates will be used;false
otherwise.
-
isSelectBeforeUpdate
boolean isSelectBeforeUpdate()
Did the source specify to perform selects to decide whether to perform (detached) updates?- Returns:
true
indicates selects will be done;false
otherwise.
-
getCustomLoaderName
java.lang.String getCustomLoaderName()
Obtain the name of a named-query that will be used for loading this entity- Returns:
- THe custom loader query name
-
getCustomSqlInsert
CustomSql getCustomSqlInsert()
Obtain the custom SQL to be used for inserts for this entity- Returns:
- The custom insert SQL
-
getCustomSqlUpdate
CustomSql getCustomSqlUpdate()
Obtain the custom SQL to be used for updates for this entity- Returns:
- The custom update SQL
-
getCustomSqlDelete
CustomSql getCustomSqlDelete()
Obtain the custom SQL to be used for deletes for this entity- Returns:
- The custom delete SQL
-
getSynchronizedTableNames
java.lang.String[] getSynchronizedTableNames()
Obtain any additional table names on which to synchronize (auto flushing) this entity.- Returns:
- Additional synchronized table names or 0 sized String array, never return null.
-
getDiscriminatorMatchValue
java.lang.String getDiscriminatorMatchValue()
Get the actual discriminator value in case of a single table inheritance- Returns:
- the actual discriminator value in case of a single table inheritance or
null
in case there is no explicit value or a different inheritance scheme
-
getFilterSources
FilterSource[] getFilterSources()
Obtain the filters for this entity.- Returns:
- returns an array of the filters for this entity.
-
getNamedQueries
java.util.List<JaxbHbmNamedQueryType> getNamedQueries()
-
getNamedNativeQueries
java.util.List<JaxbHbmNamedNativeQueryType> getNamedNativeQueries()
-
quoteIdentifiersLocalToEntity
TruthValue quoteIdentifiersLocalToEntity()
-
-