程序包 org.hibernate.type

类 CustomType

java.lang.Object

org.hibernate.type.AbstractType

org.hibernate.type.CustomType

所有已实现的接口:

Serializable, BasicType, DiscriminatorType, IdentifierType, LiteralType, ProcedureParameterExtractionAware, ProcedureParameterNamedBinder, StringRepresentableType, Type, VersionType

public class CustomType
extends AbstractType
implements IdentifierType, DiscriminatorType, VersionType, BasicType, StringRepresentableType, ProcedureParameterNamedBinder, ProcedureParameterExtractionAware

Adapts UserType to the generic Type interface, in order to isolate user code from changes in the internal Type contracts.

作者:

Gavin King, Steve Ebersole

另请参阅:

序列化表格

字段概要

从类继承的字段 org.hibernate.type.AbstractType

LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE

构造器概要

构造器

构造器	说明
CustomType(UserType userType)
CustomType(UserType userType, String[] registrationKeys)

方法概要

修饰符和类型	方法	说明
Object	assemble(Serializable cached, SharedSessionContractImplementor session, Object owner)	Reconstruct the object from its disassembled state.
boolean	canDoExtraction()	Can the given instance of this type actually perform the parameter value extractions?
boolean	canDoSetting()	Can the given instance of this type actually set the parameter value by name
Object	deepCopy(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 no Type.dictatedSizes(org.hibernate.engine.spi.Mapping) were given).
Size[]	dictatedSizes(Mapping mapping)	Return the column sizes dictated by this type.
Serializable	disassemble(Object value, SharedSessionContractImplementor session, Object owner)	Return a disassembled representation of the object.
boolean	equals(Object obj)
Object	extract(CallableStatement statement, int startIndex, SharedSessionContractImplementor session)	Perform the extraction
Object	extract(CallableStatement statement, String[] paramNames, SharedSessionContractImplementor session)	Perform the extraction
Object	fromStringValue(String string)	Consume the given string representation back into this types java form.
Object	fromXMLString(String xml, Mapping factory)
int	getColumnSpan(Mapping session)	How many columns are used to persist this type.
Comparator	getComparator()	Get a comparator for version values.
int	getHashCode(Object x)	Get a hash code, consistent with persistence "equality".
String	getName()	Returns the abbreviated name of the type.
String[]	getRegistrationKeys()	Get the names under which this type should be registered in the type registry.
Class	getReturnedClass()	The class returned by Type.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object) methods.
UserType	getUserType()
int	hashCode()
boolean	isDirty(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session)	Should the parent be considered dirty, given both the old and current value?
boolean	isEqual(Object x, Object y)	Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).
boolean	isMutable()	Are objects of this type mutable.
Object	next(Object current, SharedSessionContractImplementor session)	Increment the version.
Object	nullSafeGet(ResultSet rs, String[] names, SharedSessionContractImplementor session, Object owner)	Extract a value of the mapped class from the JDBC result set.
Object	nullSafeGet(ResultSet rs, String columnName, SharedSessionContractImplementor session, Object owner)	Extract a value of the mapped class from the JDBC result set.
void	nullSafeSet(CallableStatement statement, Object value, String name, SharedSessionContractImplementor session)	Bind a value to the JDBC prepared statement, ignoring some columns as dictated by the 'settable' parameter.
void	nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SharedSessionContractImplementor session)	Bind a value represented by an instance of the mapped class to the JDBC prepared statement, ignoring some columns as dictated by the 'settable' parameter.
void	nullSafeSet(PreparedStatement st, Object value, int index, SharedSessionContractImplementor session)	Bind a value represented by an instance of the mapped class to the JDBC prepared statement.
String	objectToSQLString(Object value, Dialect dialect)	Convert the value into a string representation, suitable for embedding in an SQL statement as a literal.
Object	replace(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.
Object	seed(SharedSessionContractImplementor session)	Generate an initial version.
int[]	sqlTypes(Mapping pi)	Return the JDBC types codes (per Types) for the columns mapped by this type.
Object	stringToObject(String xml)	Convert the value from the mapping file to a Java object.
boolean[]	toColumnNullness(Object value, Mapping mapping)	Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.
String	toLoggableString(Object value, SessionFactoryImplementor factory)	Generate a representation of the value for logging purposes.
String	toString(Object value)	Render the value to the string representation.
String	toXMLString(Object value, SessionFactoryImplementor factory)

从类继承的方法 org.hibernate.type.AbstractType

beforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isModified, isSame, replace, resolve, semiResolve

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.hibernate.type.Type

beforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isModified, isSame, replace, resolve, resolve, semiResolve

构造器详细资料

CustomType

public CustomType(UserType userType)
           throws MappingException

抛出:

MappingException

CustomType

public CustomType(UserType userType,
                  String[] registrationKeys)
           throws MappingException

抛出:

MappingException

方法详细资料

getUserType

public UserType getUserType()

getRegistrationKeys

public String[] getRegistrationKeys()

从接口复制的说明: BasicType

Get the names under which this type should be registered in the type registry.

指定者:

getRegistrationKeys 在接口中 BasicType

返回:

The keys under which to register this type.

sqlTypes

public int[] sqlTypes(Mapping pi)

从接口复制的说明: Type

Return the JDBC types codes (per Types) for the columns mapped by this type.

NOTE: The number of elements in this array matches the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping).

