|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.hibernate.type.AbstractType org.hibernate.type.CustomType
public class CustomType
Adapts UserType
to the generic Type
interface, in order
to isolate user code from changes in the internal Type contracts.
Field Summary |
---|
Fields inherited from class org.hibernate.type.AbstractType |
---|
LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE |
Constructor Summary | |
---|---|
CustomType(UserType userType)
|
|
CustomType(UserType userType,
String[] registrationKeys)
|
Method Summary | |
---|---|
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)
|
Methods inherited from class org.hibernate.type.AbstractType |
---|
beforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isModified, isSame, isXMLElement, replace, replaceNode, resolve, semiResolve |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.hibernate.type.Type |
---|
beforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isModified, isSame, isXMLElement, replace, resolve, semiResolve |
Constructor Detail |
---|
public CustomType(UserType userType) throws MappingException
MappingException
public CustomType(UserType userType, String[] registrationKeys) throws MappingException
MappingException
Method Detail |
---|
public UserType getUserType()
public String[] getRegistrationKeys()
BasicType
getRegistrationKeys
in interface BasicType
public int[] sqlTypes(Mapping pi)
Type
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
in interface Type
pi
- The mapping object :/
public Size[] dictatedSizes(Mapping mapping) throws MappingException
Type
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
in interface Type
mapping
- The mapping object :/
MappingException
- Generally indicates an issue accessing the passed mapping object.public Size[] defaultSizes(Mapping mapping) throws MappingException
Type
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
in interface Type
mapping
- The mapping object :/
MappingException
- Generally indicates an issue accessing the passed mapping object.public int getColumnSpan(Mapping session)
Type
sqlTypes(mapping).length
getColumnSpan
in interface Type
session
- The mapping object :/
public Class getReturnedClass()
Type
Type.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 Type
public boolean isEqual(Object x, Object y) throws HibernateException
Type
isEqual
in interface Type
isEqual
in class AbstractType
x
- The first valuey
- The second value
HibernateException
- A problem occurred performing the comparisonpublic int getHashCode(Object x)
Type
hashCode
.
getHashCode
in interface Type
getHashCode
in class AbstractType
x
- The value for which to retrieve a hash code
public Object nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner) throws HibernateException, SQLException
Type
mapped class
from the JDBC result set. Implementors
should handle possibility of null values.
nullSafeGet
in interface 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
HibernateException
- An error from Hibernate
SQLException
- An error from the JDBC driveralternative, 2-phase property initialization
public Object nullSafeGet(ResultSet rs, String columnName, SessionImplementor session, Object owner) throws HibernateException, SQLException
Type
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
in interface 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
HibernateException
- An error from Hibernate
SQLException
- An error from the JDBC driverpublic Object assemble(Serializable cached, SessionImplementor session, Object owner) throws HibernateException
Type
Type.disassemble(java.lang.Object, org.hibernate.engine.spi.SessionImplementor, java.lang.Object)
assemble
in interface Type
assemble
in class AbstractType
cached
- the disassembled state from the cachesession
- the originating sessionowner
- the parent entity object
HibernateException
- An error from Hibernatepublic Serializable disassemble(Object value, SessionImplementor session, Object owner) throws HibernateException
Type
disassemble
in interface Type
disassemble
in class AbstractType
value
- 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
Type
replace
in interface 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
HibernateException
- An error from Hibernatepublic void nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SessionImplementor session) throws HibernateException, SQLException
Type
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
in interface 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 Hibernate
SQLException
- An error from the JDBC driverpublic void nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session) throws HibernateException, SQLException
Type
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
in interface 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 Hibernate
SQLException
- An error from the JDBC driverpublic String toXMLString(Object value, SessionFactoryImplementor factory)
public Object fromXMLString(String xml, Mapping factory)
public String getName()
Type
getName
in interface Type
public Object deepCopy(Object value, SessionFactoryImplementor factory) throws HibernateException
Type
deepCopy
in interface Type
value
- The value to be copiedfactory
- The session factory
HibernateException
- An error from Hibernatepublic boolean isMutable()
Type
isMutable
in interface Type
public Object stringToObject(String xml)
IdentifierType
stringToObject
in interface IdentifierType
xml
- the value of discriminator-value or unsaved-value attribute
public String objectToSQLString(Object value, Dialect dialect) throws Exception
LiteralType
objectToSQLString
in interface LiteralType
value
- The value to convertdialect
- The SQL dialect
Exception
- Indicates an issue converting the value to literal string.public Comparator getComparator()
VersionType
getComparator
in interface VersionType
public Object next(Object current, SessionImplementor session)
VersionType
next
in interface VersionType
current
- the current versionsession
- The session from which this request originates.
public Object seed(SessionImplementor session)
VersionType
seed
in interface VersionType
session
- The session from which this request originates.
public Object fromXMLNode(org.dom4j.Node xml, Mapping factory) throws HibernateException
Type
fromXMLNode
in interface Type
xml
- The XML node from which to read the valuefactory
- The session factory
mapped class
HibernateException
- An error from Hibernatepublic void setToXMLNode(org.dom4j.Node node, Object value, SessionFactoryImplementor factory) throws HibernateException
Type
setToXMLNode
in interface Type
node
- The XML node to which to write the valuevalue
- The value to writefactory
- The session factory
HibernateException
- An error from Hibernatepublic String toLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
Type
toLoggableString
in interface Type
value
- The value to be loggedfactory
- The session factory
HibernateException
- An error from Hibernatepublic boolean[] toColumnNullness(Object value, Mapping mapping)
Type
toColumnNullness
in interface Type
value
- an instance of the typemapping
- The mapping abstraction
public boolean isDirty(Object old, Object current, boolean[] checkable, SessionImplementor session) throws HibernateException
Type
isDirty
in interface 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.
HibernateException
- A problem occurred performing the checkingpublic String toString(Object value) throws HibernateException
StringRepresentableType
toString
in interface StringRepresentableType
value
- The value to render to string.
HibernateException
- Problem renderingpublic Object fromStringValue(String string) throws HibernateException
StringRepresentableType
fromStringValue
in interface StringRepresentableType
string
- The string representation to be consumed.
HibernateException
- Problem consuming
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |