类 CompositeCustomType
- java.lang.Object
-
- org.hibernate.type.AbstractType
-
- org.hibernate.type.CompositeCustomType
-
- 所有已实现的接口:
Serializable,BasicType,CompositeType,Type
public class CompositeCustomType extends AbstractType implements CompositeType, BasicType
AdaptsCompositeUserTypeto theTypeinterface- 作者:
- Gavin King, Steve Ebersole
- 另请参阅:
- 序列化表格
-
-
字段概要
-
从类继承的字段 org.hibernate.type.AbstractType
LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE
-
-
构造器概要
构造器 构造器 说明 CompositeCustomType(CompositeUserType userType)CompositeCustomType(CompositeUserType userType, String[] registrationKeys)
-
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 Objectassemble(Serializable cached, SharedSessionContractImplementor session, Object owner)Reconstruct the object from its disassembled state.ObjectdeepCopy(Object value, SessionFactoryImplementor factory)Return a deep copy of the persistent state, stopping at entities and at collections.Size[]defaultSizes(Mapping mapping)Defines the column sizes to use according to this type if the user did not explicitly say (and if noType.dictatedSizes(org.hibernate.engine.spi.Mapping)were given).Size[]dictatedSizes(Mapping mapping)Return the column sizes dictated by this type.Serializabledisassemble(Object value, SharedSessionContractImplementor session, Object owner)Return a disassembled representation of the object.CascadeStylegetCascadeStyle(int i)Retrieve the cascade style of the indicated component property.intgetColumnSpan(Mapping mapping)How many columns are used to persist this type.FetchModegetFetchMode(int i)Retrieve the fetch mode of the indicated component property.intgetHashCode(Object x)Get a hash code, consistent with persistence "equality".StringgetName()Returns the abbreviated name of the type.intgetPropertyIndex(String name)Convenience method for locating the property index for a given property name.String[]getPropertyNames()Get the names of the component propertiesboolean[]getPropertyNullability()Retrieve the indicators regarding which component properties are nullable.ObjectgetPropertyValue(Object component, int i)ObjectgetPropertyValue(Object component, int i, SharedSessionContractImplementor session)Extract a particular component property value indicated by index.Object[]getPropertyValues(Object component, SharedSessionContractImplementor session)Extract the values of the component properties from the given component instanceObject[]getPropertyValues(Object component, EntityMode entityMode)Extract the values of the component properties from the given component instance without access to the session.String[]getRegistrationKeys()Get the names under which this type should be registered in the type registry.ClassgetReturnedClass()Type[]getSubtypes()Get the types of the component propertiesCompositeUserTypegetUserType()booleanhasNotNullProperty()Convenience method to quickly checkCompositeType.getPropertyNullability()for any non-nullable sub-properties.booleanisComponentType()Return true if the implementation is castable toCompositeType.booleanisDirty(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session)Should the parent be considered dirty, given both the old and current value?booleanisEmbedded()Is this component embedded?booleanisEqual(Object x, Object y)Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).booleanisMethodOf(Method method)Is the given method a member of this component's class?booleanisMutable()Are objects of this type mutable.ObjectnullSafeGet(ResultSet rs, String[] names, SharedSessionContractImplementor session, Object owner)Extract a value of themapped classfrom the JDBC result set.ObjectnullSafeGet(ResultSet rs, String columnName, SharedSessionContractImplementor session, Object owner)Extract a value of themapped classfrom the JDBC result set.voidnullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SharedSessionContractImplementor session)Bind a value represented by an instance of themapped classto the JDBC prepared statement, ignoring some columns as dictated by the 'settable' parameter.voidnullSafeSet(PreparedStatement st, Object value, int index, SharedSessionContractImplementor session)Bind a value represented by an instance of themapped classto the JDBC prepared statement.Objectreplace(Object original, Object target, SharedSessionContractImplementor session, Object owner, Map copyCache)During merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging.voidsetPropertyValues(Object component, Object[] values, EntityMode entityMode)Inject property values onto the given component instanceint[]sqlTypes(Mapping mapping)Return the JDBC types codes (perTypes) for the columns mapped by this type.boolean[]toColumnNullness(Object value, Mapping mapping)Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.StringtoLoggableString(Object value, SessionFactoryImplementor factory)Generate a representation of the value for logging purposes.-
从类继承的方法 org.hibernate.type.AbstractType
beforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isDirty, isEntityType, isEqual, isModified, isSame, replace, resolve, semiResolve
-
从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
从接口继承的方法 org.hibernate.type.Type
beforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isDirty, isEntityType, isEqual, isModified, isSame, replace, resolve, resolve, semiResolve
-
-
-
-
构造器详细资料
-
CompositeCustomType
public CompositeCustomType(CompositeUserType userType)
-
CompositeCustomType
public CompositeCustomType(CompositeUserType userType, String[] registrationKeys)
-
-
方法详细资料
-
getReturnedClass
public Class getReturnedClass()
从接口复制的说明:TypeThe class returned byType.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)methods. This is used to establish the class of an array of this type.- 指定者:
getReturnedClass在接口中Type- 返回:
- The java type class handled by this type.
-
isMutable
public boolean isMutable()
从接口复制的说明:TypeAre objects of this type mutable. (With respect to the referencing object ... entities and collections are considered immutable because they manage their own internal state.)
-
getRegistrationKeys
public String[] getRegistrationKeys()
从接口复制的说明:BasicTypeGet the names under which this type should be registered in the type registry.- 指定者:
getRegistrationKeys在接口中BasicType- 返回:
- The keys under which to register this type.
-
getUserType
public CompositeUserType getUserType()
-
isMethodOf
public boolean isMethodOf(Method method)
从接口复制的说明:CompositeTypeIs the given method a member of this component's class?- 指定者:
isMethodOf在接口中CompositeType- 参数:
method- The method to check- 返回:
- True if the method is a member; false otherwise.
-
getSubtypes
public Type[] getSubtypes()
从接口复制的说明:CompositeTypeGet the types of the component properties- 指定者:
getSubtypes在接口中CompositeType- 返回:
- The component property types.
-
getPropertyNames
public String[] getPropertyNames()
从接口复制的说明:CompositeTypeGet the names of the component properties- 指定者:
getPropertyNames在接口中CompositeType- 返回:
- The component property names
-
getPropertyIndex
public int getPropertyIndex(String name)
从接口复制的说明:CompositeTypeConvenience method for locating the property index for a given property name.- 指定者:
getPropertyIndex在接口中CompositeType- 参数:
name- The (sub-)property name to find.- 返回:
- The (sub-)property index, relative to all the array-valued method returns defined on this contract.
-
getPropertyValues
public Object[] getPropertyValues(Object component, SharedSessionContractImplementor session) throws HibernateException
从接口复制的说明:CompositeTypeExtract the values of the component properties from the given component instance- 指定者:
getPropertyValues在接口中CompositeType- 参数:
component- The component instancesession- The session from which the request originates- 返回:
- The property values
- 抛出:
HibernateException- Indicates a problem access the property values.
-
getPropertyValues
public Object[] getPropertyValues(Object component, EntityMode entityMode) throws HibernateException
从接口复制的说明:CompositeTypeExtract the values of the component properties from the given component instance without access to the session. An optional operation- 指定者:
getPropertyValues在接口中CompositeType- 参数:
component- The component instanceentityMode- The entity mode- 返回:
- The property values
- 抛出:
HibernateException- Indicates a problem access the property values.
-
setPropertyValues
public void setPropertyValues(Object component, Object[] values, EntityMode entityMode) throws HibernateException
从接口复制的说明:CompositeTypeInject property values onto the given component instance An optional operation- 指定者:
setPropertyValues在接口中CompositeType- 参数:
component- The component instancevalues- The values to injectentityMode- The entity mode- 抛出:
HibernateException- Indicates an issue performing the injection
-
getPropertyValue
public Object getPropertyValue(Object component, int i, SharedSessionContractImplementor session) throws HibernateException
从接口复制的说明:CompositeTypeExtract a particular component property value indicated by index.- 指定者:
getPropertyValue在接口中CompositeType- 参数:
component- The component instancei- The index of the property whose value is to be extractedsession- The session from which the request originates.- 返回:
- The extracted component property value
- 抛出:
HibernateException- Indicates a problem access the property value.
-
getPropertyValue
public Object getPropertyValue(Object component, int i) throws HibernateException
-
getCascadeStyle
public CascadeStyle getCascadeStyle(int i)
从接口复制的说明:CompositeTypeRetrieve the cascade style of the indicated component property.- 指定者:
getCascadeStyle在接口中CompositeType- 参数:
i- The property index,- 返回:
- The cascade style.
-
getFetchMode
public FetchMode getFetchMode(int i)
从接口复制的说明:CompositeTypeRetrieve the fetch mode of the indicated component property.- 指定者:
getFetchMode在接口中CompositeType- 参数:
i- The property index,- 返回:
- The fetch mode
-
isComponentType
public boolean isComponentType()
从接口复制的说明:TypeReturn true if the implementation is castable toCompositeType. Essentially a polymorphic version of(type instanceof CompositeType.class). A component type may own collections or associations and hence must provide certain extra functionality.- 指定者:
isComponentType在接口中Type- 覆盖:
isComponentType在类中AbstractType- 返回:
- True if this type is also a
CompositeTypeimplementor; false otherwise.
-
deepCopy
public Object deepCopy(Object value, SessionFactoryImplementor factory) throws HibernateException
从接口复制的说明:TypeReturn a deep copy of the persistent state, stopping at entities and at collections.- 指定者:
deepCopy在接口中Type- 参数:
value- The value to be copiedfactory- The session factory- 返回:
- The deep copy
- 抛出:
HibernateException- An error from Hibernate
-
assemble
public Object assemble(Serializable cached, SharedSessionContractImplementor session, Object owner) throws HibernateException
从接口复制的说明:TypeReconstruct the object from its disassembled state. This method is the reciprocal ofType.disassemble(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)- 指定者:
assemble在接口中Type- 覆盖:
assemble在类中AbstractType- 参数:
cached- the disassembled state from the cachesession- the originating sessionowner- the parent entity object- 返回:
- the (re)assembled object
- 抛出:
HibernateException- An error from Hibernate
-
disassemble
public Serializable disassemble(Object value, SharedSessionContractImplementor session, Object owner) throws HibernateException
从接口复制的说明:TypeReturn a disassembled representation of the object. This is the value Hibernate will use in second level caching, so care should be taken to break values down to their simplest forms; for entities especially, this means breaking them down into their constituent parts.- 指定者:
disassemble在接口中Type- 覆盖:
disassemble在类中AbstractType- 参数:
value- the value to cachesession- the originating sessionowner- optional parent entity object (needed for collections)- 返回:
- the disassembled, deep cloned state
- 抛出:
HibernateException- An error from Hibernate
-
replace
public Object replace(Object original, Object target, SharedSessionContractImplementor session, Object owner, Map copyCache) throws HibernateException
从接口复制的说明:TypeDuring merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging. For immutable objects, or null values, it is safe to simply return the first parameter. For mutable objects, it is safe to return a copy of the first parameter. For objects with component values, it might make sense to recursively replace component values.- 指定者:
replace在接口中Type- 参数:
original- the value from the detached entity being mergedtarget- the value in the managed entitysession- The originating sessionowner- The owner of the valuecopyCache- The cache of already copied/replaced values- 返回:
- the value to be merged
- 抛出:
HibernateException- An error from Hibernate
-
isEqual
public boolean isEqual(Object x, Object y) throws HibernateException
从接口复制的说明:TypeCompare two instances of the class mapped by this type for persistence "equality" (equality of persistent state). This should always equate to some form of comparison of the value's internal state. As an example, for something like a date the comparison should be based on its internal "time" state based on the specific portion it is meant to represent (timestamp, date, time).- 指定者:
isEqual在接口中Type- 覆盖:
isEqual在类中AbstractType- 参数:
x- The first valuey- The second value- 返回:
- True if there are considered equal (see discussion above).
- 抛出:
HibernateException- A problem occurred performing the comparison
-
getHashCode
public int getHashCode(Object x)
从接口复制的说明:TypeGet a hash code, consistent with persistence "equality". Again for most types the normal usage is to delegate to the value'shashCode.- 指定者:
getHashCode在接口中Type- 覆盖:
getHashCode在类中AbstractType- 参数:
x- The value for which to retrieve a hash code- 返回:
- The hash code
-
getColumnSpan
public int getColumnSpan(Mapping mapping) throws MappingException
从接口复制的说明:TypeHow many columns are used to persist this type. Always the same assqlTypes(mapping).length- 指定者:
getColumnSpan在接口中Type- 参数:
mapping- The mapping object :/- 返回:
- The number of columns
- 抛出:
MappingException- Generally indicates an issue accessing the passed mapping object.
-
nullSafeGet
public Object nullSafeGet(ResultSet rs, String columnName, SharedSessionContractImplementor session, Object owner) throws HibernateException, SQLException
从接口复制的说明:TypeExtract a value of themapped classfrom the JDBC result set. Implementors should handle possibility of null values. This form might be called if the type is known to be a single-column type.- 指定者:
nullSafeGet在接口中Type- 参数:
rs- The result set from which to extract value.columnName- the column name making up this type value (use to read from result set)session- The originating sessionowner- the parent entity- 返回:
- The extracted value
- 抛出:
HibernateException- An error from HibernateSQLException- An error from the JDBC driver
-
nullSafeGet
public Object nullSafeGet(ResultSet rs, String[] names, SharedSessionContractImplementor session, Object owner) throws HibernateException, SQLException
从接口复制的说明:TypeExtract a value of themapped classfrom the JDBC result set. Implementors should handle possibility of null values.- 指定者:
nullSafeGet在接口中Type- 参数:
rs- The result set from which to extract value.names- the column names making up this type value (use to read from result set)session- The originating sessionowner- the parent entity- 返回:
- The extracted value
- 抛出:
HibernateException- An error from HibernateSQLException- An error from the JDBC driver- 另请参阅:
alternative, 2-phase property initialization
-
nullSafeSet
public void nullSafeSet(PreparedStatement st, Object value, int index, SharedSessionContractImplementor session) throws HibernateException, SQLException
从接口复制的说明:TypeBind a value represented by an instance of themapped classto the JDBC prepared statement. Implementors should handle possibility of null values. A multi-column type should bind parameters starting from index.- 指定者:
nullSafeSet在接口中Type- 参数:
st- The JDBC prepared statement to which to bindvalue- the object to writeindex- starting parameter bind indexsession- The originating session- 抛出:
HibernateException- An error from HibernateSQLException- An error from the JDBC driver
-
nullSafeSet
public void nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SharedSessionContractImplementor session) throws HibernateException, SQLException
从接口复制的说明:TypeBind a value represented by an instance of themapped classto the JDBC prepared statement, ignoring some columns as dictated by the 'settable' parameter. Implementors should handle the possibility of null values. A multi-column type should bind parameters starting from index.- 指定者:
nullSafeSet在接口中Type- 参数:
st- The JDBC prepared statement to which to bindvalue- the object to writeindex- starting parameter bind indexsettable- an array indicating which columns to bind/ignoresession- The originating session- 抛出:
HibernateException- An error from HibernateSQLException- An error from the JDBC driver
-
sqlTypes
public int[] sqlTypes(Mapping mapping) throws MappingException
从接口复制的说明:TypeReturn the JDBC types codes (perTypes) for the columns mapped by this type. NOTE: The number of elements in this array matches the return fromType.getColumnSpan(org.hibernate.engine.spi.Mapping).- 指定者:
sqlTypes在接口中Type- 参数:
mapping- The mapping object :/- 返回:
- The JDBC type codes.
- 抛出:
MappingException- Generally indicates an issue accessing the passed mapping object.
-
dictatedSizes
public Size[] dictatedSizes(Mapping mapping) throws MappingException
从接口复制的说明:TypeReturn the column sizes dictated by this type. For example, the mapping for achar/Characterwould have a dictated length limit of 1; for a string-basedUUIDwould have a size limit of 36; etc. NOTE: The number of elements in this array matches the return fromType.getColumnSpan(org.hibernate.engine.spi.Mapping).- 指定者:
dictatedSizes在接口中Type- 参数:
mapping- The mapping object :/- 返回:
- The dictated sizes.
- 抛出:
MappingException- Generally indicates an issue accessing the passed mapping object.
-
defaultSizes
public Size[] defaultSizes(Mapping mapping) throws MappingException
从接口复制的说明:TypeDefines the column sizes to use according to this type if the user did not explicitly say (and if noType.dictatedSizes(org.hibernate.engine.spi.Mapping)were given). NOTE: The number of elements in this array matches the return fromType.getColumnSpan(org.hibernate.engine.spi.Mapping).- 指定者:
defaultSizes在接口中Type- 参数:
mapping- The mapping object :/- 返回:
- The default sizes.
- 抛出:
MappingException- Generally indicates an issue accessing the passed mapping object.
-
toLoggableString
public String toLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
从接口复制的说明:TypeGenerate a representation of the value for logging purposes.- 指定者:
toLoggableString在接口中Type- 参数:
value- The value to be loggedfactory- The session factory- 返回:
- The loggable representation
- 抛出:
HibernateException- An error from Hibernate
-
getPropertyNullability
public boolean[] getPropertyNullability()
从接口复制的说明:CompositeTypeRetrieve the indicators regarding which component properties are nullable. An optional operation- 指定者:
getPropertyNullability在接口中CompositeType- 返回:
- nullability of component properties
-
toColumnNullness
public boolean[] toColumnNullness(Object value, Mapping mapping)
从接口复制的说明:TypeGiven an instance of the type, return an array of boolean, indicating which mapped columns would be null.- 指定者:
toColumnNullness在接口中Type- 参数:
value- an instance of the typemapping- The mapping abstraction- 返回:
- array indicating column nullness for a value instance
-
isDirty
public boolean isDirty(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session) throws HibernateException
从接口复制的说明:TypeShould the parent be considered dirty, given both the old and current value?- 指定者:
isDirty在接口中Type- 参数:
old- the old valuecurrent- the current valuecheckable- An array of booleans indicating which columns making up the value are actually checkablesession- The session from which the request originated.- 返回:
- true if the field is dirty
- 抛出:
HibernateException- A problem occurred performing the checking
-
isEmbedded
public boolean isEmbedded()
从接口复制的说明:CompositeTypeIs this component embedded? "embedded" indicates that the component is "virtual", that its properties are "flattened" onto its owner- 指定者:
isEmbedded在接口中CompositeType- 返回:
- True if this component is embedded; false otherwise.
-
hasNotNullProperty
public boolean hasNotNullProperty()
从接口复制的说明:CompositeTypeConvenience method to quickly checkCompositeType.getPropertyNullability()for any non-nullable sub-properties.- 指定者:
hasNotNullProperty在接口中CompositeType- 返回:
trueif any of the properties are not-nullable as indicated byCompositeType.getPropertyNullability(),falseotherwise.
-
-