Class AnyType

public AnyType(Type metaType,
               Type identifierType)

public Object assemble(Serializable cached,
                       SessionImplementor session,
                       Object owner)
            throws HibernateException

Reconstruct the object from its cached "disassembled" state.

Specified by:

assemble in interface Type

Overrides:

assemble in interface AbstractType

Parameters:

cached - the disassembled state from the cache

session - the session

owner - the parent entity object

Returns:

the the object

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 -

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.

Specified by:

deepCopy in interface Type

Parameters:

value - generally a collection element or entity field

entityMode -

factory -

Returns:

Object a copy

public Serializable disassemble(Object value,
                                SessionImplementor session,
                                Object owner)
            throws HibernateException

Return a cacheable "disassembled" representation of the object.

Specified by:

disassemble in interface Type

Overrides:

disassemble in interface AbstractType

Parameters:

value - the value to cache

session - the session

owner - optional parent entity object (needed for collections)

Returns:

the disassembled, deep cloned state

public Object fromXMLNode(Node xml,
                          Mapping factory)
            throws HibernateException

Parse the XML representation of an instance.

Specified by:

fromXMLNode in interface Type

Parameters:

xml -

factory -

Returns:

an instance of the type

Throws:

HibernateException -

public String getAssociatedEntityName(SessionFactoryImplementor factory)
            throws MappingException

Specified by:

getAssociatedEntityName in interface AssociationType

public Joinable getAssociatedJoinable(SessionFactoryImplementor factory)

Specified by:

getAssociatedJoinable in interface AssociationType

public CascadeStyle getCascadeStyle(int i)

Specified by:

getCascadeStyle in interface AbstractComponentType

public int getColumnSpan(Mapping session)
            throws MappingException

How many columns are used to persist this type.

Specified by:

getColumnSpan in interface Type

public FetchMode getFetchMode(int i)

Specified by:

getFetchMode in interface AbstractComponentType

public ForeignKeyDirection getForeignKeyDirection()

Specified by:

getForeignKeyDirection in interface AssociationType

public String getLHSPropertyName()

Specified by:

getLHSPropertyName in interface AssociationType

public String getName()

Returns the abbreviated name of the type.

Specified by:

getName in interface Type

Returns:

String the Hibernate type name

public String getOnCondition(String alias,
                             SessionFactoryImplementor factory,
                             Map enabledFilters)
            throws MappingException

Specified by:

getOnCondition in interface AssociationType

public String[] getPropertyNames()

Specified by:

getPropertyNames in interface AbstractComponentType

public boolean[] getPropertyNullability()

Specified by:

getPropertyNullability in interface AbstractComponentType

public Object getPropertyValue(Object component,
                               int i,
                               SessionImplementor session)
            throws HibernateException

Specified by:

getPropertyValue in interface AbstractComponentType

public Object[] getPropertyValues(Object component,
                                  EntityMode entityMode)

Specified by:

getPropertyValues in interface AbstractComponentType

public Object[] getPropertyValues(Object component,
                                  SessionImplementor session)
            throws HibernateException

Specified by:

getPropertyValues in interface AbstractComponentType

public String getRHSUniqueKeyPropertyName()

Specified by:

getRHSUniqueKeyPropertyName in interface AssociationType

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

public Type[] getSubtypes()

Specified by:

getSubtypes in interface AbstractComponentType

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

Specified by:

hydrate in interface Type

Overrides:

hydrate in interface AbstractType

Parameters:

rs -

names - the column names

session - the session

owner - the parent entity

Returns:

Object an identifier or actual value

Throws:

HibernateException -

See Also:

Type.resolve(Object,SessionImplementor,Object)

public boolean isAlwaysDirtyChecked()

Specified by:

isAlwaysDirtyChecked in interface AssociationType

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.

Specified by:

isAnyType in interface Type

Overrides:

isAnyType in interface AbstractType

public boolean isAssociationType()

Return true if the implementation is castable to AssociationType. This does not necessarily imply that the type actually represents an association.

Specified by:

isAssociationType in interface Type

Overrides:

isAssociationType in interface AbstractType

Returns:

boolean

See Also:

AssociationType

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.

Specified by:

isComponentType in interface Type

Overrides:

isComponentType in interface AbstractType

Returns:

boolean

See Also:

AbstractComponentType

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?

Specified by:

isDirty in interface Type

Parameters:

old - the old value

current - the current value

checkable - which columns are actually updatable

session -

Returns:

true if the field is dirty

public boolean isEmbedded()

Specified by:

isEmbedded in interface AbstractComponentType

public boolean isEmbeddedInXML()

Specified by:

isEmbeddedInXML in interface AssociationType

public boolean isMethodOf(Method method)

Specified by:

isMethodOf in interface AbstractComponentType

public boolean isModified(Object old,
                          Object current,
                          boolean[] checkable,
                          SessionImplementor session)
            throws HibernateException

Has the parent object been modified, compared to the current database state?

Specified by:

isModified in interface Type

Overrides:

isModified in interface AbstractType

Parameters:

checkable - which columns are actually updatable

session -

Returns:

true if the field has been modified

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

Specified by:

isMutable in interface Type

Returns:

boolean

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.

Specified by:

isSame in interface Type

Overrides:

isSame in interface AbstractType

Parameters:

x -

y -

entityMode -

Returns:

boolean

Throws:

HibernateException -

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.

Specified by:

nullSafeGet in interface Type

Parameters:

rs -

name - the column name

session -

owner - the parent entity

Returns:

Object

Throws:

HibernateException -

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.

Specified by:

nullSafeGet in interface Type

Parameters:

rs -

names - the column names

session -

owner - the parent entity

Returns:

Object

Throws:

HibernateException -

See Also:

alternative, 2-phase property initialization

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.

Specified by:

nullSafeSet in interface Type

Parameters:

st -

value - the object to write

index - statement parameter index

settable - an array indicating which columns to ignore

session -

Throws:

HibernateException -

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.

Specified by:

nullSafeSet in interface Type

Parameters:

st -

value - the object to write

index - statement parameter index

session -

Throws:

HibernateException -

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.

Specified by:

replace in interface Type

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

Specified by:

resolve in interface Type

Overrides:

resolve in interface AbstractType

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

Throws:

HibernateException -

See Also:

Type.hydrate(ResultSet,String[],SessionImplementor,Object)

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.

Specified by:

semiResolve in interface Type

Overrides:

semiResolve in interface AbstractType

public void setPropertyValues(Object component,
                              Object[] values,
                              EntityMode entityMode)
            throws HibernateException

Specified by:

setPropertyValues in interface AbstractComponentType

public void setToXMLNode(Node xml,
                         Object value,
                         SessionFactoryImplementor factory)

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

Specified by:

setToXMLNode in interface Type

Parameters:

value -

factory -

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.

Specified by:

sqlTypes in interface Type

Returns:

the typecodes

Throws:

MappingException -

See Also:

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.

Specified by:

toColumnNullness in interface Type

Parameters:

value - an instance of the type

public String toLoggableString(Object value,
                               SessionFactoryImplementor factory)
            throws HibernateException

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

Specified by:

toLoggableString in interface Type

Parameters:

value -

factory -

Returns:

String

Throws:

HibernateException -

public boolean useLHSPrimaryKey()

Specified by:

useLHSPrimaryKey in interface AssociationType