public class CustomType extends AbstractType implements IdentifierType, DiscriminatorType, VersionType, BasicType, StringRepresentableType
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,
SessionImplementor session,
Object owner)
Reconstruct the object from its disassembled state.
|
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,
SessionImplementor session,
Object owner)
Return a disassembled representation of the object.
|
Object |
fromStringValue(String string)
Consume the given string representation back into this types java form.
|
Object |
fromXMLNode(org.dom4j.Node xml,
Mapping factory)
Parse the XML representation of an instance.
|
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.SessionImplementor, java.lang.Object) methods. |
UserType |
getUserType() |
boolean |
isDirty(Object old,
Object current,
boolean[] checkable,
SessionImplementor 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,
SessionImplementor session)
Increment the version.
|
Object |
nullSafeGet(ResultSet rs,
String[] names,
SessionImplementor session,
Object owner)
Extract a value of the
mapped class from the JDBC result set. |
Object |
nullSafeGet(ResultSet rs,
String columnName,
SessionImplementor session,
Object owner)
Extract a value of the
mapped class from the JDBC result set. |
void |
nullSafeSet(PreparedStatement st,
Object value,
int index,
boolean[] settable,
SessionImplementor 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,
SessionImplementor 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,
SessionImplementor 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(SessionImplementor session)
Generate an initial version.
|
void |
setToXMLNode(org.dom4j.Node node,
Object value,
SessionFactoryImplementor factory)
A representation of the value to be embedded in an XML element.
|
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, isXMLElement, replace, replaceNode, resolve, semiResolveclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbeforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isModified, isSame, isXMLElement, replace, 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.SessionImplementor, 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, SessionImplementor session, Object owner) throws HibernateException, 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 entityHibernateException - An error from HibernateSQLException - An error from the JDBC driveralternative, 2-phase property initializationpublic Object nullSafeGet(ResultSet rs, String columnName, SessionImplementor session, Object owner) throws HibernateException, 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 entityHibernateException - An error from HibernateSQLException - An error from the JDBC driverpublic Object assemble(Serializable cached, SessionImplementor session, Object owner) throws HibernateException
TypeType.disassemble(java.lang.Object, org.hibernate.engine.spi.SessionImplementor, java.lang.Object)assemble in interface Typeassemble in class AbstractTypecached - the disassembled state from the cachesession - the originating sessionowner - the parent entity objectHibernateException - An error from Hibernatepublic Serializable disassemble(Object value, SessionImplementor session, Object owner) throws HibernateException
Typedisassemble in interface Typedisassemble in class AbstractTypevalue - the value to cachesession - the originating sessionowner - optional parent entity object (needed for collections)HibernateException - An error from Hibernatepublic Object replace(Object original, Object target, SessionImplementor 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, SessionImplementor session) throws HibernateException, 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 sessionHibernateException - An error from HibernateSQLException - An error from the JDBC driverpublic void nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session) throws HibernateException, 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 sessionHibernateException - An error from HibernateSQLException - 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, SessionImplementor session)
VersionTypenext in interface VersionTypecurrent - the current versionsession - The session from which this request originates.public Object seed(SessionImplementor session)
VersionTypeseed in interface VersionTypesession - The session from which this request originates.public Object fromXMLNode(org.dom4j.Node xml, Mapping factory) throws HibernateException
TypefromXMLNode in interface Typexml - The XML node from which to read the valuefactory - The session factorymapped classHibernateException - An error from Hibernatepublic void setToXMLNode(org.dom4j.Node node,
Object value,
SessionFactoryImplementor factory)
throws HibernateException
TypesetToXMLNode in interface Typenode - The XML node to which to write the valuevalue - The value to writefactory - The session factoryHibernateException - An error from Hibernatepublic 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, SessionImplementor 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 consumingCopyright © 2001-2015 Red Hat, Inc. All Rights Reserved.