|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface Type
Defines a mapping from a Java type to an JDBC datatype. This interface is intended to
be implemented by applications that need custom types.
Implementors should usually be immutable and must certainly be threadsafe.
| Method Summary | |
|---|---|
Object |
assemble(Serializable cached,
SessionImplementor session,
Object owner)
Reconstruct the object from its cached "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,
EntityMode entityMode)
compare two instances of the type |
Object |
deepCopy(Object value,
EntityMode entityMode,
SessionFactoryImplementor factory)
Return a deep copy of the persistent state, stopping at entities and at collections. |
Serializable |
disassemble(Object value,
SessionImplementor session,
Object owner)
Return a cacheable "disassembled" representation of the object. |
Object |
fromXMLNode(org.dom4j.Node xml,
Mapping factory)
Parse the XML representation of an instance. |
int |
getColumnSpan(Mapping mapping)
How many columns are used to persist this type. |
int |
getHashCode(Object x,
EntityMode entityMode)
Get a hashcode, consistent with persistence "equality" |
int |
getHashCode(Object x,
EntityMode entityMode,
SessionFactoryImplementor factory)
Get a hashcode, consistent with persistence "equality" |
String |
getName()
Returns the abbreviated name of the type. |
Class |
getReturnedClass()
The class returned by nullSafeGet() methods. |
Type |
getSemiResolvedType(SessionFactoryImplementor factory)
Get the type of a semi-resolved value. |
Object |
hydrate(ResultSet rs,
String[] names,
SessionImplementor session,
Object owner)
Retrieve an instance of the mapped class, or the identifier of an entity or collection, from a JDBC resultset. |
boolean |
isAnyType()
Is this an "any" type. |
boolean |
isAssociationType()
Return true if the implementation is castable to AssociationType. |
boolean |
isCollectionType()
Is this type a collection type. |
boolean |
isComponentType()
Is this type a component type. |
boolean |
isDirty(Object old,
Object current,
boolean[] checkable,
SessionImplementor session)
Should the parent be considered dirty, given both the old and current field or element value? |
boolean |
isDirty(Object old,
Object current,
SessionImplementor session)
Should the parent be considered dirty, given both the old and current field or element value? |
boolean |
isEntityType()
Is this type an entity type? |
boolean |
isEqual(Object x,
Object y,
EntityMode entityMode)
Compare two instances of the class mapped by this type for persistence "equality" - equality of persistent state. |
boolean |
isEqual(Object x,
Object y,
EntityMode entityMode,
SessionFactoryImplementor factory)
Compare two instances of the class mapped by this type for persistence "equality" - equality of persistent state. |
boolean |
isModified(Object oldHydratedState,
Object currentState,
boolean[] checkable,
SessionImplementor session)
Has the parent object been modified, compared to the current database state? |
boolean |
isMutable()
Are objects of this type mutable. |
boolean |
isSame(Object x,
Object y,
EntityMode entityMode)
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()
|
Object |
nullSafeGet(ResultSet rs,
String[] names,
SessionImplementor session,
Object owner)
Retrieve an instance of the mapped class from a JDBC resultset. |
Object |
nullSafeGet(ResultSet rs,
String name,
SessionImplementor session,
Object owner)
Retrieve an instance of the mapped class from a JDBC resultset. |
void |
nullSafeSet(PreparedStatement st,
Object value,
int index,
boolean[] settable,
SessionImplementor session)
Write an instance of the mapped class to a prepared statement, ignoring some columns. |
void |
nullSafeSet(PreparedStatement st,
Object value,
int index,
SessionImplementor session)
Write an instance of the mapped class to a 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)
Map identifiers to entities or collections. |
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)
A representation of the value to be embedded in an XML element. |
int[] |
sqlTypes(Mapping mapping)
Return the SQL type codes 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)
A representation of the value to be embedded in a log file. |
| Method Detail |
|---|
boolean isAssociationType()
AssociationTypeboolean isCollectionType()
boolean isComponentType()
AbstractComponentTypeboolean isEntityType()
boolean isAnyType()
boolean isXMLElement()
int[] sqlTypes(Mapping mapping)
throws MappingException
MappingExceptionTypes
int getColumnSpan(Mapping mapping)
throws MappingException
MappingExceptionClass getReturnedClass()
boolean isSame(Object x,
Object y,
EntityMode entityMode)
throws HibernateException
x - y - entityMode -
HibernateException
boolean isEqual(Object x,
Object y,
EntityMode entityMode)
throws HibernateException
x - y - entityMode -
HibernateException
boolean isEqual(Object x,
Object y,
EntityMode entityMode,
SessionFactoryImplementor factory)
throws HibernateException
x - y - entityMode -
HibernateException
int getHashCode(Object x,
EntityMode entityMode)
throws HibernateException
x - entityMode -
HibernateException
int getHashCode(Object x,
EntityMode entityMode,
SessionFactoryImplementor factory)
throws HibernateException
x - entityMode - factory -
HibernateException
int compare(Object x,
Object y,
EntityMode entityMode)
entityMode -
boolean isDirty(Object old,
Object current,
SessionImplementor session)
throws HibernateException
old - the old valuecurrent - the current valuesession -
HibernateException
boolean isDirty(Object old,
Object current,
boolean[] checkable,
SessionImplementor session)
throws HibernateException
old - the old valuecurrent - the current valuecheckable - which columns are actually updatablesession -
HibernateException
boolean isModified(Object oldHydratedState,
Object currentState,
boolean[] checkable,
SessionImplementor session)
throws HibernateException
oldHydratedState - the database state, in a "hydrated" form, with identifiers unresolvedcurrentState - the current state of the objectcheckable - which columns are actually updatablesession -
HibernateException
Object nullSafeGet(ResultSet rs,
String[] names,
SessionImplementor session,
Object owner)
throws HibernateException,
SQLException
rs - names - the column namessession - owner - the parent entity
HibernateException
SQLExceptionalternative, 2-phase property initialization
Object nullSafeGet(ResultSet rs,
String name,
SessionImplementor session,
Object owner)
throws HibernateException,
SQLException
rs - name - the column namesession - owner - the parent entity
HibernateException
SQLException
void nullSafeSet(PreparedStatement st,
Object value,
int index,
boolean[] settable,
SessionImplementor session)
throws HibernateException,
SQLException
st - value - the object to writeindex - statement parameter indexsettable - an array indicating which columns to ignoresession -
HibernateException
SQLException
void nullSafeSet(PreparedStatement st,
Object value,
int index,
SessionImplementor session)
throws HibernateException,
SQLException
st - value - the object to writeindex - statement parameter indexsession -
HibernateException
SQLException
void setToXMLNode(org.dom4j.Node node,
Object value,
SessionFactoryImplementor factory)
throws HibernateException
value - factory -
HibernateException
String toLoggableString(Object value,
SessionFactoryImplementor factory)
throws HibernateException
value - factory -
HibernateException
Object fromXMLNode(org.dom4j.Node xml,
Mapping factory)
throws HibernateException
xml - factory -
HibernateExceptionString getName()
Object deepCopy(Object value,
EntityMode entityMode,
SessionFactoryImplementor factory)
throws HibernateException
value - generally a collection element or entity fieldentityMode - factory -
HibernateExceptionboolean isMutable()
Serializable disassemble(Object value,
SessionImplementor session,
Object owner)
throws HibernateException
value - the value to cachesession - the sessionowner - optional parent entity object (needed for collections)
HibernateException
Object assemble(Serializable cached,
SessionImplementor session,
Object owner)
throws HibernateException
cached - the disassembled state from the cachesession - the sessionowner - the parent entity object
HibernateException
void beforeAssemble(Serializable cached,
SessionImplementor session)
Object hydrate(ResultSet rs,
String[] names,
SessionImplementor session,
Object owner)
throws HibernateException,
SQLException
rs - names - the column namessession - the sessionowner - the parent entity
HibernateException
SQLExceptionresolve(Object, SessionImplementor, 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
HibernateExceptionhydrate(ResultSet, String[], SessionImplementor, Object)
Object semiResolve(Object value,
SessionImplementor session,
Object owner)
throws HibernateException
HibernateExceptionType getSemiResolvedType(SessionFactoryImplementor 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 entity
HibernateException
Object 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 entity
HibernateException
boolean[] toColumnNullness(Object value,
Mapping mapping)
value - an instance of the type
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||