指定者:

sqlTypes 在接口中 Type

参数:

pi - The mapping object :/

返回:

The JDBC type codes.

dictatedSizes

public Size[] dictatedSizes(Mapping mapping)
                     throws MappingException

从接口复制的说明: Type

Return the column sizes dictated by this type. For example, the mapping for a char/Character would have a dictated length limit of 1; for a string-based UUID would have a size limit of 36; etc.

NOTE: The number of elements in this array matches the return from Type.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

从接口复制的说明: Type

Defines the column sizes to use according to this type if the user did not explicitly say (and if no Type.dictatedSizes(org.hibernate.engine.spi.Mapping) were given).

NOTE: The number of elements in this array matches the return from Type.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.

getColumnSpan

public int getColumnSpan(Mapping session)

从接口复制的说明: Type

How many columns are used to persist this type. Always the same as sqlTypes(mapping).length

指定者:

getColumnSpan 在接口中 Type

参数:

session - The mapping object :/

返回:

The number of columns

getReturnedClass

public Class getReturnedClass()

从接口复制的说明: Type

The class returned by Type.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.

isEqual

public boolean isEqual(Object x,
                       Object y)
                throws HibernateException

从接口复制的说明: Type

Compare 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 value

y - 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)

从接口复制的说明: Type

Get a hash code, consistent with persistence "equality". Again for most types the normal usage is to delegate to the value's hashCode.

指定者:

getHashCode 在接口中 Type

覆盖:

getHashCode 在类中 AbstractType

参数:

x - The value for which to retrieve a hash code

返回:

The hash code

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String[] names,
                          SharedSessionContractImplementor session,
                          Object owner)
                   throws SQLException

从接口复制的说明: Type

Extract a value of the mapped class from 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 session

owner - the parent entity

返回:

The extracted value

抛出:

SQLException - An error from the JDBC driver

另请参阅:

alternative, 2-phase property initialization

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String columnName,
                          SharedSessionContractImplementor session,
                          Object owner)
                   throws SQLException

从接口复制的说明: Type

Extract a value of the mapped class from 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 session

owner - the parent entity

返回:

The extracted value

抛出:

SQLException - An error from the JDBC driver

assemble

public Object assemble(Serializable cached,
                       SharedSessionContractImplementor session,
                       Object owner)

从接口复制的说明: Type

Reconstruct the object from its disassembled state. This method is the reciprocal of Type.disassemble(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)

指定者:

assemble 在接口中 Type

覆盖:

assemble 在类中 AbstractType

