|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Type
Defines a mapping between a Java type and one or more JDBC types, as well as describing the in-memory semantics of the given java type (how do we check it for 'dirtiness', how do we copy values, etc).
Application developers needing custom types can implement this interface (either directly or via subclassing an existing impl) or by the (slightly more stable, though more limited)UserType
interface.
Implementations of this interface must certainly be thread-safe. It is recommended that they be immutable as
well, though that is difficult to achieve completely given the no-arg constructor requirement for custom types.
Method Summary | |
---|---|
Object |
assemble(Serializable cached,
SessionImplementor session,
Object owner)
Reconstruct the object from its disassembled state. |
void |
beforeAssemble(Serializable cached,
SessionImplementor session)
Called before assembling a query result set from the query cache, to allow batch fetching of entities missing from the second-level cache. |
int |
compare(Object x,
Object y)
Perform a Comparator style comparison between values |
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 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 |
fromXMLNode(org.dom4j.Node xml,
Mapping factory)
Deprecated. To be removed in 5. Removed as part of removing the notion of DOM entity-mode. See Jira issue: HHH-7771 |
int |
getColumnSpan(Mapping mapping)
How many columns are used to persist this type. |
int |
getHashCode(Object x)
Get a hash code, consistent with persistence "equality". |
int |
getHashCode(Object x,
SessionFactoryImplementor factory)
Get a hash code, consistent with persistence "equality". |
String |
getName()
Returns the abbreviated name of the type. |
Class |
getReturnedClass()
The class returned by nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SessionImplementor, java.lang.Object) methods. |
Type |
getSemiResolvedType(SessionFactoryImplementor factory)
As part of 2-phase loading, when we perform resolving what is the resolved type for this type? Generally speaking the type and its semi-resolved type will be the same. |
Object |
hydrate(ResultSet rs,
String[] names,
SessionImplementor session,
Object owner)
Extract a value from the JDBC result set. |
boolean |
isAnyType()
Return true if the implementation is castable to AnyType . |
boolean |
isAssociationType()
Return true if the implementation is castable to AssociationType . |
boolean |
isCollectionType()
Return true if the implementation is castable to CollectionType . |
boolean |
isComponentType()
Return true if the implementation is castable to CompositeType . |
boolean |
isDirty(Object oldState,
Object currentState,
boolean[] checkable,
SessionImplementor session)
Should the parent be considered dirty, given both the old and current value? |
boolean |
isDirty(Object old,
Object current,
SessionImplementor session)
Should the parent be considered dirty, given both the old and current value? |
boolean |
isEntityType()
Return true if the implementation is castable to EntityType . |
boolean |
isEqual(Object x,
Object y)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state). |
boolean |
isEqual(Object x,
Object y,
SessionFactoryImplementor factory)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state). |
boolean |
isModified(Object dbState,
Object currentState,
boolean[] checkable,
SessionImplementor session)
Has the value been modified compared to the current database state? The difference between this and the isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SessionImplementor) methods is that here we need to account for "partially" built values. |
boolean |
isMutable()
Are objects of this type mutable. |
boolean |
isSame(Object x,
Object y)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state) taking a shortcut for entity references. |
boolean |
isXMLElement()
Deprecated. To be removed in 5. Removed as part of removing the notion of DOM entity-mode. See Jira issue: HHH-7771 |
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 name,
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. |
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 |
replace(Object original,
Object target,
SessionImplementor session,
Object owner,
Map copyCache,
ForeignKeyDirection foreignKeyDirection)
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 |
resolve(Object value,
SessionImplementor session,
Object owner)
The second phase of 2-phase loading. |
Object |
semiResolve(Object value,
SessionImplementor session,
Object owner)
Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations. |
void |
setToXMLNode(org.dom4j.Node node,
Object value,
SessionFactoryImplementor factory)
Deprecated. To be removed in 5. Removed as part of removing the notion of DOM entity-mode. See Jira issue: HHH-7771 |
int[] |
sqlTypes(Mapping mapping)
Return the JDBC types codes (per Types ) 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. |
String |
toLoggableString(Object value,
SessionFactoryImplementor factory)
Generate a representation of the value for logging purposes. |
Method Detail |
---|
boolean isAssociationType()
AssociationType
. This does not necessarily imply that
the type actually represents an association. Essentially a polymorphic version of
(type instanceof AssociationType.class)
AssociationType
implementor; false otherwise.boolean isCollectionType()
CollectionType
. Essentially a polymorphic version of
(type instanceof CollectionType.class)
A CollectionType
is additionally an AssociationType
; so if this method returns true,
isAssociationType()
should also return true.
CollectionType
implementor; false otherwise.boolean isEntityType()
EntityType
. Essentially a polymorphic
version of (type instanceof EntityType.class)
.
An EntityType
is additionally an AssociationType
; so if this method returns true,
isAssociationType()
should also return true.
EntityType
implementor; false otherwise.boolean isAnyType()
AnyType
. Essentially a polymorphic
version of (type instanceof AnyType.class)
.
An AnyType
is additionally an AssociationType
; so if this method returns true,
isAssociationType()
should also return true.
AnyType
implementor; false otherwise.boolean isComponentType()
CompositeType
. Essentially a polymorphic
version of (type instanceof CompositeType.class)
. A component type may own collections or
associations and hence must provide certain extra functionality.
CompositeType
implementor; false otherwise.int getColumnSpan(Mapping mapping) throws MappingException
sqlTypes(mapping).length
mapping
- The mapping object :/
MappingException
- Generally indicates an issue accessing the passed mapping object.int[] sqlTypes(Mapping mapping) throws MappingException
Types
) for the columns mapped by this type.
NOTE: The number of elements in this array matches the return from getColumnSpan(org.hibernate.engine.spi.Mapping)
.
mapping
- The mapping object :/
MappingException
- Generally indicates an issue accessing the passed mapping object.Size[] dictatedSizes(Mapping mapping) throws MappingException
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 getColumnSpan(org.hibernate.engine.spi.Mapping)
.
mapping
- The mapping object :/
MappingException
- Generally indicates an issue accessing the passed mapping object.Size[] defaultSizes(Mapping mapping) throws MappingException
dictatedSizes(org.hibernate.engine.spi.Mapping)
were given).
NOTE: The number of elements in this array matches the return from getColumnSpan(org.hibernate.engine.spi.Mapping)
.
mapping
- The mapping object :/
MappingException
- Generally indicates an issue accessing the passed mapping object.Class getReturnedClass()
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.
@Deprecated boolean isXMLElement()
boolean isSame(Object x, Object y) throws HibernateException
equals
check on the values. For associations
the implication is a bit different. For most types it is conceivable to simply delegate to isEqual(java.lang.Object, java.lang.Object)
x
- The first valuey
- The second value
HibernateException
- A problem occurred performing the comparisonboolean isEqual(Object x, Object y) throws HibernateException
x
- The first valuey
- The second value
HibernateException
- A problem occurred performing the comparisonboolean isEqual(Object x, Object y, SessionFactoryImplementor factory) throws HibernateException
x
- The first valuey
- The second valuefactory
- The session factory
HibernateException
- A problem occurred performing the comparisonint getHashCode(Object x) throws HibernateException
hashCode
.
x
- The value for which to retrieve a hash code
HibernateException
- A problem occurred calculating the hash codeint getHashCode(Object x, SessionFactoryImplementor factory) throws HibernateException
hashCode
.
x
- The value for which to retrieve a hash codefactory
- The session factory
HibernateException
- A problem occurred calculating the hash codeint compare(Object x, Object y)
Comparator
style comparison between values
x
- The first valuey
- The second value
Comparator.compare(T, T)
for a discussion.boolean isDirty(Object old, Object current, SessionImplementor session) throws HibernateException
old
- the old valuecurrent
- the current valuesession
- The session from which the request originated.
HibernateException
- A problem occurred performing the checkingboolean isDirty(Object oldState, Object currentState, boolean[] checkable, SessionImplementor session) throws HibernateException
oldState
- the old valuecurrentState
- 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 checkingboolean isModified(Object dbState, Object currentState, boolean[] checkable, SessionImplementor session) throws HibernateException
isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SessionImplementor)
methods is that here we need to account for "partially" built values. This is really
only an issue with association types. For most type implementations it is enough to simply delegate to
isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SessionImplementor)
here/
dbState
- the database state, in a "hydrated" form, with identifiers unresolvedcurrentState
- the current state of the objectcheckable
- which columns are actually updatablesession
- The session from which the request originated.
HibernateException
- A problem occurred performing the checkingObject nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner) throws HibernateException, SQLException
mapped class
from the JDBC result set. Implementors
should handle possibility of null values.
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
Object nullSafeGet(ResultSet rs, String name, SessionImplementor session, Object owner) throws HibernateException, SQLException
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.
rs
- The result set from which to extract value.name
- 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 drivervoid nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SessionImplementor session) throws HibernateException, SQLException
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.
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 drivervoid nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session) throws HibernateException, SQLException
mapped class
to the JDBC prepared
statement. Implementors should handle possibility of null values. A multi-column type should bind parameters
starting from index.
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 driverString toLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
value
- The value to be loggedfactory
- The session factory
HibernateException
- An error from Hibernate@Deprecated void setToXMLNode(org.dom4j.Node node, Object value, SessionFactoryImplementor factory) throws HibernateException
node
- The XML node to which to write the valuevalue
- The value to writefactory
- The session factory
HibernateException
- An error from Hibernate@Deprecated Object fromXMLNode(org.dom4j.Node xml, Mapping factory) throws HibernateException
xml
- The XML node from which to read the valuefactory
- The session factory
mapped class
HibernateException
- An error from HibernateString getName()
Object deepCopy(Object value, SessionFactoryImplementor factory) throws HibernateException
value
- The value to be copiedfactory
- The session factory
HibernateException
- An error from Hibernateboolean isMutable()
Serializable disassemble(Object value, SessionImplementor session, Object owner) throws HibernateException
value
- the value to cachesession
- the originating sessionowner
- optional parent entity object (needed for collections)
HibernateException
- An error from HibernateObject assemble(Serializable cached, SessionImplementor session, Object owner) throws HibernateException
disassemble(java.lang.Object, org.hibernate.engine.spi.SessionImplementor, java.lang.Object)
cached
- the disassembled state from the cachesession
- the originating sessionowner
- the parent entity object
HibernateException
- An error from Hibernatevoid beforeAssemble(Serializable cached, SessionImplementor session)
cached
- The keysession
- The originating sessionObject hydrate(ResultSet rs, String[] names, SessionImplementor session, Object owner) throws HibernateException, SQLException
resolve(java.lang.Object, org.hibernate.engine.spi.SessionImplementor, java.lang.Object)
This hydrated value will be either:
rs
- The JDBC result setnames
- 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 driverresolve(java.lang.Object, org.hibernate.engine.spi.SessionImplementor, java.lang.Object)
Object resolve(Object value, SessionImplementor session, Object owner) throws HibernateException
value
- an identifier or value returned by hydrate()owner
- the parent entitysession
- the session
HibernateException
- An error from Hibernatehydrate(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SessionImplementor, java.lang.Object)
Object semiResolve(Object value, SessionImplementor session, Object owner) throws HibernateException
value
- The unresolved, hydrated valuesession
- THe originating sessionowner
- The value owner
HibernateException
- An error from HibernateType getSemiResolvedType(SessionFactoryImplementor factory)
factory
- The session factory
Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache) throws HibernateException
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 HibernateObject replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache, ForeignKeyDirection foreignKeyDirection) throws HibernateException
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 valuesforeignKeyDirection
- For associations, which direction does the foreign key point?
HibernateException
- An error from Hibernateboolean[] toColumnNullness(Object value, Mapping mapping)
value
- an instance of the typemapping
- The mapping abstraction
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |