Home » Hibernate-3.3.2.GA » org.hibernate » type » [javadoc | source]
org.hibernate.type
public interface: Type [javadoc | source]

All Implemented Interfaces:
    Serializable

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 from org.hibernate.type.Type Summary:
assemble,   beforeAssemble,   compare,   deepCopy,   disassemble,   fromXMLNode,   getColumnSpan,   getHashCode,   getHashCode,   getName,   getReturnedClass,   getSemiResolvedType,   hydrate,   isAnyType,   isAssociationType,   isCollectionType,   isComponentType,   isDirty,   isDirty,   isEntityType,   isEqual,   isEqual,   isModified,   isMutable,   isSame,   isXMLElement,   nullSafeGet,   nullSafeGet,   nullSafeSet,   nullSafeSet,   replace,   replace,   resolve,   semiResolve,   setToXMLNode,   sqlTypes,   toColumnNullness,   toLoggableString
Method from org.hibernate.type.Type Detail:
 public Object assemble(Serializable cached,
    SessionImplementor session,
    Object owner) throws HibernateException
    Reconstruct the object from its cached "disassembled" state.
 public  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.
 public int compare(Object x,
    Object y,
    EntityMode entityMode)
    compare two instances of the type
 public Object deepCopy(Object value,
    EntityMode entityMode,
    SessionFactoryImplementor factory) throws HibernateException
    Return a deep copy of the persistent state, stopping at entities and at collections.
 public Serializable disassemble(Object value,
    SessionImplementor session,
    Object owner) throws HibernateException
    Return a cacheable "disassembled" representation of the object.
 public Object fromXMLNode(Node xml,
    Mapping factory) throws HibernateException
    Parse the XML representation of an instance.
 public int getColumnSpan(Mapping mapping) throws MappingException
    How many columns are used to persist this type.
 public int getHashCode(Object x,
    EntityMode entityMode) throws HibernateException
    Get a hashcode, consistent with persistence "equality"
 public int getHashCode(Object x,
    EntityMode entityMode,
    SessionFactoryImplementor factory) throws HibernateException
    Get a hashcode, consistent with persistence "equality"
 public String getName()
    Returns the abbreviated name of the type.
 public Class getReturnedClass()
    The class returned by nullSafeGet() methods. This is used to establish the class of an array of this type.
 public Type getSemiResolvedType(SessionFactoryImplementor factory)
    Get the type of a semi-resolved value.
 public Object hydrate(ResultSet rs,
    String[] names,
    SessionImplementor session,
    Object owner) throws HibernateException, SQLException
    Retrieve an instance of the mapped class, or the identifier of an entity or collection, from a JDBC resultset. This is useful for 2-phase property initialization - the second phase is a call to resolveIdentifier().
 public boolean isAnyType()
    Is this an "any" type. i.e. a reference to a persistent entity that is not modelled as a (foreign key) association.
 public boolean isAssociationType()
    Return true if the implementation is castable to AssociationType. This does not necessarily imply that the type actually represents an association.
 public boolean isCollectionType()
    Is this type a collection type.
 public boolean isComponentType()
    Is this type a component type. If so, the implementation must be castable to AbstractComponentType. A component type may own collections or associations and hence must provide certain extra functionality.
 public boolean isDirty(Object old,
    Object current,
    SessionImplementor session) throws HibernateException
    Should the parent be considered dirty, given both the old and current field or element value?
 public boolean isDirty(Object old,
    Object current,
    boolean[] checkable,
    SessionImplementor session) throws HibernateException
    Should the parent be considered dirty, given both the old and current field or element value?
 public boolean isEntityType()
    Is this type an entity type?
 public boolean isEqual(Object x,
    Object y,
    EntityMode entityMode) throws HibernateException
    Compare two instances of the class mapped by this type for persistence "equality" - equality of persistent state.
 public boolean isEqual(Object x,
    Object y,
    EntityMode entityMode,
    SessionFactoryImplementor factory) throws HibernateException
    Compare two instances of the class mapped by this type for persistence "equality" - equality of persistent state.
 public boolean isModified(Object oldHydratedState,
    Object currentState,
    boolean[] checkable,
    SessionImplementor session) throws HibernateException
    Has the parent object been modified, compared to the current database state?
 public boolean isMutable()
    Are objects of this type mutable. (With respect to the referencing object ... entities and collections are considered immutable because they manage their own internal state.)
 public boolean isSame(Object x,
    Object y,
    EntityMode entityMode) throws HibernateException
    Compare two instances of the class mapped by this type for persistence "equality" - equality of persistent state - taking a shortcut for entity references.
 public boolean isXMLElement()
 public Object nullSafeGet(ResultSet rs,
    String[] names,
    SessionImplementor session,
    Object owner) throws HibernateException, SQLException
    Retrieve an instance of the mapped class from a JDBC resultset. Implementors should handle possibility of null values.
 public Object nullSafeGet(ResultSet rs,
    String name,
    SessionImplementor session,
    Object owner) throws HibernateException, SQLException
    Retrieve an instance of the mapped class from a JDBC resultset. Implementations should handle possibility of null values. This method might be called if the type is known to be a single-column type.
 public  void nullSafeSet(PreparedStatement st,
    Object value,
    int index,
    SessionImplementor session) throws HibernateException, SQLException
    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.
 public  void nullSafeSet(PreparedStatement st,
    Object value,
    int index,
    boolean[] settable,
    SessionImplementor session) throws HibernateException, SQLException
    Write an instance of the mapped class to a prepared statement, ignoring some columns. Implementors should handle possibility of null values. A multi-column type should be written to parameters starting from index.
 public Object replace(Object original,
    Object target,
    SessionImplementor session,
    Object owner,
    Map copyCache) throws HibernateException
    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. For objects with component values, it might make sense to recursively replace component values.
 public Object replace(Object original,
    Object target,
    SessionImplementor session,
    Object owner,
    Map copyCache,
    ForeignKeyDirection foreignKeyDirection) throws HibernateException
    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. For objects with component values, it might make sense to recursively replace component values.
 public Object resolve(Object value,
    SessionImplementor session,
    Object owner) throws HibernateException
    Map identifiers to entities or collections. This is the second phase of 2-phase property initialization.
 public Object semiResolve(Object value,
    SessionImplementor session,
    Object owner) throws HibernateException
    Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.
 public  void setToXMLNode(Node node,
    Object value,
    SessionFactoryImplementor factory) throws HibernateException
    A representation of the value to be embedded in an XML element.
 public int[] sqlTypes(Mapping mapping) throws MappingException
    Return the SQL type codes for the columns mapped by this type. The codes are defined on java.sql.Types.
 public boolean[] toColumnNullness(Object value,
    Mapping mapping)
    Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.
 public String toLoggableString(Object value,
    SessionFactoryImplementor factory) throws HibernateException
    A representation of the value to be embedded in a log file.