参数:

cached - the disassembled state from the cache

session - the originating session

owner - the parent entity object

返回:

the (re)assembled object

disassemble

public Serializable disassemble(Object value,
                                SharedSessionContractImplementor session,
                                Object owner)

从接口复制的说明: Type

Return 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 cache

session - the originating session

owner - optional parent entity object (needed for collections)

返回:

the disassembled, deep cloned state

replace

public Object replace(Object original,
                      Object target,
                      SharedSessionContractImplementor session,
                      Object owner,
                      Map copyCache)
               throws HibernateException

从接口复制的说明: Type

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. 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 merged

target - the value in the managed entity

session - The originating session

owner - The owner of the value

copyCache - The cache of already copied/replaced values

返回:

the value to be merged

抛出:

HibernateException - An error from Hibernate

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int index,
                        boolean[] settable,
                        SharedSessionContractImplementor session)
                 throws SQLException

从接口复制的说明: Type

Bind a value represented by an instance of the mapped class to 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 bind

value - the object to write

index - starting parameter bind index

settable - an array indicating which columns to bind/ignore

session - The originating session

抛出:

SQLException - An error from the JDBC driver

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int index,
                        SharedSessionContractImplementor session)
                 throws SQLException

从接口复制的说明: Type

Bind a value represented by an instance of the mapped class to 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 bind

value - the object to write

index - starting parameter bind index

session - The originating session

抛出:

SQLException - An error from the JDBC driver

toXMLString

public String toXMLString(Object value,
                          SessionFactoryImplementor factory)

fromXMLString

public Object fromXMLString(String xml,
                            Mapping factory)

getName

public String getName()

从接口复制的说明: Type

Returns the abbreviated name of the type.

指定者:

getName 在接口中 Type

返回:

String the Hibernate type name

deepCopy

public Object deepCopy(Object value,
                       SessionFactoryImplementor factory)
                throws HibernateException

从接口复制的说明: Type

Return a deep copy of the persistent state, stopping at entities and at collections.

指定者:

deepCopy 在接口中 Type

参数:

value - The value to be copied

factory - The session factory

返回:

The deep copy

抛出:

HibernateException - An error from Hibernate

isMutable

public boolean isMutable()

从接口复制的说明: Type

Are objects of this type mutable. (With respect to the referencing object ... entities and collections are considered immutable because they manage their own internal state.)

指定者:

isMutable 在接口中 Type

返回:

boolean

stringToObject

public Object stringToObject(String xml)

从接口复制的说明: IdentifierType

Convert the value from the mapping file to a Java object.

指定者:

stringToObject 在接口中 IdentifierType

参数:

xml - the value of discriminator-value or unsaved-value attribute

返回:

The converted value of the string representation.

objectToSQLString

public String objectToSQLString(Object value,
                                Dialect dialect)
                         throws Exception

从接口复制的说明: LiteralType

Convert the value into a string representation, suitable for embedding in an SQL statement as a literal.

指定者:

objectToSQLString 在接口中 LiteralType

参数:

value - The value to convert

dialect - The SQL dialect

返回:

The value's string representation

抛出:

Exception - Indicates an issue converting the value to literal string.

getComparator

public Comparator getComparator()

从接口复制的说明: VersionType

Get a comparator for version values.

指定者:

getComparator 在接口中 VersionType

返回:

The comparator to use to compare different version values.

next

public Object next(Object current,
                   SharedSessionContractImplementor session)

从接口复制的说明: VersionType

Increment the version.

指定者:

next 在接口中 VersionType

参数:

current - the current version

session - The session from which this request originates.

返回:

an instance of the type

seed

public Object seed(SharedSessionContractImplementor session)

从接口复制的说明: VersionType

Generate an initial version.

指定者:

seed 在接口中 VersionType

参数:

session - The session from which this request originates.

返回:

an instance of the type

toLoggableString

public String toLoggableString(Object value,
                               SessionFactoryImplementor factory)
                        throws HibernateException

