SingleTableEntityPersister

Class Overview

The default implementation of the EntityPersister interface. Implements the "table-per-class-hierarchy" or "roll-up" mapping strategy for an entity class and its inheritence hierarchy. This is implemented as a single table holding all classes in the hierarchy with a discrimator column used to determine which concrete class is referenced.

Summary

[Expand] Inherited Constants
From class org.hibernate.persister.entity.AbstractEntityPersister String ENTITY_CLASS
From interface org.hibernate.persister.entity.EntityPersister String ENTITY_ID The property name of the "special" identifier property in HQL
From interface org.hibernate.persister.entity.Loadable String ROWID_ALIAS

[Expand] Inherited Fields
From class org.hibernate.persister.entity.AbstractEntityPersister protected String[] customSQLDelete protected String[] customSQLInsert protected String[] customSQLUpdate protected boolean[] deleteCallable protected ExecuteUpdateResultCheckStyle[] deleteResultCheckStyles protected boolean[] insertCallable protected ExecuteUpdateResultCheckStyle[] insertResultCheckStyles protected final BasicEntityPropertyMapping propertyMapping protected final String rowIdName protected boolean[] updateCallable protected ExecuteUpdateResultCheckStyle[] updateResultCheckStyles
From interface org.hibernate.intercept.LazyPropertyInitializer public static final Serializable UNFETCHED_PROPERTY Marker value for uninitialized properties

