public abstract class

AbstractStandardBasicType

extends Object
implements BasicType StringRepresentableType<T> XmlRepresentableType<T>
java.lang.Object
   ↳ org.hibernate.type.AbstractStandardBasicType<T>
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

TODO : javadoc

Summary

Public Constructors
AbstractStandardBasicType(SqlTypeDescriptor sqlTypeDescriptor, JavaTypeDescriptor<T> javaTypeDescriptor)
Public Methods
final Object assemble(Serializable cached, SessionImplementor session, Object owner)
Reconstruct the object from its cached "disassembled" state.
final 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.
final int compare(Object x, Object y, EntityMode entityMode)
Perform a Comparator style comparison between values
final Object deepCopy(Object value, EntityMode entityMode, SessionFactoryImplementor factory)
Return a deep copy of the persistent state, stopping at entities and at collections.
final Serializable disassemble(Object value, SessionImplementor session, Object owner)
Return a cacheable "disassembled" representation of the object.
T fromString(String string)
T fromStringValue(String xml)
Consume the given string representation back into this types java form.
final Object fromXMLNode(Node xml, Mapping factory)
Parse the XML representation of an instance.
T fromXMLString(String xml, Mapping factory)
Object get(ResultSet rs, String name, SessionImplementor session)
final int getColumnSpan(Mapping mapping)
How many columns are used to persist this type.
final int getHashCode(Object x, EntityMode entityMode)
Get a hash code, consistent with persistence "equality".
final int getHashCode(Object x, EntityMode entityMode, SessionFactoryImplementor factory)
Get a hash code, consistent with persistence "equality".
final JavaTypeDescriptor<T> getJavaTypeDescriptor()
String[] getRegistrationKeys()
Get the names under which this type should be registered in the type registry.
final Class getReturnedClass()
final Type getSemiResolvedType(SessionFactoryImplementor factory)
Get the type of a semi-resolved value.
final SqlTypeDescriptor getSqlTypeDescriptor()
final Object hydrate(ResultSet rs, String[] names, SessionImplementor session, Object owner)
Retrieve an instance of the mapped class, or the identifier of an entity or collection, from a JDBC resultset.
final boolean isAnyType()
Return true if the implementation is castable to AnyType.
final boolean isAssociationType()
Return true if the implementation is castable to AssociationType.
final boolean isCollectionType()
Return true if the implementation is castable to CollectionType.
final boolean isComponentType()
Return true if the implementation is castable to CompositeType.
final boolean isDirty(Object old, Object current, boolean[] checkable, SessionImplementor session)
Should the parent be considered dirty, given both the old and current value?
final boolean isDirty(Object old, Object current, SessionImplementor session)
Should the parent be considered dirty, given both the old and current value?
final boolean isEntityType()
Return true if the implementation is castable to EntityType.
final boolean isEqual(Object x, Object y, EntityMode entityMode)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).
final boolean isEqual(Object x, Object y, EntityMode entityMode, SessionFactoryImplementor factory)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).
final boolean isEqual(T one, T another)
final boolean isModified(Object oldHydratedState, Object currentState, boolean[] checkable, SessionImplementor session)
Has the value been modified compared to the current database state? The difference between this and the isDirty(Object, Object, boolean[], SessionImplementor) methods is that here we need to account for "partially" built values.
final boolean isMutable()
Are objects of this type mutable.
final boolean isSame(Object x, Object y, EntityMode entityMode)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state) taking a shortcut for entity references.
final boolean isXMLElement()
final Object nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner)
Retrieve an instance of the mapped class from a JDBC resultset.
final Object nullSafeGet(ResultSet rs, String name, SessionImplementor session, Object owner)
Retrieve an instance of the mapped class from a JDBC resultset.
final T nullSafeGet(ResultSet rs, String name, SessionImplementor session)
final void nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session)
Write an instance of the mapped class to a prepared statement.
final Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache)
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.
Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache, ForeignKeyDirection foreignKeyDirection)
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.
final Object resolve(Object value, SessionImplementor session, Object owner)
Map identifiers to entities or collections.
final Object semiResolve(Object value, SessionImplementor session, Object owner)
Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.
void set(PreparedStatement st, T value, int index, SessionImplementor session)
final void setToXMLNode(Node node, Object value, SessionFactoryImplementor factory)
A representation of the value to be embedded in an XML element.
final int[] sqlTypes(Mapping mapping)
Return the JDBC types codes (per java.sql.Types) for the columns mapped by this type.
boolean[] toColumnNullness(Object value, Mapping mapping)
Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.
final String toLoggableString(Object value, SessionFactoryImplementor factory)
A representation of the value to be embedded in a log file.
String toString(T value)
Render the value to the string representation.
String toXMLString(T value, SessionFactoryImplementor factory)
Protected Methods
final T deepCopy(T value)
final int getHashCode(Object x)
MutabilityPlan<T> getMutabilityPlan()
T getReplacement(T original, T target)
final boolean isDirty(Object old, Object current)
final boolean isSame(Object x, Object y)
final T nullSafeGet(ResultSet rs, String name, WrapperOptions options)
final void nullSafeSet(PreparedStatement st, Object value, int index, WrapperOptions options)
boolean registerUnderJavaType()
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.hibernate.type.BasicType
From interface org.hibernate.type.StringRepresentableType
From interface org.hibernate.type.Type
From interface org.hibernate.type.XmlRepresentableType