从接口复制的说明: Type

Generate a representation of the value for logging purposes.

指定者:

toLoggableString 在接口中 Type

参数:

value - The value to be logged

factory - The session factory

返回:

The loggable representation

抛出:

HibernateException - An error from Hibernate

toColumnNullness

public boolean[] toColumnNullness(Object value,
                                  Mapping mapping)

从接口复制的说明: Type

Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.

指定者:

toColumnNullness 在接口中 Type

参数:

value - an instance of the type

mapping - 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

从接口复制的说明: Type

Should the parent be considered dirty, given both the old and current value?

指定者:

isDirty 在接口中 Type

参数:

old - the old value

current - the current value

checkable - An array of booleans indicating which columns making up the value are actually checkable

session - The session from which the request originated.

返回:

true if the field is dirty

抛出:

HibernateException - A problem occurred performing the checking

toString

public String toString(Object value)
                throws HibernateException

从接口复制的说明: StringRepresentableType

Render the value to the string representation.

指定者:

toString 在接口中 StringRepresentableType

参数:

value - The value to render to string.

返回:

The string representation

抛出:

HibernateException - Problem rendering

fromStringValue

public Object fromStringValue(String string)
                       throws HibernateException

从接口复制的说明: StringRepresentableType

Consume the given string representation back into this types java form.

指定者:

fromStringValue 在接口中 StringRepresentableType

参数:

string - The string representation to be consumed.

返回:

The java type representation

抛出:

HibernateException - Problem consuming

canDoSetting

public boolean canDoSetting()

从接口复制的说明: ProcedureParameterNamedBinder

Can the given instance of this type actually set the parameter value by name

指定者:

canDoSetting 在接口中 ProcedureParameterNamedBinder

返回:

true indicates that @{link #nullSafeSet} calls will not fail

nullSafeSet

public void nullSafeSet(CallableStatement statement,
                        Object value,
                        String name,
                        SharedSessionContractImplementor session)
                 throws SQLException

从接口复制的说明: ProcedureParameterNamedBinder

Bind a value to the JDBC prepared statement, ignoring some columns as dictated by the 'settable' parameter. Implementors should handle the possibility of null values. Does not support multi-column type

指定者:

nullSafeSet 在接口中 ProcedureParameterNamedBinder

参数:

statement - The CallableStatement to which to bind

value - the object to write

name - parameter bind name

session - The originating session

抛出:

SQLException - An error from the JDBC driver

canDoExtraction

public boolean canDoExtraction()

从接口复制的说明: ProcedureParameterExtractionAware

Can the given instance of this type actually perform the parameter value extractions?

指定者:

canDoExtraction 在接口中 ProcedureParameterExtractionAware

返回:

true indicates that @{link #extract} calls will not fail due to IllegalStateException.

extract

public Object extract(CallableStatement statement,
                      int startIndex,
                      SharedSessionContractImplementor session)
               throws SQLException

从接口复制的说明: ProcedureParameterExtractionAware

Perform the extraction

指定者:

extract 在接口中 ProcedureParameterExtractionAware

参数:

statement - The CallableStatement from which to extract the parameter value(s).

startIndex - The parameter index from which to start extracting; assumes the values (if multiple) are contiguous

session - The originating session

返回:

The extracted value.

抛出:

SQLException - Indicates an issue calling into the CallableStatement

extract

public Object extract(CallableStatement statement,
                      String[] paramNames,
                      SharedSessionContractImplementor session)
               throws SQLException

从接口复制的说明: ProcedureParameterExtractionAware

Perform the extraction

指定者:

extract 在接口中 ProcedureParameterExtractionAware

参数:

statement - The CallableStatement from which to extract the parameter value(s).

paramNames - The parameter names.

session - The originating session

返回:

The extracted value.

抛出:

SQLException - Indicates an issue calling into the CallableStatement

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object

equals

public boolean equals(Object obj)

覆盖:

equals 在类中 Object