org.hibernate.type

Class LocaleType

Implemented Interfaces:
LiteralType, Serializable, Type

public class LocaleType
extends ImmutableType
implements LiteralType

locale: A type that maps an SQL VARCHAR to a Java Locale.
Author:
Gavin King

Method Summary

int
compare(Object x, Object y, EntityMode entityMode)
compare two instances of the type
Object
fromStringValue(String string)
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(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

fromStringValue, fromXMLNode, fromXMLString, get, getColumnSpan, isDirty, isEqual, isEqual, nullSafeGet, nullSafeGet, nullSafeGet, nullSafeGet, nullSafeSet, nullSafeSet, nullSafeSet, nullSafeToString, set, setToXMLNode, sqlType, sqlTypes, toColumnNullness, toLoggableString, toString, toXMLString

Methods inherited from class org.hibernate.type.AbstractType

assemble, beforeAssemble, compare, disassemble, getHashCode, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isEqual, isModified, isSame, isXMLElement, replace, replaceNode, resolve, semiResolve

Method Details

compare

public int compare(Object x,
                   Object y,
                   EntityMode entityMode)
compare two instances of the type
Specified by:
compare in interface Type
Overrides:
compare in interface AbstractType
Parameters:
entityMode -

fromStringValue

public Object fromStringValue(String string)
Overrides:
fromStringValue in interface NullableType

get

public Object get(ResultSet rs,
                  String name)
            throws HibernateException,
                   SQLException
Get a column value from a result set, without worrying about the possibility of null values. Called from nullSafeGet after nullness checks have been performed.
Overrides:
get in interface 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.

getName

public String getName()
Returns the abbreviated name of the type.
Specified by:
getName in interface Type
Returns:
String the Hibernate type name

getReturnedClass

public Class getReturnedClass()
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

objectToSQLString

public String objectToSQLString(Object value,
                                Dialect dialect)
            throws Exception
String representation of the value, suitable for embedding in an SQL statement.
Specified by:
objectToSQLString in interface LiteralType
Parameters:
value -
dialect -
Returns:
String the value, as it appears in a SQL query

set

public void set(PreparedStatement st,
                Object value,
                int index)
            throws HibernateException,
                   SQLException
Set a parameter value without worrying about the possibility of null values. Called from nullSafeSet after nullness checks have been performed.
Overrides:
set in interface 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.

sqlType

public int sqlType()
A convenience form of NullableType.sqlTypes(Mapping), returning just a single type value since these are explicitly dealing with single column mappings.
Overrides:
sqlType in interface NullableType
Returns:
The java.sql.Types mapping value.

toString

public String toString(Object value)
            throws HibernateException
Overrides:
toString in interface NullableType