org.hibernate.envers.test.entities.customtype
Class CompositeTestUserType

java.lang.Object
  extended by org.hibernate.envers.test.entities.customtype.CompositeTestUserType
All Implemented Interfaces:
CompositeUserType

public class CompositeTestUserType
extends Object
implements CompositeUserType


Constructor Summary
CompositeTestUserType()
           
 
Method Summary
 Object assemble(Serializable cached, SessionImplementor session, Object owner)
          Reconstruct an object from the cacheable representation.
 Object deepCopy(Object value)
          Return a deep copy of the persistent state, stopping at entities and at collections.
 Serializable disassemble(Object value, SessionImplementor session)
          Transform the object into its cacheable representation.
 boolean equals(Object x, Object y)
          Compare two instances of the class mapped by this type for persistence "equality".
 String[] getPropertyNames()
          Get the "property names" that may be used in a query.
 Type[] getPropertyTypes()
          Get the corresponding "property types".
 Object getPropertyValue(Object component, int property)
          Get the value of a property.
 int hashCode(Object x)
          Get a hashcode for the instance, consistent with persistence "equality"
 boolean isMutable()
          Check if objects of this type mutable.
 Object nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner)
          Retrieve an instance of the mapped class from a JDBC resultset.
 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)
          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.
 Class returnedClass()
          The class returned by nullSafeGet().
 void setPropertyValue(Object component, int property, Object value)
          Set the value of a property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CompositeTestUserType

public CompositeTestUserType()
Method Detail

getPropertyNames

public String[] getPropertyNames()
Description copied from interface: CompositeUserType
Get the "property names" that may be used in a query.

Specified by:
getPropertyNames in interface CompositeUserType
Returns:
an array of "property names"

getPropertyTypes

public Type[] getPropertyTypes()
Description copied from interface: CompositeUserType
Get the corresponding "property types".

Specified by:
getPropertyTypes in interface CompositeUserType
Returns:
an array of Hibernate types

getPropertyValue

public Object getPropertyValue(Object component,
                               int property)
                        throws HibernateException
Description copied from interface: CompositeUserType
Get the value of a property.

Specified by:
getPropertyValue in interface CompositeUserType
Parameters:
component - an instance of class mapped by this "type"
Returns:
the property value
Throws:
HibernateException

setPropertyValue

public void setPropertyValue(Object component,
                             int property,
                             Object value)
                      throws HibernateException
Description copied from interface: CompositeUserType
Set the value of a property.

Specified by:
setPropertyValue in interface CompositeUserType
Parameters:
component - an instance of class mapped by this "type"
value - the value to set
Throws:
HibernateException

returnedClass

public Class returnedClass()
Description copied from interface: CompositeUserType
The class returned by nullSafeGet().

Specified by:
returnedClass in interface CompositeUserType
Returns:
Class

equals

public boolean equals(Object x,
                      Object y)
               throws HibernateException
Description copied from interface: CompositeUserType
Compare two instances of the class mapped by this type for persistence "equality". Equality of the persistent state.

Specified by:
equals in interface CompositeUserType
Throws:
HibernateException

hashCode

public int hashCode(Object x)
             throws HibernateException
Description copied from interface: CompositeUserType
Get a hashcode for the instance, consistent with persistence "equality"

Specified by:
hashCode in interface CompositeUserType
Throws:
HibernateException

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String[] names,
                          SessionImplementor session,
                          Object owner)
                   throws HibernateException,
                          SQLException
Description copied from interface: CompositeUserType
Retrieve an instance of the mapped class from a JDBC resultset. Implementors should handle possibility of null values.

Specified by:
nullSafeGet in interface CompositeUserType
Parameters:
rs - a JDBC result set
names - the column names
owner - the containing entity
Returns:
Object
Throws:
HibernateException
SQLException

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int index,
                        SessionImplementor session)
                 throws HibernateException,
                        SQLException
Description copied from interface: CompositeUserType
Write an instance of the mapped class to a prepared statement. Implementors should handle possibility of null values. A multi-column type should be written to parameters starting from index.

Specified by:
nullSafeSet in interface CompositeUserType
Parameters:
st - a JDBC prepared statement
value - the object to write
index - statement parameter index
Throws:
HibernateException
SQLException

deepCopy

public Object deepCopy(Object value)
                throws HibernateException
Description copied from interface: CompositeUserType
Return a deep copy of the persistent state, stopping at entities and at collections.

Specified by:
deepCopy in interface CompositeUserType
Parameters:
value - generally a collection element or entity field
Returns:
Object a copy
Throws:
HibernateException

isMutable

public boolean isMutable()
Description copied from interface: CompositeUserType
Check if objects of this type mutable.

Specified by:
isMutable in interface CompositeUserType
Returns:
boolean

disassemble

public Serializable disassemble(Object value,
                                SessionImplementor session)
                         throws HibernateException
Description copied from interface: CompositeUserType
Transform the object into its cacheable representation. At the very least this method should perform a deep copy. That may not be enough for some implementations, however; for example, associations must be cached as identifier values. (optional operation)

Specified by:
disassemble in interface CompositeUserType
Parameters:
value - the object to be cached
Returns:
a cachable representation of the object
Throws:
HibernateException

assemble

public Object assemble(Serializable cached,
                       SessionImplementor session,
                       Object owner)
                throws HibernateException
Description copied from interface: CompositeUserType
Reconstruct an object from the cacheable representation. At the very least this method should perform a deep copy. (optional operation)

Specified by:
assemble in interface CompositeUserType
Parameters:
cached - the object to be cached
owner - the owner of the cached object
Returns:
a reconstructed object from the cachable representation
Throws:
HibernateException

replace

public Object replace(Object original,
                      Object target,
                      SessionImplementor session,
                      Object owner)
               throws HibernateException
Description copied from interface: CompositeUserType
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. For immutable objects, or null values, it is safe to simply return the first parameter. For mutable objects, it is safe to return a copy of the first parameter. However, since composite user types often define component values, it might make sense to recursively replace component values in the target object.

Specified by:
replace in interface CompositeUserType
Throws:
HibernateException


Copyright © 2001-2012 Red Hat, Inc. All Rights Reserved.