org.hibernate.type
Class CurrencyType

java.lang.Object
  extended by org.hibernate.type.AbstractType
      extended by org.hibernate.type.NullableType
          extended by org.hibernate.type.ImmutableType
              extended by org.hibernate.type.CurrencyType
All Implemented Interfaces:
Serializable, LiteralType, Type

public class CurrencyType
extends ImmutableType
implements LiteralType

currency: A type that maps an SQL VARCHAR to a java.util.Currency

Author:
Gavin King
See Also:
Currency, Serialized Form

Field Summary
static Class CURRENCY_CLASS
           
 
Constructor Summary
CurrencyType()
           
 
Method Summary
 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.
 String getName()
          Returns the abbreviated name of the type.
 Class getReturnedClass()
          The class returned by nullSafeGet() methods.
 String objectToSQLString(Object value, Dialect dialect)
          String representation of the value, suitable for embedding in an SQL statement.
 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.ImmutableType
deepCopy, isMutable, replace
 
Methods inherited from class org.hibernate.type.NullableType
fromXMLNode, fromXMLString, getColumnSpan, isDirty, isEqual, isEqual, nullSafeGet, nullSafeGet, nullSafeGet, nullSafeGet, nullSafeSet, nullSafeSet, nullSafeSet, nullSafeToString, setToXMLNode, sqlTypes, toColumnNullness, toLoggableString, toXMLString
 
Methods inherited from class org.hibernate.type.AbstractType
assemble, beforeAssemble, compare, disassemble, getHashCode, 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
 

Field Detail

CURRENCY_CLASS

public static final Class CURRENCY_CLASS
Constructor Detail

CurrencyType

public CurrencyType()
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).
See Also:
NullableType.get(ResultSet, String)

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).
See Also:
NullableType.set(PreparedStatement, Object, int)

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.
See Also:
NullableType.sqlType()

toString

public String toString(Object value)
                throws HibernateException
Specified by:
toString in class NullableType
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
See Also:
Type.getReturnedClass()

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
See Also:
Type.getName()

objectToSQLString

public String objectToSQLString(Object value,
                                Dialect dialect)
                         throws Exception
Description copied from interface: LiteralType
String representation of the value, suitable for embedding in an SQL statement.

Specified by:
objectToSQLString in interface LiteralType
Returns:
String the value, as it appears in a SQL query
Throws:
Exception
See Also:
LiteralType.objectToSQLString(Object, Dialect)

fromStringValue

public Object fromStringValue(String xml)
                       throws HibernateException
Specified by:
fromStringValue in class NullableType
Throws:
HibernateException


Copyright © 2009 Hibernate.org. All Rights Reserved.