org.hibernate.type
Class CalendarType

java.lang.Object
  org.hibernate.type.AbstractType
      org.hibernate.type.NullableType
          org.hibernate.type.MutableType
              org.hibernate.type.CalendarType

All Implemented Interfaces:

Serializable, Type, VersionType

public class CalendarType
extends MutableType
implements VersionType

calendar: A type mapping for a Calendar object that represents a datetime.

Author:

Gavin King

See Also:

Serialized Form

Constructor Summary

CalendarType()

Method Summary

int	compare(Object x, Object y, EntityMode entityMode) compare two instances of the type
Object	deepCopyNotNull(Object value)
Object	fromStringValue(String xml)
Object	get(ResultSet rs, String name) Get a column value from a result set, without worrying about the possibility of null values.
Comparator	getComparator() Get a comparator for version values.
int	getHashCode(Object x, EntityMode entityMode) Get a hashcode, consistent with persistence "equality"
String	getName() Returns the abbreviated name of the type.
Class	getReturnedClass() The class returned by nullSafeGet() methods.
boolean	isEqual(Object x, Object y) Are the two version values considered equal?
Object	next(Object current, SessionImplementor session) Increment the version.
Object	seed(SessionImplementor session) Generate an initial version.
void	set(PreparedStatement st, Object value, int index) Set a parameter value without worrying about the possibility of null values.
int	sqlType() A convenience form of NullableType.sqlTypes(org.hibernate.engine.Mapping), returning just a single type value since these are explicitly dealing with single column mappings.
String	toString(Object value)

Methods inherited from class org.hibernate.type.MutableType

deepCopy, isMutable, replace

Methods inherited from class org.hibernate.type.NullableType

fromXMLNode, fromXMLString, getColumnSpan, isDirty, isEqual, nullSafeGet, nullSafeGet, nullSafeGet, nullSafeGet, nullSafeSet, nullSafeSet, nullSafeSet, nullSafeToString, setToXMLNode, sqlTypes, toColumnNullness, toLoggableString, toXMLString

Methods inherited from class org.hibernate.type.AbstractType

assemble, beforeAssemble, disassemble, 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

assemble, beforeAssemble, deepCopy, disassemble, fromXMLNode, getColumnSpan, getHashCode, 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

Constructor Detail

CalendarType

public CalendarType()

Method Detail

get

public Object get(ResultSet rs,
                  String name)
           throws HibernateException,
                  SQLException

Description copied from class: NullableType

Get a column value from a result set, without worrying about the possibility of null values. Called from NullableType.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.SessionImplementor, java.lang.Object) after nullness checks have been performed.

Specified by:

get in class NullableType

Parameters:

rs - The result set from which to extract the value.

name - The name of the value to extract.

Returns:

The extracted value.

Throws:

HibernateException - Generally some form of mismatch error.

SQLException - Indicates problem making the JDBC call(s).

set

public void set(PreparedStatement st,
                Object value,
                int index)
         throws HibernateException,
                SQLException

Description copied from class: NullableType

Set a parameter value without worrying about the possibility of null values. Called from NullableType.nullSafeSet(java.sql.PreparedStatement, java.lang.Object, int, boolean[], org.hibernate.engine.SessionImplementor) after nullness checks have been performed.

Specified by:

set in class NullableType

Parameters:

st - The statement into which to bind the parameter value.

value - The parameter value to bind.

index - The position or index at which to bind the param value.

Throws:

HibernateException - Generally some form of mismatch error.

SQLException - Indicates problem making the JDBC call(s).

sqlType

public int sqlType()

Description copied from class: NullableType

A convenience form of NullableType.sqlTypes(org.hibernate.engine.Mapping), returning just a single type value since these are explicitly dealing with single column mappings.

Specified by:

sqlType in class NullableType

Returns:

The Types mapping value.

toString

public String toString(Object value)
                throws HibernateException

Specified by:

toString in class NullableType

Throws:

HibernateException

fromStringValue

public Object fromStringValue(String xml)
                       throws HibernateException

Specified by:

fromStringValue in class NullableType

Throws:

HibernateException

deepCopyNotNull

public Object deepCopyNotNull(Object value)
                       throws HibernateException

Specified by:

deepCopyNotNull in class MutableType

Throws:

HibernateException

getReturnedClass

public Class getReturnedClass()

Description copied from interface: Type

The class returned by nullSafeGet() methods. This is used to establish the class of an array of this type.

Specified by:

getReturnedClass in interface Type

Returns:

Class

compare

public int compare(Object x,
                   Object y,
                   EntityMode entityMode)

Description copied from interface: Type

compare two instances of the type

Specified by:

compare in interface Type

Overrides:

compare in class AbstractType

isEqual

public boolean isEqual(Object x,
                       Object y)

Description copied from interface: VersionType

Are the two version values considered equal?

Specified by:

isEqual in interface VersionType

Overrides:

isEqual in class NullableType

Parameters:

x - One value to check.

y - The other value to check.

Returns:

true if the values are equal, false otherwise.

getHashCode

public int getHashCode(Object x,
                       EntityMode entityMode)

Description copied from interface: Type

Get a hashcode, consistent with persistence "equality"

Specified by:

getHashCode in interface Type

Overrides:

getHashCode in class AbstractType

getName

public String getName()

Description copied from interface: Type

Returns the abbreviated name of the type.

Specified by:

getName in interface Type

Returns:

String the Hibernate type name

next

public Object next(Object current,
                   SessionImplementor session)

Description copied from interface: VersionType

Increment the version.

Specified by:

next in interface VersionType

Parameters:

current - the current version

session - The session from which this request originates.

Returns:

an instance of the type

seed

public Object seed(SessionImplementor session)

Description copied from interface: VersionType

Generate an initial version.

Specified by:

seed in interface VersionType

Parameters:

session - The session from which this request originates.

Returns:

an instance of the type

getComparator

public Comparator getComparator()

Description copied from interface: VersionType

Get a comparator for version values.

Specified by:

getComparator in interface VersionType

Returns:

The comparator to use to compare different version values.