[Expand] Inherited Methods
From class org.hibernate.persister.entity.AbstractEntityPersister void addDiscriminatorToInsert(Insert insert) void addDiscriminatorToSelect(SelectFragment select, String name, String suffix) void afterInitialize(Object entity, boolean lazyPropertiesAreUnfetched, SessionImplementor session) Called just after the entities properties have been initialized void afterReassociate(Object entity, SessionImplementor session) Called just after the entity has been reassociated with the session boolean canExtractIdOutOfEntity() Determine whether detached instances of this entity carry their own identifier value. boolean check(int rows, Serializable id, int tableNumber, Expectation expectation, PreparedStatement statement) String concretePropertySelectFragment(String alias, AbstractEntityPersister.InclusionChecker inclusionChecker) String concretePropertySelectFragment(String alias, boolean[] includeProperty) String concretePropertySelectFragment(String alias, ValueInclusion[] inclusions) String concretePropertySelectFragmentSansLeadingComma(String alias, boolean[] include) boolean consumesCollectionAlias() Very, very, very ugly... boolean consumesEntityAlias() Very, very, very ugly... int countSubclassProperties() How many properties are there, for this class and all subclasses? UniqueEntityLoader createEntityLoader(LockMode lockMode, LoadQueryInfluencers loadQueryInfluencers) UniqueEntityLoader createEntityLoader(LockMode lockMode) UniqueEntityLoader createEntityLoader(LockOptions lockOptions, LoadQueryInfluencers loadQueryInfluencers) String createFrom(int tableNumber, String alias) JoinFragment createJoin(String name, boolean innerJoin, boolean includeSubclasses) JoinFragment createJoin(int[] tableNumbers, String drivingAlias) void createLoaders() Object createProxy(Serializable id, SessionImplementor session) Create a new proxy instance void createQueryLoader() SelectFragment createSelect(int[] subclassColumnNumbers, int[] subclassFormulaNumbers) void createUniqueKeyLoaders() String createWhereByKey(int tableNumber, String alias) int dehydrate(Serializable id, Object[] fields, boolean[] includeProperty, boolean[][] includeColumns, int j, PreparedStatement st, SessionImplementor session) int dehydrate(Serializable id, Object[] fields, Object rowId, boolean[] includeProperty, boolean[][] includeColumns, int j, PreparedStatement ps, SessionImplementor session, int index) Marshall the fields of a persistent instance to a prepared statement void delete(Serializable id, Object version, Object object, SessionImplementor session) Delete an object void delete(Serializable id, Object version, int j, Object object, String sql, SessionImplementor session, Object[] loadedState) Perform an SQL DELETE String filterFragment(String alias, Map enabledFilters) Get the where clause filter, given a query alias and considering enabled session filters abstract String filterFragment(String alias) int[] findDirty(Object[] currentState, Object[] previousState, Object entity, SessionImplementor session) Locate the property-indices of all properties considered to be dirty. int[] findModified(Object[] old, Object[] current, Object entity, SessionImplementor session) Locate the property-indices of all properties considered to be dirty. Object forceVersionIncrement(Serializable id, Object currentVersion, SessionImplementor session) String fromJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses) Get the from clause part of any joins (optional operation) String generateDeleteString(int j) Generate the SQL that deletes a row by id (and version) String generateFilterConditionAlias(String rootAlias) The alias used for any filter conditions (mapped where-fragments or enabled-filters). String generateIdentityInsertString(boolean[] includeProperty) Used to generate an insery statement against the root table in the case of identifier generation strategies where the insert statement executions actually generates the identifier value. String generateInsertGeneratedValuesSelectString() String generateInsertString(boolean[] includeProperty, int j) String generateInsertString(boolean identityInsert, boolean[] includeProperty) String generateInsertString(boolean identityInsert, boolean[] includeProperty, int j) Generate the SQL that inserts a row String generateLazySelectString() LockingStrategy generateLocker(LockMode lockMode) String generateSelectVersionString() Generate the SQL that selects the version number by id String generateSnapshotSelectString() String generateTableAlias(String rootAlias, int tableNumber) String generateUpdateGeneratedValuesSelectString() String generateUpdateString(boolean[] includeProperty, int j, boolean useRowId) String generateUpdateString(boolean[] includeProperty, int j, Object[] oldFields, boolean useRowId) Generate the SQL that updates a row by id (and version) EntityRegionAccessStrategy getCacheAccessStrategy() Get the cache (optional operation) CacheEntryStructure getCacheEntryStructure() Get the cache structure CascadeStyle getCascadeStyle(int i) Get the cascade style of this (subclass closure) property ClassMetadata getClassMetadata() Get the user-visible metadata for the class (optional operation) Class getConcreteProxyClass(EntityMode entityMode) Get the proxy interface that instances of this concrete class will be cast to (optional operation). Object getCurrentVersion(Serializable id, SessionImplementor session) Retrieve the version number Object[] getDatabaseSnapshot(Serializable id, SessionImplementor session) Get the current database state of the object, in a "hydrated" form, without resolving identifiers String getDiscriminatorAlias() String getDiscriminatorAlias(String suffix) Get the result set aliases used for the identifier columns, given a suffix String getDiscriminatorColumnName() String getDiscriminatorColumnReaderTemplate() String getDiscriminatorColumnReaders() String getDiscriminatorFormulaTemplate() EntityMetamodel getEntityMetamodel() Retrieve the underlying entity metamodel instance... final String getEntityName() The entity name which this persister maps. EntityType getEntityType() SessionFactoryImplementor getFactory() Return the SessionFactory to which this persister "belongs". FetchMode getFetchMode(int i) May this (subclass closure) property be fetched using an SQL outerjoin? Serializable getIdentifier(Object object, EntityMode entityMode) Get the identifier of an instance (throw an exception if no identifier property) Serializable getIdentifier(Object entity, SessionImplementor session) Get the identifier of an instance (throw an exception if no identifier property) String[] getIdentifierAliases(String suffix) Get the result set aliases used for the identifier columns, given a suffix String[] getIdentifierAliases() String[] getIdentifierColumnNames() Get the names of columns used to persist the identifier String[] getIdentifierColumnReaderTemplates() String[] getIdentifierColumnReaders() int getIdentifierColumnSpan() IdentifierGenerator getIdentifierGenerator() Determine which identifier generation strategy is used for this entity. String getIdentifierPropertyName() Get the name of the identifier property (or return null) - need not return the name of an actual Java property Type getIdentifierType() Get the identifier type String getIdentitySelectString() Get the database-specific SQL command to retrieve the last generated IDENTITY value. String[] getKeyColumnNames() The columns to join on abstract String[] getKeyColumns(int j) Set getLazyProperties() Map getLoaders() final Class getMappedClass(EntityMode entityMode) The persistent class, or null String getMappedSuperclass() Get the class that this class is mapped as a subclass of - not necessarily the direct superclass String getName() An identifying name; a class name or collection role name. int[] getNaturalIdentifierProperties() If the entity defines a natural id (hasNaturalIdentifier()), which properties make up the natural id. Object[] getNaturalIdentifierSnapshot(Serializable id, SessionImplementor session) Retrieve the current state of the natural-id properties from the database. boolean[] getNonLazyPropertyUpdateability() boolean[] getPropertiesToInsert(Object[] fields) Transform the array of property indexes to an array of booleans, true when the property is insertable and non-null final boolean[] getPropertiesToUpdate(int[] dirtyProperties, boolean hasDirtyCollection) Transform the array of property indexes to an array of booleans, true when the property is dirty String[] getPropertyAliases(String suffix, int i) Get the result set aliases used for the property columns, given a suffix (properties of this class, only). CascadeStyle[] getPropertyCascadeStyles() Get the cascade styles of the properties (optional operation) boolean[] getPropertyCheckability() Get the "checkability" of the properties of this class (is the property dirty checked, does the cache need to be updated) boolean[][] getPropertyColumnInsertable() String[] getPropertyColumnNames(String propertyName) Get the column names for the given property path String[] getPropertyColumnNames(int i) Get the result set column names mapped for this property (properties of this class, only). int getPropertyColumnSpan(int i) boolean[][] getPropertyColumnUpdateable() String[] getPropertyColumnWriters(int i) int getPropertyIndex(String propertyName) Get the property number of the unique key property ValueInclusion[] getPropertyInsertGenerationInclusions() Which of the properties of this class are database generated values on insert? boolean[] getPropertyInsertability() Get the "insertability" of the properties of this class (does the property appear in an SQL INSERT) boolean[] getPropertyLaziness() Get the "laziness" of the properties of this class String[] getPropertyNames() Get the names of the class properties - doesn't have to be the names of the actual Java properties (used for XML generation only) boolean[] getPropertyNullability() Get the nullability of the properties of this class boolean[] getPropertySelectable() int getPropertySpan() String[] getPropertySubclassNames() abstract int[] getPropertyTableNumbers() abstract int[] getPropertyTableNumbersInSelect() Type getPropertyType(String propertyName) Get the type of a particular property by name. Type[] getPropertyTypes() Get the Hibernate types of the class properties boolean[] getPropertyUniqueness() ValueInclusion[] getPropertyUpdateGenerationInclusions() Which of the properties of this class are database generated values on update? boolean[] getPropertyUpdateability(Object entity, EntityMode entityMode) Which properties appear in the SQL update? (Initialized, updateable ones!) boolean[] getPropertyUpdateability() Get the "updateability" of the properties of this class (does the property appear in an SQL UPDATE) Object getPropertyValue(Object object, int i, EntityMode entityMode) Get the value of a particular property Object getPropertyValue(Object object, String propertyName, EntityMode entityMode) Get the value of a particular property Object[] getPropertyValues(Object object, EntityMode entityMode) Return the (loaded) values of the mapped properties of the object (not including backrefs) Object[] getPropertyValuesToInsert(Object object, Map mergeMap, SessionImplementor session) Return the values of the insertable properties of the object (including backrefs) boolean[] getPropertyVersionability() Get the "versionability" of the properties of this class (is the property optimistic-locked) Serializable[] getQuerySpaces() Returns an array of objects that identify spaces in which properties of this entity are persisted, for instances of this class and its subclasses. String getRootEntityName() Returns an object that identifies the space in which identifiers of this entity hierarchy are unique. String getRootTableAlias(String drivingAlias) Get the SQL alias this persister would use for the root table given the passed driving alias. String[] getRootTableIdentifierColumnNames() Get the names of columns on the root table used to persist the identifier. String[] getRootTableKeyColumnNames() The names of the primary key columns in the root table. String getRootTableName() Locks are always applied to the "root table". String[] getSQLDeleteStrings() String getSQLIdentityInsertString() The query that inserts a row, letting the database generate an id String[] getSQLInsertStrings() String getSQLLazySelectString() String[] getSQLLazyUpdateByRowIdStrings() String[] getSQLLazyUpdateStrings() String getSQLSnapshotSelectString() String[] getSQLUpdateByRowIdStrings() String[] getSQLUpdateStrings() String getSQLWhereString(String alias) String getSelectByUniqueKeyString(String propertyName) Get a SQL select string that performs a select based on a unique key determined by the given property name). String getSequentialSelect(String entityName) String[] getSubclassColumnAliasClosure() String[] getSubclassColumnClosure() boolean[] getSubclassColumnLazyiness() String[] getSubclassColumnReaderTemplateClosure() abstract int[] getSubclassColumnTableNumberClosure() EntityPersister getSubclassEntityPersister(Object instance, SessionFactoryImplementor factory, EntityMode entityMode) A request has already identified the entity-name of this persister as the mapping for the given instance. String[] getSubclassFormulaAliasClosure() String[] getSubclassFormulaClosure() boolean[] getSubclassFormulaLazyiness() abstract int[] getSubclassFormulaTableNumberClosure() String[] getSubclassFormulaTemplateClosure() String[] getSubclassPropertyColumnAliases(String propertyName, String suffix) Return the column alias names used to persist/query the named property of the class or a subclass (optional operation). String[][] getSubclassPropertyColumnNameClosure() String[] getSubclassPropertyColumnNames(int i) Return the column names used to persist the numbered property of the class or a subclass. String[] getSubclassPropertyColumnNames(String propertyName) Return the column names used to persist/query the named property of the class or a subclass (optional operation). String[][] getSubclassPropertyColumnReaderClosure() String[][] getSubclassPropertyColumnReaderTemplateClosure() Queryable.Declarer getSubclassPropertyDeclarer(String propertyPath) Determine whether the given property is declared by our mapped class, our super class, or one of our subclasses... String[][] getSubclassPropertyFormulaTemplateClosure() String getSubclassPropertyName(int i) Get the name of the numbered property of the class or a subclass. String[] getSubclassPropertyNameClosure() String[] getSubclassPropertySubclassNameClosure() abstract int getSubclassPropertyTableNumber(int i) int getSubclassPropertyTableNumber(String propertyPath) Warning: When there are duplicated property names in the subclasses of the class, this method may return the wrong table number for the duplicated subclass property (note that SingleTableEntityPersister defines an overloaded form which takes the entity name. Type getSubclassPropertyType(int i) Get the type of the numbered property of the class or a subclass. Type[] getSubclassPropertyTypeClosure() abstract String[] getSubclassTableKeyColumns(int j) abstract String getSubclassTableName(int j) Get the name of the table with the given index from the internal array. abstract int getSubclassTableSpan() abstract String getTableName(int j) abstract int getTableSpan() boolean[] getTableUpdateNeeded(int[] dirtyProperties, boolean hasDirtyCollection) Decide which tables need to be updated. String getTemporaryIdTableDDL() Get the appropriate DDL command for generating the temporary table to be used to (potentially) store id values when performing bulk update/deletes. String getTemporaryIdTableName() Get the name of the temporary table to be used to (potentially) store id values when performing bulk update/deletes. EntityTuplizer getTuplizer(EntityMode entityMode) EntityTuplizer getTuplizer(SessionImplementor session) Type getType() Get the type of the thing containing the properties DiscriminatorMetadata getTypeDiscriminatorMetadata() Retrieve the information needed to properly deal with this entity's discriminator in a query. Object getVersion(Object object, EntityMode entityMode) Get the version number (or timestamp) from the object's version property (or return null if not versioned) String getVersionColumnName() For versioned entities, get the name of the column (again, expected on the root table) used to store the version values. Comparator getVersionComparator() Get the comparator used to compare two different version values. int getVersionProperty() If isVersioned(), then what is the index of the property holding the locking value. String getVersionSelectString() VersionType getVersionType() If isVersioned(), then what is the type of the property holding the locking value. String getVersionedTableName() EntityMode guessEntityMode(Object object) Try to discover the entity mode from the entity instance boolean hasCache() Does this class have a cache. boolean hasCascades() Determine whether this entity has any non-none cascading. boolean hasCollections() Determine whether this entity contains references to persistent collections. boolean hasEmbeddedCompositeIdentifier() boolean hasFormulaProperties() boolean hasIdentifierProperty() Determine whether the entity has a particular property holding the identifier value. boolean hasInsertGeneratedProperties() Does this entity define any properties as being database generated on insert? boolean hasLazyProperties() Determine whether this entity defines any lazy properties (ala bytecode instrumentation). boolean hasMutableProperties() Determine whether any properties of this entity are considered mutable. boolean hasNaturalIdentifier() Determine whether this entity defines a natural identifier. boolean hasProxy() Determine whether this entity supports dynamic proxies. boolean hasRowId() Does the result set contain rowids? boolean hasSequentialSelect() boolean hasSubclasses() Does this entity have mapped subclasses? boolean hasSubselectLoadableCollections() Determine whether this entity contains references to persistent collections which are fetchable by subselect? boolean hasUninitializedLazyProperties(Object object, EntityMode entityMode) Does the given instance have any uninitialized lazy properties? boolean hasUpdateGeneratedProperties() Does this entity define any properties as being database generated on update? boolean hasWhere() Object[] hydrate(ResultSet rs, Serializable id, Object object, Loadable rootLoadable, String[][] suffixedPropertyColumns, boolean allProperties, SessionImplementor session) Unmarshall the fields of a persistent instance from a result set, without resolving associations or collections. String identifierSelectFragment(String name, String suffix) Given a query alias and an identifying suffix, render the intentifier select fragment. boolean implementsLifecycle(EntityMode entityMode) Does the class implement the Lifecycle interface. boolean implementsValidatable(EntityMode entityMode) Does the class implement the Validatable interface. void initLockers() void initPropertyPaths(Mapping mapping) void initSubclassPropertyAliasesMap(PersistentClass model) Must be called by subclasses, at the end of their constructors Object initializeLazyProperty(String fieldName, Object entity, SessionImplementor session) Initialize the property, and return its new value void insert(Serializable id, Object[] fields, boolean[] notNull, int j, String sql, Object object, SessionImplementor session) Perform an SQL INSERT. void insert(Serializable id, Object[] fields, Object object, SessionImplementor session) Persist an instance Serializable insert(Object[] fields, boolean[] notNull, String sql, Object object, SessionImplementor session) Perform an SQL INSERT, and then retrieve a generated identifier. Serializable insert(Object[] fields, Object object, SessionImplementor session) Persist an instance, using a natively generated identifier (optional operation) Object instantiate(Serializable id, EntityMode entityMode) Create a class instance initialized with the given identifier Object instantiate(Serializable id, SessionImplementor session) Create a class instance initialized with the given identifier boolean isAbstract() Is this an abstract class? boolean isBatchLoadable() Is batch loading enabled? boolean isBatchable() boolean isCacheInvalidationRequired() We can't immediately add to the cache if we have formulas which must be evaluated, or if we have the possibility of two concurrent updates to the same item being merged on the database. abstract boolean isClassOrSuperclassTable(int j) boolean isCollection() Is this instance actually a CollectionPersister? boolean isDefinedOnSubclass(int i) Is this property defined on a subclass of the mapped class. boolean isDeleteCallable(int j) boolean isExplicitPolymorphism() Is this class explicit polymorphism only? boolean isIdentifierAssignedByInsert() Are identifiers of this entity assigned known before the insert execution? Or, are they generated (in the database) by the insert execution. boolean isInherited() Determine whether the entity is inherited one or more other entities. boolean isInsertCallable(int j) boolean isInstance(Object object, EntityMode entityMode) Is the given object an instance of this entity? boolean isInstrumented(EntityMode entityMode) Has the class actually been bytecode instrumented? boolean isInverseSubclassTable(int j) boolean isInverseTable(int j) boolean isLazyPropertiesCacheable() Should lazy properties of this entity be cached? boolean isMultiTable() Is the inheritence hierarchy described by this persister contained across multiple tables? boolean isMutable() Determine whether instances of this entity are considered mutable. boolean isNullableSubclassTable(int j) boolean isNullableTable(int j) boolean isPolymorphic() abstract boolean isPropertyOfTable(int property, int j) boolean isSelectBeforeUpdateRequired() Is select snapshot before update enabled? boolean isSubclassEntityName(String entityName) Determine whether the given name represents a subclass entity (or this entity itself) of the entity mapped by this persister. boolean isSubclassPropertyDeferred(String propertyName, String entityName) boolean isSubclassPropertyNullable(int i) Is the numbered property of the class of subclass nullable? boolean isSubclassTableLazy(int j) boolean isSubclassTableSequentialSelect(int j) abstract boolean isTableCascadeDeleteEnabled(int j) Boolean isTransient(Object entity, SessionImplementor session) Is this a new transient instance? boolean isUpdateCallable(int j) boolean isVersionPropertyGenerated() Does this entity contain a version property that is defined to be database generated? boolean isVersionPropertyInsertable() Is the version property included in insert statements? boolean isVersioned() Determine whether optimistic locking by column is enabled for this entity. Object load(Serializable id, Object optionalObject, LockOptions lockOptions, SessionImplementor session) Load an instance using either the forUpdateLoader or the outer joining loader, depending upon the value of the lock parameter Object load(Serializable id, Object optionalObject, LockMode lockMode, SessionImplementor session) Load an instance using either the forUpdateLoader or the outer joining loader, depending upon the value of the lock parameter Object loadByUniqueKey(String propertyName, Object uniqueKey, SessionImplementor session) Load an instance of the persistent class, by a unique key other than the primary key. void lock(Serializable id, Object version, Object object, LockOptions lockOptions, SessionImplementor session) Do a version check (optional operation) void lock(Serializable id, Object version, Object object, LockMode lockMode, SessionImplementor session) Do a version check (optional operation) void logStaticSQL() String oneToManyFilterFragment(String alias) final int optimisticLockMode() void postConstruct(Mapping mapping) void postInstantiate() Finish the initialization of this object. void processInsertGeneratedProperties(Serializable id, Object entity, Object[] state, SessionImplementor session) Perform a select to retrieve the values of any generated properties back from the database, injecting these generated values into the given entity as well as writing this state to the PersistenceContext. void processUpdateGeneratedProperties(Serializable id, Object entity, Object[] state, SessionImplementor session) Perform a select to retrieve the values of any generated properties back from the database, injecting these generated values into the given entity as well as writing this state to the PersistenceContext. String propertySelectFragment(String tableAlias, String suffix, boolean allProperties) Given a query alias and an identifying suffix, render the property select fragment. SelectFragment propertySelectFragmentFragment(String tableAlias, String suffix, boolean allProperties) void registerAffectingFetchProfile(String fetchProfileName) Register the name of a fetch profile determined to have an affect on the underlying loadable in regards to the fact that the underlying load SQL needs to be adjust when the given fetch profile is enabled. String renderSelect(int[] tableNumbers, int[] columnNumbers, int[] formulaNumbers) void resetIdentifier(Object entity, Serializable currentId, Object currentVersion, SessionImplementor session) Set the identifier and version of the given instance back to its "unsaved" value. void resetIdentifier(Object entity, Serializable currentId, Object currentVersion, EntityMode entityMode) Set the identifier and version of the given instance back to its "unsaved" value. String selectFragment(String alias, String suffix) Generate a list of collection index, key and element columns final String selectFragment(Joinable rhs, String rhsAlias, String lhsAlias, String entitySuffix, String collectionSuffix, boolean includeCollectionColumns) All columns to select, when loading. void setIdentifier(Object entity, Serializable id, SessionImplementor session) Inject the identifier value into the given entity. void setIdentifier(Object entity, Serializable id, EntityMode entityMode) Inject the identifier value into the given entity. void setPropertyValue(Object object, String propertyName, Object value, EntityMode entityMode) Set the value of a particular (named) property void setPropertyValue(Object object, int i, Object value, EntityMode entityMode) Set the value of a particular property void setPropertyValues(Object object, Object[] values, EntityMode entityMode) Set the given values to the mapped properties of the given object String[] toColumns(String name, int i) Given the number of a property of a subclass, and a table alias, return the aliased column names. String[] toColumns(String alias, String propertyName) Given a query alias and a property path, return the qualified column name String[] toColumns(String propertyName) Given a property path, return the corresponding column name(s). String toString() Type toType(String propertyName) Given a component path expression, get the type of the property boolean update(Serializable id, Object[] fields, Object[] oldFields, Object rowId, boolean[] includeProperty, int j, Object oldVersion, Object object, String sql, SessionImplementor session) void update(Serializable id, Object[] fields, int[] dirtyFields, boolean hasDirtyCollection, Object[] oldFields, Object oldVersion, Object object, Object rowId, SessionImplementor session) Update an object void updateOrInsert(Serializable id, Object[] fields, Object[] oldFields, Object rowId, boolean[] includeProperty, int j, Object oldVersion, Object object, String sql, SessionImplementor session) Perform an SQL UPDATE or SQL INSERT boolean useDynamicInsert() boolean useDynamicUpdate() boolean useGetGeneratedKeys() boolean useInsertSelectIdentity() String whereJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses) Get the where clause part of any joins (optional operation)
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.hibernate.cache.OptimisticCacheSource abstract Comparator getVersionComparator() Get the comparator used to compare two different version values. abstract boolean isVersioned() Is the data to be cached considered versioned? If true, it is illegal for getVersionComparator() to return null.
From interface org.hibernate.id.PostInsertIdentityPersister abstract String getIdentitySelectString() Get the database-specific SQL command to retrieve the last generated IDENTITY value. abstract String[] getRootTableKeyColumnNames() The names of the primary key columns in the root table. abstract String getSelectByUniqueKeyString(String propertyName) Get a SQL select string that performs a select based on a unique key determined by the given property name).
From interface org.hibernate.intercept.LazyPropertyInitializer abstract Object initializeLazyProperty(String fieldName, Object entity, SessionImplementor session) Initialize the property, and return its new value
From interface org.hibernate.metadata.ClassMetadata abstract String getEntityName() The name of the entity abstract Serializable getIdentifier(Object object, EntityMode entityMode) This method is deprecated. Use getIdentifier(Object, SessionImplementor) instead abstract Serializable getIdentifier(Object entity, SessionImplementor session) Get the identifier of an instance (throw an exception if no identifier property) abstract String getIdentifierPropertyName() Get the name of the identifier property (or return null) abstract Type getIdentifierType() Get the identifier Hibernate type abstract Class getMappedClass(EntityMode entityMode) The persistent class, or null abstract int[] getNaturalIdentifierProperties() Which properties hold the natural id? abstract boolean[] getPropertyLaziness() Get the "laziness" of the properties of this class abstract String[] getPropertyNames() Get the names of the class' persistent properties abstract boolean[] getPropertyNullability() Get the nullability of the class' persistent properties abstract Type getPropertyType(String propertyName) Get the type of a particular (named) property abstract Type[] getPropertyTypes() Get the Hibernate types of the class properties abstract Object getPropertyValue(Object object, String propertyName, EntityMode entityMode) Get the value of a particular (named) property abstract Object[] getPropertyValues(Object entity, EntityMode entityMode) Extract the property values from the given entity. abstract Object[] getPropertyValuesToInsert(Object entity, Map mergeMap, SessionImplementor session) Return the values of the mapped properties of the object abstract Object getVersion(Object object, EntityMode entityMode) Get the version number (or timestamp) from the object's version property (or return null if not versioned) abstract int getVersionProperty() Get the index of the version property abstract boolean hasIdentifierProperty() Does this class have an identifier property? abstract boolean hasNaturalIdentifier() Does this entity declare a natural id? abstract boolean hasProxy() Does this class support dynamic proxies? abstract boolean hasSubclasses() Does this entity have mapped subclasses? abstract boolean implementsLifecycle(EntityMode entityMode) Does the class implement the Lifecycle interface? abstract boolean implementsValidatable(EntityMode entityMode) Does the class implement the Validatable interface? abstract Object instantiate(Serializable id, SessionImplementor session) Create a class instance initialized with the given identifier abstract Object instantiate(Serializable id, EntityMode entityMode) This method is deprecated. Use instantiate(Serializable, SessionImplementor) instead abstract boolean isInherited() Does this entity extend a mapped superclass? abstract boolean isMutable() Are instances of this class mutable? abstract boolean isVersioned() Are instances of this class versioned by a timestamp or version number column? abstract void setIdentifier(Object entity, Serializable id, EntityMode entityMode) This method is deprecated. Use setIdentifier(Object, Serializable, SessionImplementor) instead. abstract void setIdentifier(Object entity, Serializable id, SessionImplementor session) Inject the identifier value into the given entity. abstract void setPropertyValue(Object object, String propertyName, Object value, EntityMode entityMode) Set the value of a particular (named) property abstract void setPropertyValues(Object object, Object[] values, EntityMode entityMode) Set the given values to the mapped properties of the given object
From interface org.hibernate.persister.entity.EntityPersister abstract void afterInitialize(Object entity, boolean lazyPropertiesAreUnfetched, SessionImplementor session) Called just after the entities properties have been initialized abstract void afterReassociate(Object entity, SessionImplementor session) Called just after the entity has been reassociated with the session abstract boolean canExtractIdOutOfEntity() Determine whether detached instances of this entity carry their own identifier value. abstract Object createProxy(Serializable id, SessionImplementor session) Create a new proxy instance abstract void delete(Serializable id, Object version, Object object, SessionImplementor session) Delete a persistent instance abstract int[] findDirty(Object[] currentState, Object[] previousState, Object owner, SessionImplementor session) Compare the two snapshots to determine if they represent dirty state. abstract int[] findModified(Object[] old, Object[] current, Object object, SessionImplementor session) Compare the two snapshots to determine if they represent modified state. abstract Object forceVersionIncrement(Serializable id, Object currentVersion, SessionImplementor session) abstract EntityRegionAccessStrategy getCacheAccessStrategy() Get the cache (optional operation) abstract CacheEntryStructure getCacheEntryStructure() Get the cache structure abstract ClassMetadata getClassMetadata() Get the user-visible metadata for the class (optional operation) abstract Class getConcreteProxyClass(EntityMode entityMode) Get the proxy interface that instances of this concrete class will be cast to (optional operation). abstract Object getCurrentVersion(Serializable id, SessionImplementor session) Get the current version of the object, or return null if there is no row for the given identifier. abstract Object[] getDatabaseSnapshot(Serializable id, SessionImplementor session) Get the current database state of the object, in a "hydrated" form, without resolving identifiers abstract EntityMetamodel getEntityMetamodel() Retrieve the underlying entity metamodel instance... abstract String getEntityName() The entity name which this persister maps. abstract SessionFactoryImplementor getFactory() Return the SessionFactory to which this persister "belongs". abstract Serializable getIdentifier(Object entity, SessionImplementor session) Get the identifier of an instance (throw an exception if no identifier property) abstract Serializable getIdentifier(Object object, EntityMode entityMode) This method is deprecated. Use getIdentifier(Object, SessionImplementor) instead abstract IdentifierGenerator getIdentifierGenerator() Determine which identifier generation strategy is used for this entity. abstract String getIdentifierPropertyName() Get the name of the identifier property (or return null) - need not return the name of an actual Java property abstract Type getIdentifierType() Get the identifier type abstract Class getMappedClass(EntityMode entityMode) The persistent class, or null abstract int[] getNaturalIdentifierProperties() If the entity defines a natural id (hasNaturalIdentifier()), which properties make up the natural id. abstract Object[] getNaturalIdentifierSnapshot(Serializable id, SessionImplementor session) Retrieve the current state of the natural-id properties from the database. abstract CascadeStyle[] getPropertyCascadeStyles() Get the cascade styles of the properties (optional operation) abstract boolean[] getPropertyCheckability() Get the "checkability" of the properties of this class (is the property dirty checked, does the cache need to be updated) abstract ValueInclusion[] getPropertyInsertGenerationInclusions() Which of the properties of this class are database generated values on insert? abstract boolean[] getPropertyInsertability() Get the "insertability" of the properties of this class (does the property appear in an SQL INSERT) abstract boolean[] getPropertyLaziness() abstract String[] getPropertyNames() Get the names of the class properties - doesn't have to be the names of the actual Java properties (used for XML generation only) abstract boolean[] getPropertyNullability() Get the nullability of the properties of this class abstract Serializable[] getPropertySpaces() Returns an array of objects that identify spaces in which properties of this entity are persisted, for instances of this class only. abstract Type getPropertyType(String propertyName) Get the type of a particular property by name. abstract Type[] getPropertyTypes() Get the Hibernate types of the class properties abstract ValueInclusion[] getPropertyUpdateGenerationInclusions() Which of the properties of this class are database generated values on update? abstract boolean[] getPropertyUpdateability() Get the "updateability" of the properties of this class (does the property appear in an SQL UPDATE) abstract Object getPropertyValue(Object object, int i, EntityMode entityMode) Get the value of a particular property abstract Object getPropertyValue(Object object, String propertyName, EntityMode entityMode) Get the value of a particular property abstract Object[] getPropertyValues(Object object, EntityMode entityMode) Return the (loaded) values of the mapped properties of the object (not including backrefs) abstract Object[] getPropertyValuesToInsert(Object object, Map mergeMap, SessionImplementor session) Return the values of the insertable properties of the object (including backrefs) abstract boolean[] getPropertyVersionability() Get the "versionability" of the properties of this class (is the property optimistic-locked) abstract Serializable[] getQuerySpaces() Returns an array of objects that identify spaces in which properties of this entity are persisted, for instances of this class and its subclasses. abstract String getRootEntityName() Returns an object that identifies the space in which identifiers of this entity hierarchy are unique. abstract EntityPersister getSubclassEntityPersister(Object instance, SessionFactoryImplementor factory, EntityMode entityMode) A request has already identified the entity-name of this persister as the mapping for the given instance. abstract Object getVersion(Object object, EntityMode entityMode) Get the version number (or timestamp) from the object's version property (or return null if not versioned) abstract int getVersionProperty() If isVersioned(), then what is the index of the property holding the locking value. abstract VersionType getVersionType() If isVersioned(), then what is the type of the property holding the locking value. abstract EntityMode guessEntityMode(Object object) Try to discover the entity mode from the entity instance abstract boolean hasCache() Does this class have a cache. abstract boolean hasCascades() Determine whether this entity has any non-none cascading. abstract boolean hasCollections() Determine whether this entity contains references to persistent collections. abstract boolean hasIdentifierProperty() Determine whether the entity has a particular property holding the identifier value. abstract boolean hasInsertGeneratedProperties() Does this entity define any properties as being database generated on insert? abstract boolean hasLazyProperties() Determine whether this entity defines any lazy properties (ala bytecode instrumentation). abstract boolean hasMutableProperties() Determine whether any properties of this entity are considered mutable. abstract boolean hasNaturalIdentifier() Determine whether this entity defines a natural identifier. abstract boolean hasProxy() Determine whether this entity supports dynamic proxies. abstract boolean hasSubselectLoadableCollections() Determine whether this entity contains references to persistent collections which are fetchable by subselect? abstract boolean hasUninitializedLazyProperties(Object object, EntityMode entityMode) Does the given instance have any uninitialized lazy properties? abstract boolean hasUpdateGeneratedProperties() Does this entity define any properties as being database generated on update? abstract boolean implementsLifecycle(EntityMode entityMode) Does the class implement the Lifecycle interface. abstract boolean implementsValidatable(EntityMode entityMode) Does the class implement the Validatable interface. abstract Serializable insert(Object[] fields, Object object, SessionImplementor session) Persist an instance, using a natively generated identifier (optional operation) abstract void insert(Serializable id, Object[] fields, Object object, SessionImplementor session) Persist an instance abstract Object instantiate(Serializable id, SessionImplementor session) Create a class instance initialized with the given identifier abstract Object instantiate(Serializable id, EntityMode entityMode) This method is deprecated. Use instantiate(Serializable, SessionImplementor) instead abstract boolean isBatchLoadable() Is batch loading enabled? abstract boolean isCacheInvalidationRequired() Should we always invalidate the cache instead of recaching updated state abstract boolean isIdentifierAssignedByInsert() Are identifiers of this entity assigned known before the insert execution? Or, are they generated (in the database) by the insert execution. abstract boolean isInherited() Determine whether the entity is inherited one or more other entities. abstract boolean isInstance(Object object, EntityMode entityMode) Is the given object an instance of this entity? abstract boolean isInstrumented(EntityMode entityMode) Has the class actually been bytecode instrumented? abstract boolean isLazyPropertiesCacheable() Should lazy properties of this entity be cached? abstract boolean isMutable() Determine whether instances of this entity are considered mutable. abstract boolean isSelectBeforeUpdateRequired() Is select snapshot before update enabled? abstract boolean isSubclassEntityName(String entityName) Determine whether the given name represents a subclass entity (or this entity itself) of the entity mapped by this persister. abstract Boolean isTransient(Object object, SessionImplementor session) Is this a new transient instance? abstract boolean isVersionPropertyGenerated() Does this entity contain a version property that is defined to be database generated? abstract boolean isVersioned() Determine whether optimistic locking by column is enabled for this entity. abstract Object load(Serializable id, Object optionalObject, LockOptions lockOptions, SessionImplementor session) Load an instance of the persistent class. abstract Object load(Serializable id, Object optionalObject, LockMode lockMode, SessionImplementor session) Load an instance of the persistent class. abstract void lock(Serializable id, Object version, Object object, LockMode lockMode, SessionImplementor session) Do a version check (optional operation) abstract void lock(Serializable id, Object version, Object object, LockOptions lockOptions, SessionImplementor session) Do a version check (optional operation) abstract void postInstantiate() Finish the initialization of this object. abstract void processInsertGeneratedProperties(Serializable id, Object entity, Object[] state, SessionImplementor session) Perform a select to retrieve the values of any generated properties back from the database, injecting these generated values into the given entity as well as writing this state to the PersistenceContext. abstract void processUpdateGeneratedProperties(Serializable id, Object entity, Object[] state, SessionImplementor session) Perform a select to retrieve the values of any generated properties back from the database, injecting these generated values into the given entity as well as writing this state to the PersistenceContext. abstract void resetIdentifier(Object entity, Serializable currentId, Object currentVersion, EntityMode entityMode) This method is deprecated. Use resetIdentifier(Object, Serializable, Object, SessionImplementor) instead abstract void resetIdentifier(Object entity, Serializable currentId, Object currentVersion, SessionImplementor session) Set the identifier and version of the given instance back to its "unsaved" value. abstract void setIdentifier(Object entity, Serializable id, SessionImplementor session) Inject the identifier value into the given entity. abstract void setIdentifier(Object entity, Serializable id, EntityMode entityMode) This method is deprecated. Use setIdentifier(Object, Serializable, SessionImplementor) instead. abstract void setPropertyValue(Object object, int i, Object value, EntityMode entityMode) Set the value of a particular property abstract void setPropertyValues(Object object, Object[] values, EntityMode entityMode) Set the given values to the mapped properties of the given object abstract void update(Serializable id, Object[] fields, int[] dirtyFields, boolean hasDirtyCollection, Object[] oldFields, Object oldVersion, Object object, Object rowId, SessionImplementor session) Update a persistent instance
From interface org.hibernate.persister.entity.Joinable abstract boolean consumesCollectionAlias() Very, very, very ugly... abstract boolean consumesEntityAlias() Very, very, very ugly... abstract String filterFragment(String alias, Map enabledFilters) Get the where clause filter, given a query alias and considering enabled session filters abstract String fromJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses) Get the from clause part of any joins (optional operation) abstract String[] getKeyColumnNames() The columns to join on abstract String getName() An identifying name; a class name or collection role name. abstract String getTableName() The table to join to. abstract boolean isCollection() Is this instance actually a CollectionPersister? abstract String oneToManyFilterFragment(String alias) abstract String selectFragment(Joinable rhs, String rhsAlias, String lhsAlias, String currentEntitySuffix, String currentCollectionSuffix, boolean includeCollectionColumns) All columns to select, when loading. abstract String whereJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses) Get the where clause part of any joins (optional operation)
From interface org.hibernate.persister.entity.Loadable abstract String getDiscriminatorAlias(String suffix) Get the result set aliases used for the identifier columns, given a suffix abstract String getDiscriminatorColumnName() abstract Type getDiscriminatorType() Get the discriminator type abstract String[] getIdentifierAliases(String suffix) Get the result set aliases used for the identifier columns, given a suffix abstract String[] getIdentifierColumnNames() Get the names of columns used to persist the identifier abstract String[] getPropertyAliases(String suffix, int i) Get the result set aliases used for the property columns, given a suffix (properties of this class, only). abstract String[] getPropertyColumnNames(int i) Get the result set column names mapped for this property (properties of this class, only). abstract String getSubclassForDiscriminatorValue(Object value) Get the concrete subclass corresponding to the given discriminator value abstract boolean hasRowId() Does the result set contain rowids? abstract boolean hasSubclasses() Does this persistent class have subclasses? abstract Object[] hydrate(ResultSet rs, Serializable id, Object object, Loadable rootLoadable, String[][] suffixedPropertyColumns, boolean allProperties, SessionImplementor session) Retrieve property values from one row of a result set abstract boolean isAbstract() abstract void registerAffectingFetchProfile(String fetchProfileName) Register the name of a fetch profile determined to have an affect on the underlying loadable in regards to the fact that the underlying load SQL needs to be adjust when the given fetch profile is enabled.
From interface org.hibernate.persister.entity.Lockable abstract String getRootTableAlias(String drivingAlias) Get the SQL alias this persister would use for the root table given the passed driving alias. abstract String[] getRootTableIdentifierColumnNames() Get the names of columns on the root table used to persist the identifier. abstract String getRootTableName() Locks are always applied to the "root table". abstract String getVersionColumnName() For versioned entities, get the name of the column (again, expected on the root table) used to store the version values.
From interface org.hibernate.persister.entity.OuterJoinLoadable abstract int countSubclassProperties() How many properties are there, for this class and all subclasses? abstract String fromTableFragment(String alias) Get the main from table fragment, given a query alias. abstract CascadeStyle getCascadeStyle(int i) Get the cascade style of this (subclass closure) property abstract EntityType getEntityType() abstract FetchMode getFetchMode(int i) May this (subclass closure) property be fetched using an SQL outerjoin? abstract String[] getPropertyColumnNames(String propertyPath) Get the column names for the given property path abstract String getPropertyTableName(String propertyName) Get the table name for the given property path abstract String[] getSubclassPropertyColumnNames(int i) Return the column names used to persist the numbered property of the class or a subclass. abstract String getSubclassPropertyName(int i) Get the name of the numbered property of the class or a subclass. abstract String getSubclassPropertyTableName(int i) Return the table name used to persist the numbered property of the class or a subclass. abstract Type getSubclassPropertyType(int i) Get the type of the numbered property of the class or a subclass. abstract boolean isDefinedOnSubclass(int i) Is this property defined on a subclass of the mapped class. abstract boolean isSubclassPropertyNullable(int i) Is the numbered property of the class of subclass nullable? abstract String selectFragment(String alias, String suffix) Generate a list of collection index, key and element columns abstract String[] toColumns(String name, int i) Given the number of a property of a subclass, and a table alias, return the aliased column names.
From interface org.hibernate.persister.entity.PropertyMapping abstract Type getType() Get the type of the thing containing the properties abstract String[] toColumns(String alias, String propertyName) Given a query alias and a property path, return the qualified column name abstract String[] toColumns(String propertyName) Given a property path, return the corresponding column name(s). abstract Type toType(String propertyName) Given a component path expression, get the type of the property
From interface org.hibernate.persister.entity.Queryable abstract String generateFilterConditionAlias(String rootAlias) The alias used for any filter conditions (mapped where-fragments or enabled-filters). abstract String[] getConstraintOrderedTableNameClosure() Get the names of all tables used in the hierarchy (up and down) ordered such that deletes in the given order would not cause contraint violations. abstract String[][] getContraintOrderedTableKeyColumnClosure() For each table specified in getConstraintOrderedTableNameClosure(), get the columns that define the key between the various hierarchy classes. abstract String getDiscriminatorSQLValue() Get the discriminator value for this particular concrete subclass, as a string that may be embedded in a select statement abstract String[] getIdentifierColumnNames() Get the names of columns used to persist the identifier abstract String getMappedSuperclass() Get the class that this class is mapped as a subclass of - not necessarily the direct superclass abstract Queryable.Declarer getSubclassPropertyDeclarer(String propertyPath) Determine whether the given property is declared by our mapped class, our super class, or one of our subclasses... abstract int getSubclassPropertyTableNumber(String propertyPath) Given a property name, determine the number of the table which contains the column to which this property is mapped. abstract String getSubclassTableName(int number) Get the name of the table with the given index from the internal array. abstract String getTemporaryIdTableDDL() Get the appropriate DDL command for generating the temporary table to be used to (potentially) store id values when performing bulk update/deletes. abstract String getTemporaryIdTableName() Get the name of the temporary table to be used to (potentially) store id values when performing bulk update/deletes. abstract DiscriminatorMetadata getTypeDiscriminatorMetadata() Retrieve the information needed to properly deal with this entity's discriminator in a query. abstract String identifierSelectFragment(String name, String suffix) Given a query alias and an identifying suffix, render the intentifier select fragment. abstract boolean isAbstract() Is this an abstract class? abstract boolean isExplicitPolymorphism() Is this class explicit polymorphism only? abstract boolean isMultiTable() Is the inheritence hierarchy described by this persister contained across multiple tables? abstract boolean isVersionPropertyInsertable() Is the version property included in insert statements? abstract String propertySelectFragment(String alias, String suffix, boolean allProperties) Given a query alias and an identifying suffix, render the property select fragment. abstract SelectFragment propertySelectFragmentFragment(String alias, String suffix, boolean allProperties)
From interface org.hibernate.persister.entity.SQLLoadable abstract String[] getSubclassPropertyColumnAliases(String propertyName, String suffix) Return the column alias names used to persist/query the named property of the class or a subclass (optional operation). abstract String[] getSubclassPropertyColumnNames(String propertyName) Return the column names used to persist/query the named property of the class or a subclass (optional operation). abstract Type getType() Get the type abstract String selectFragment(String alias, String suffix) All columns to select, when loading.
From interface org.hibernate.persister.entity.UniqueKeyLoadable abstract int getPropertyIndex(String propertyName) Get the property number of the unique key property abstract Object loadByUniqueKey(String propertyName, Object uniqueKey, SessionImplementor session) Load an instance of the persistent class, by a unique key other than the primary key.