Public Constructors

public AbstractStandardBasicType (SqlTypeDescriptor sqlTypeDescriptor, JavaTypeDescriptor<T> javaTypeDescriptor)

Public Methods

public final Object assemble (Serializable cached, SessionImplementor session, Object owner)

Reconstruct the object from its cached "disassembled" state.

Parameters
cached the disassembled state from the cache
session the session
owner the parent entity object
Returns
  • the the object

public final 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 final int compare (Object x, Object y, EntityMode entityMode)

Perform a Comparator style comparison between values

Parameters
x The first value
y The second value
entityMode The entity mode of the values.
Returns

public final Object deepCopy (Object value, EntityMode entityMode, SessionFactoryImplementor factory)

Return a deep copy of the persistent state, stopping at entities and at collections.

Parameters
value generally a collection element or entity field
Returns
  • Object a copy

public final Serializable disassemble (Object value, SessionImplementor session, Object owner)

Return a cacheable "disassembled" representation of the object.

Parameters
value the value to cache
session the session
owner optional parent entity object (needed for collections)
Returns
  • the disassembled, deep cloned state

public T fromString (String string)

public T fromStringValue (String xml)

Consume the given string representation back into this types java form.

Parameters
xml The string representation to be consumed.
Returns
  • The java type representation

public final Object fromXMLNode (Node xml, Mapping factory)

Parse the XML representation of an instance.

Returns
  • an instance of the type

public T fromXMLString (String xml, Mapping factory)

public final int getColumnSpan (Mapping mapping)

How many columns are used to persist this type. Always the same as sqlTypes(mapping).length

Parameters
mapping The mapping object :/
Returns
  • The number of columns

public final int getHashCode (Object x, EntityMode entityMode)

Get a hash code, consistent with persistence "equality". Again for most types the normal usage is to delegate to the value's #hashCode.

Parameters
x The value for which to retrieve a hash code
entityMode The entity mode of the value.
Returns
  • The hash code

public final int getHashCode (Object x, EntityMode entityMode, SessionFactoryImplementor factory)

Get a hash code, consistent with persistence "equality". Again for most types the normal usage is to delegate to the value's #hashCode.

Parameters
x The value for which to retrieve a hash code
entityMode The entity mode of the value.
factory The session factory
Returns
  • The hash code

public final JavaTypeDescriptor<T> getJavaTypeDescriptor ()

public String[] getRegistrationKeys ()

Get the names under which this type should be registered in the type registry.

Returns
  • The keys under which to register this type.

public final Class getReturnedClass ()

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

Returns
  • The java type class handled by this type.

public final Type getSemiResolvedType (SessionFactoryImplementor factory)

Get the type of a semi-resolved value.

public final SqlTypeDescriptor getSqlTypeDescriptor ()

public final Object hydrate (ResultSet rs, String[] names, SessionImplementor session, Object owner)

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().

Parameters
names the column names
session the session
owner the parent entity
Returns
  • Object an identifier or actual value

public final boolean isAnyType ()

Return true if the implementation is castable to AnyType. Essentially a polymorphic version of (type instanceof AnyType.class).

An AnyType is additionally an AssociationType; so if this method returns true, isAssociationType() should also return true.

Returns
  • True if this type is also an AnyType implementor; false otherwise.

public final boolean isAssociationType ()

Return true if the implementation is castable to AssociationType. This does not necessarily imply that the type actually represents an association. Essentially a polymorphic version of (type instanceof AssociationType.class)

Returns
  • True if this type is also an AssociationType implementor; false otherwise.

public final boolean isCollectionType ()

Return true if the implementation is castable to CollectionType. Essentially a polymorphic version of (type instanceof CollectionType.class)

A CollectionType is additionally an AssociationType; so if this method returns true, isAssociationType() should also return true.

Returns
  • True if this type is also an CollectionType implementor; false otherwise.

public final boolean isComponentType ()

Return true if the implementation is castable to CompositeType. Essentially a polymorphic version of (type instanceof CompositeType.class). A component type may own collections or associations and hence must provide certain extra functionality.

Returns
  • True if this type is also an CompositeType implementor; false otherwise.

public final boolean isDirty (Object old, Object current, boolean[] checkable, SessionImplementor session)

Should the parent be considered dirty, given both the old and current value?

Parameters
old the old value
current the current value
checkable An array of booleans indicating which columns making up the value are actually checkable
session The session from which the request originated.
Returns
  • true if the field is dirty

public final boolean isDirty (Object old, Object current, SessionImplementor session)

Should the parent be considered dirty, given both the old and current value?

Parameters
old the old value
current the current value
session The session from which the request originated.
Returns
  • true if the field is dirty

public final boolean isEntityType ()

Return true if the implementation is castable to EntityType. Essentially a polymorphic version of (type instanceof EntityType.class).

