Top Description Methods
org.hibernate.boot.model.source.spi

public Interface EntitySource

extends IdentifiableTypeSource, ToolingHintContextContainer, EntityNamingSourceContributor
Known Direct Subinterfaces
org.hibernate.boot.model.source.spi.SubclassEntitySource
Known Direct Implementers
org.hibernate.boot.model.source.internal.hbm.AbstractEntitySourceImpl
Imports
java.util.List, .Map, org.hibernate.boot.jaxb.hbm.spi.JaxbHbmNamedNativeQueryType, .JaxbHbmNamedQueryType, org.hibernate.boot.model.CustomSql, .TruthValue
Contract describing source of information related to mapping an entity.
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

returns the batch-size.
getBatchSize()

Obtain the batch-size to be applied when initializing proxies of this entity.

public String

Returns:

THe custom loader query name
getCustomLoaderName()

Obtain the name of a named-query that will be used for loading this entity

public String

Returns:

The custom persister class name
getCustomPersisterClassName()

Obtain the name of a custom persister class to be used.

public CustomSql

Returns:

The custom delete SQL
getCustomSqlDelete()

Obtain the custom SQL to be used for deletes for this entity

public CustomSql

Returns:

The custom insert SQL
getCustomSqlInsert()

Obtain the custom SQL to be used for inserts for this entity

public CustomSql

Returns:

The custom update SQL
getCustomSqlUpdate()

Obtain the custom SQL to be used for updates for this entity

public String

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
getDiscriminatorMatchValue()

Get the actual discriminator value in case of a single table inheritance

public FilterSource[]

Returns:

returns an array of the filters for this entity.
getFilterSources()

Obtain the filters for this entity.

public List<JaxbHbmNamedNativeQueryType>
getNamedNativeQueries()

public List<JaxbHbmNamedQueryType>
getNamedQueries()

public TableSpecificationSource

Returns:

The primary table.
getPrimaryTable()

Obtain the primary table for this entity.

public String

Returns:

The proxy interface name
getProxy()

For lazy entities, obtain the interface to use in constructing its proxies.

public Map<String, SecondaryTableSource>

Returns:

returns an iterator over the secondary tables for this entity
getSecondaryTableMap()

Obtain the secondary tables for this entity

public String[]

Returns:

Additional synchronized table names or 0 sized String array, never return null.
getSynchronizedTableNames()

Obtain any additional table names on which to synchronize (auto flushing) this entity.

public String
getXmlNodeName()

public Boolean

Returns:

true indicates the entity is abstract; false non-abstract; null indicates that a reflection check should be done when building the persister.
isAbstract()

Is the entity abstract?

public boolean

Returns:

true indicates dynamic inserts will be used; false otherwise.
isDynamicInsert()

Did the source specify dynamic inserts?

public boolean

Returns:

true indicates dynamic updates will be used; false otherwise.
isDynamicUpdate()

Did the source specify dynamic updates?

public boolean

Returns:

true indicates the entity is lazy; false non-lazy.
isLazy()

Is this entity lazy (proxyable)?

public boolean

Returns:

true indicates selects will be done; false otherwise.
isSelectBeforeUpdate()

Did the source specify to perform selects to decide whether to perform (detached) updates?

public TruthValue
quoteIdentifiersLocalToEntity()

Inherited from org.hibernate.boot.model.source.spi.EntityNamingSourceContributor:
getEntityNamingSource
Inherited from org.hibernate.boot.model.source.spi.IdentifiableTypeSource:
getHierarchygetJpaCallbackClassesgetLocalMetadataBuildingContextgetOrigingetSubTypesgetSuperTypegetTypeName
Inherited from org.hibernate.boot.model.source.spi.ToolingHintContextContainer:
getToolingHintContext

Method Detail

getBatchSizeback to summary
public int getBatchSize()

Obtain the batch-size to be applied when initializing proxies of this entity.

Returns:int

returns the batch-size.

getCustomLoaderNameback to summary
public String getCustomLoaderName()

Obtain the name of a named-query that will be used for loading this entity

Returns:String

THe custom loader query name

getCustomPersisterClassNameback to summary
public String getCustomPersisterClassName()

Obtain the name of a custom persister class to be used.

Returns:String

The custom persister class name

getCustomSqlDeleteback to summary
public CustomSql getCustomSqlDelete()

Obtain the custom SQL to be used for deletes for this entity

Returns:CustomSql

The custom delete SQL

getCustomSqlInsertback to summary
public CustomSql getCustomSqlInsert()

Obtain the custom SQL to be used for inserts for this entity

Returns:CustomSql

The custom insert SQL

getCustomSqlUpdateback to summary
public CustomSql getCustomSqlUpdate()

Obtain the custom SQL to be used for updates for this entity

Returns:CustomSql

The custom update SQL

getDiscriminatorMatchValueback to summary
public String getDiscriminatorMatchValue()

Get the actual discriminator value in case of a single table inheritance

Returns:String

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

getFilterSourcesback to summary
public FilterSource[] getFilterSources()

Obtain the filters for this entity.

Returns:FilterSource[]

returns an array of the filters for this entity.

getNamedNativeQueriesback to summary
public List<JaxbHbmNamedNativeQueryType> getNamedNativeQueries()
getNamedQueriesback to summary
public List<JaxbHbmNamedQueryType> getNamedQueries()
getPrimaryTableback to summary
public TableSpecificationSource getPrimaryTable()

Obtain the primary table for this entity.

Returns:TableSpecificationSource

The primary table.

getProxyback to summary
public String getProxy()

For lazy entities, obtain the interface to use in constructing its proxies.

Returns:String

The proxy interface name

getSecondaryTableMapback to summary
public Map<String, SecondaryTableSource> getSecondaryTableMap()

Obtain the secondary tables for this entity

Returns:Map<String, SecondaryTableSource>

returns an iterator over the secondary tables for this entity

getSynchronizedTableNamesback to summary
public String[] getSynchronizedTableNames()

Obtain any additional table names on which to synchronize (auto flushing) this entity.

Returns:String[]

Additional synchronized table names or 0 sized String array, never return null.

getXmlNodeNameback to summary
public String getXmlNodeName()
isAbstractback to summary
public Boolean isAbstract()

Is the entity abstract?

The implication is whether the entity maps to a database table.

Returns:Boolean

true indicates the entity is abstract; false non-abstract; null indicates that a reflection check should be done when building the persister.

isDynamicInsertback to summary
public boolean isDynamicInsert()

Did the source specify dynamic inserts?

Returns:boolean

true indicates dynamic inserts will be used; false otherwise.

isDynamicUpdateback to summary
public boolean isDynamicUpdate()

Did the source specify dynamic updates?

Returns:boolean

true indicates dynamic updates will be used; false otherwise.

isLazyback to summary
public boolean isLazy()

Is this entity lazy (proxyable)?

Returns:boolean

true indicates the entity is lazy; false non-lazy.

isSelectBeforeUpdateback to summary
public boolean isSelectBeforeUpdate()

Did the source specify to perform selects to decide whether to perform (detached) updates?

Returns:boolean

true indicates selects will be done; false otherwise.

quoteIdentifiersLocalToEntityback to summary
public TruthValue quoteIdentifiersLocalToEntity()