public class CustomType extends AbstractType implements IdentifierType, DiscriminatorType, VersionType, BasicType, StringRepresentableType, ProcedureParameterNamedBinder, ProcedureParameterExtractionAware
UserType to the generic Type interface, in order
to isolate user code from changes in the internal Type contracts.LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE| Constructor and Description |
|---|
CustomType(UserType userType) |
CustomType(UserType userType,
String[] registrationKeys) |
| Modifier and Type | Method and Description |
|---|---|
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()
|
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) |
beforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isModified, isSame, replace, resolve, semiResolveclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbeforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isModified, isSame, replace, resolve, resolve, semiResolvepublic CustomType(UserType userType) throws MappingException
MappingExceptionpublic CustomType(UserType userType, String[] registrationKeys) throws MappingException
MappingExceptionpublic UserType getUserType()
public String[] getRegistrationKeys()
BasicTypegetRegistrationKeys in interface BasicTypepublic int[] sqlTypes(Mapping pi)
TypeTypes) 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).public Size[] dictatedSizes(Mapping mapping) throws MappingException
Typechar/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 in interface Typemapping - The mapping object :/MappingException - Generally indicates an issue accessing the passed mapping object.public Size[] defaultSizes(Mapping mapping) throws MappingException
TypeType.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 in interface Typemapping - The mapping object :/MappingException - Generally indicates an issue accessing the passed mapping object.public int getColumnSpan(Mapping session)
TypesqlTypes(mapping).lengthgetColumnSpan in interface Typesession - The mapping object :/public Class getReturnedClass()
TypeType.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 in interface Typepublic boolean isEqual(Object x, Object y) throws HibernateException
TypeisEqual in interface TypeisEqual in class AbstractTypex - The first valuey - The second valueHibernateException - A problem occurred performing the comparisonpublic int getHashCode(Object x)
TypehashCode.getHashCode in interface TypegetHashCode in class AbstractTypex - The value for which to retrieve a hash codepublic Object nullSafeGet(ResultSet rs, String[] names, SharedSessionContractImplementor session, Object owner) throws SQLException
Typemapped class from the JDBC result set. Implementors
should handle possibility of null values.nullSafeGet in interface Typers - 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 entitySQLException - An error from the JDBC driveralternative, 2-phase property initializationpublic Object nullSafeGet(ResultSet rs, String columnName, SharedSessionContractImplementor session, Object owner) throws SQLException
Typemapped 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 in interface Typers - 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 entitySQLException - An error from the JDBC driverpublic Object assemble(Serializable cached, SharedSessionContractImplementor session, Object owner)
TypeType.disassemble(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)assemble in interface Typeassemble in class AbstractTypecached - the disassembled state from the cachesession - the originating sessionowner - the parent entity objectpublic Serializable disassemble(Object value, SharedSessionContractImplementor session, Object owner)
Typedisassemble in interface Typedisassemble in class AbstractTypevalue - the value to cachesession - the originating sessionowner - optional parent entity object (needed for collections)public Object replace(Object original, Object target, SharedSessionContractImplementor session, Object owner, Map copyCache) throws HibernateException
Typereplace in interface Typeoriginal - 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 valuesHibernateException - An error from Hibernatepublic void nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SharedSessionContractImplementor session) throws SQLException
Typemapped 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 in interface Typest - 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 sessionSQLException - An error from the JDBC driverpublic void nullSafeSet(PreparedStatement st, Object value, int index, SharedSessionContractImplementor session) throws SQLException
Typemapped class to the JDBC prepared
statement. Implementors should handle possibility of null values. A multi-column type should bind parameters
starting from index.nullSafeSet in interface Typest - The JDBC prepared statement to which to bindvalue - the object to writeindex - starting parameter bind indexsession - The originating sessionSQLException - An error from the JDBC driverpublic String toXMLString(Object value, SessionFactoryImplementor factory)
public String getName()
Typepublic Object deepCopy(Object value, SessionFactoryImplementor factory) throws HibernateException
TypedeepCopy in interface Typevalue - The value to be copiedfactory - The session factoryHibernateException - An error from Hibernatepublic boolean isMutable()
Typepublic Object stringToObject(String xml)
IdentifierTypestringToObject in interface IdentifierTypexml - the value of discriminator-value or unsaved-value attributepublic String objectToSQLString(Object value, Dialect dialect) throws Exception
LiteralTypeobjectToSQLString in interface LiteralTypevalue - The value to convertdialect - The SQL dialectException - Indicates an issue converting the value to literal string.public Comparator getComparator()
VersionTypegetComparator in interface VersionTypepublic Object next(Object current, SharedSessionContractImplementor session)
VersionTypenext in interface VersionTypecurrent - the current versionsession - The session from which this request originates.public Object seed(SharedSessionContractImplementor session)
VersionTypeseed in interface VersionTypesession - The session from which this request originates.public String toLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
TypetoLoggableString in interface Typevalue - The value to be loggedfactory - The session factoryHibernateException - An error from Hibernatepublic boolean[] toColumnNullness(Object value, Mapping mapping)
TypetoColumnNullness in interface Typevalue - an instance of the typemapping - The mapping abstractionpublic boolean isDirty(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session) throws HibernateException
TypeisDirty in interface Typeold - 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.HibernateException - A problem occurred performing the checkingpublic String toString(Object value) throws HibernateException
StringRepresentableTypetoString in interface StringRepresentableTypevalue - The value to render to string.HibernateException - Problem renderingpublic Object fromStringValue(String string) throws HibernateException
StringRepresentableTypefromStringValue in interface StringRepresentableTypestring - The string representation to be consumed.HibernateException - Problem consumingpublic boolean canDoSetting()
ProcedureParameterNamedBindercanDoSetting in interface ProcedureParameterNamedBindertrue indicates that @{link #nullSafeSet} calls will not failpublic void nullSafeSet(CallableStatement statement, Object value, String name, SharedSessionContractImplementor session) throws SQLException
ProcedureParameterNamedBindernullSafeSet in interface ProcedureParameterNamedBinderstatement - The CallableStatement to which to bindvalue - the object to writename - parameter bind namesession - The originating sessionSQLException - An error from the JDBC driverpublic boolean canDoExtraction()
ProcedureParameterExtractionAwarecanDoExtraction in interface ProcedureParameterExtractionAwaretrue indicates that @{link #extract} calls will not fail due to IllegalStateException.public Object extract(CallableStatement statement, int startIndex, SharedSessionContractImplementor session) throws SQLException
ProcedureParameterExtractionAwareextract in interface ProcedureParameterExtractionAwarestatement - 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 contiguoussession - The originating sessionSQLException - Indicates an issue calling into the CallableStatementpublic Object extract(CallableStatement statement, String[] paramNames, SharedSessionContractImplementor session) throws SQLException
ProcedureParameterExtractionAwareextract in interface ProcedureParameterExtractionAwarestatement - The CallableStatement from which to extract the parameter value(s).paramNames - The parameter names.session - The originating sessionSQLException - Indicates an issue calling into the CallableStatementCopyright © 2001-2021 Red Hat, Inc. All Rights Reserved.