An EntityType is additionally an AssociationType; so if this method returns true, isAssociationType() should also return true.

Returns
  • True if this type is also an EntityType implementor; false otherwise.

public final boolean isEqual (Object x, Object y, EntityMode entityMode)

Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).

This should always equate to some form of comparison of the value's internal state. As an example, for something like a date the comparison should be based on its internal "time" state based on the specific portion it is meant to represent (timestamp, date, time).

Parameters
x The first value
y The second value
entityMode The entity mode of the values.
Returns
  • True if there are considered equal (see discussion above).

public final boolean isEqual (Object x, Object y, EntityMode entityMode, SessionFactoryImplementor factory)

Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).

This should always equate to some form of comparison of the value's internal state. As an example, for something like a date the comparison should be based on its internal "time" state based on the specific portion it is meant to represent (timestamp, date, time).

Parameters
x The first value
y The second value
entityMode The entity mode of the values.
factory The session factory
Returns
  • True if there are considered equal (see discussion above).

public final boolean isEqual (T one, T another)

public final boolean isModified (Object oldHydratedState, Object currentState, boolean[] checkable, SessionImplementor session)

Has the value been modified compared to the current database state? The difference between this and the isDirty(Object, Object, boolean[], SessionImplementor) methods is that here we need to account for "partially" built values. This is really only an issue with association types. For most type implementations it is enough to simply delegate to isDirty(Object, Object, boolean[], SessionImplementor) here/

Parameters
oldHydratedState the database state, in a "hydrated" form, with identifiers unresolved
currentState the current state of the object
checkable which columns are actually updatable
session The session from which the request originated.
Returns
  • true if the field has been modified

public final 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.)

Returns
  • boolean

public final boolean isSame (Object x, Object y, EntityMode entityMode)

Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state) taking a shortcut for entity references.

For most types this should equate to #equals check on the values. For associations the implication is a bit different. For most types it is conceivable to simply delegate to isEqual(Object, Object, EntityMode)

Parameters
x The first value
y The second value
entityMode The entity mode of the values.
Returns
  • True if there are considered the same (see discussion above).

public final boolean isXMLElement ()

public final Object nullSafeGet (ResultSet rs, String[] names, SessionImplementor session, Object owner)

Retrieve an instance of the mapped class from a JDBC resultset. Implementors should handle possibility of null values.

Parameters
names the column names
owner the parent entity
Returns
  • Object
Throws
SQLException

public final Object nullSafeGet (ResultSet rs, String name, SessionImplementor session, Object owner)

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.

Parameters
name the column name
owner the parent entity
Returns
  • Object
Throws
SQLException

public final T nullSafeGet (ResultSet rs, String name, SessionImplementor session)

Throws
SQLException

public final void nullSafeSet (PreparedStatement st, Object value, int index, SessionImplementor session)

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.

Parameters
value the object to write
index statement parameter index
Throws
SQLException

public final Object replace (Object original, Object target, SessionImplementor session, Object owner, Map copyCache)

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.

Parameters
original the value from the detached entity being merged
target the value in the managed entity
Returns
  • the value to be merged

public Object replace (Object original, Object target, SessionImplementor session, Object owner, Map copyCache, ForeignKeyDirection foreignKeyDirection)

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.

Parameters
original the value from the detached entity being merged
target the value in the managed entity
Returns
  • the value to be merged

public final Object resolve (Object value, SessionImplementor session, Object owner)

Map identifiers to entities or collections. This is the second phase of 2-phase property initialization.

Parameters
value an identifier or value returned by hydrate()
session the session
owner the parent entity
Returns
  • the given value, or the value associated with the identifier

public final Object semiResolve (Object value, SessionImplementor session, Object owner)

Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.

public void set (PreparedStatement st, T value, int index, SessionImplementor session)

public final void setToXMLNode (Node node, Object value, SessionFactoryImplementor factory)

A representation of the value to be embedded in an XML element.

Returns
  • String

public final int[] sqlTypes (Mapping mapping)

Return the JDBC types codes (per java.sql.Types) for the columns mapped by this type.

Parameters
mapping The mapping object :/
Returns
  • The JDBC type codes.

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.

Parameters
value an instance of the type

public final String toLoggableString (Object value, SessionFactoryImplementor factory)

A representation of the value to be embedded in a log file.

Returns
  • String

public String toString (T value)

Render the value to the string representation.

Parameters
value The value to render to string.
Returns
  • The string representation

public String toXMLString (T value, SessionFactoryImplementor factory)

Protected Methods

protected final T deepCopy (T value)

protected final int getHashCode (Object x)

protected MutabilityPlan<T> getMutabilityPlan ()

protected T getReplacement (T original, T target)

protected final boolean isDirty (Object old, Object current)

protected final boolean isSame (Object x, Object y)

protected final T nullSafeGet (ResultSet rs, String name, WrapperOptions options)

Throws
SQLException

protected final void nullSafeSet (PreparedStatement st, Object value, int index, WrapperOptions options)

Throws
SQLException

protected boolean registerUnderJavaType ()