当前页面: 在线文档首页 > Hibernate 3.2.4 正式版 API 英文文档

AnyType (Hibernate API Documentation) - Hibernate 3.2.4 正式版 API 英文文档

Overview  Package   Class  Use  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.hibernate.type
Class AnyType

java.lang.Object
  org.hibernate.type.AbstractType
      org.hibernate.type.AnyType

All Implemented Interfaces:

AbstractComponentType, AssociationType, Serializable, Type

---

public class AnyType

extends AbstractType

implements AbstractComponentType, AssociationType

Handles "any" mappings and the old deprecated "object" type

Author:

Gavin King

See Also:

Serialized Form

---

Nested Class Summary
static class	AnyType.ObjectTypeCacheEntry

 

Constructor Summary

AnyType()

AnyType(Type metaType, Type identifierType)

 

Method Summary
Object	assemble(Serializable cached, SessionImplementor session, Object owner)           Reconstruct the object from its cached "disassembled" state.
int	compare(Object x, Object y, EntityMode entityMode)           compare two instances of the type
Object	deepCopy(Object value, EntityMode entityMode, SessionFactoryImplementor factory)           Return a deep copy of the persistent state, stopping at entities and at collections.
Serializable	disassemble(Object value, SessionImplementor session, Object owner)           Return a cacheable "disassembled" representation of the object.
Object	fromXMLNode(org.dom4j.Node xml, Mapping factory)           Parse the XML representation of an instance.
String	getAssociatedEntityName(SessionFactoryImplementor factory)           Get the entity name of the associated entity
Joinable	getAssociatedJoinable(SessionFactoryImplementor factory)           Get the "persister" for this association - a class or collection persister
CascadeStyle	getCascadeStyle(int i)
int	getColumnSpan(Mapping session)           How many columns are used to persist this type.
FetchMode	getFetchMode(int i)
ForeignKeyDirection	getForeignKeyDirection()           Get the foreign key directionality of this association
String	getLHSPropertyName()           Get the name of a property in the owning entity that provides the join key (null if the identifier)
String	getName()           Returns the abbreviated name of the type.
String	getOnCondition(String alias, SessionFactoryImplementor factory, Map enabledFilters)           Get the "filtering" SQL fragment that is applied in the SQL on clause, in addition to the usual join condition
String[]	getPropertyNames()           Get the names of the component properties
boolean[]	getPropertyNullability()           Optional operation
Object	getPropertyValue(Object component, int i, SessionImplementor session)
Object[]	getPropertyValues(Object component, EntityMode entityMode)           Optional operation
Object[]	getPropertyValues(Object component, SessionImplementor session)           Get the values of the component properties of a component instance
Class	getReturnedClass()           The class returned by nullSafeGet() methods.
String	getRHSUniqueKeyPropertyName()           The name of a unique property of the associated entity that provides the join key (null if the identifier of an entity, or key of a collection)
Type[]	getSubtypes()           Get the types of the component properties
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.
boolean	isAlwaysDirtyChecked()           Do we dirty check this association, even when there are no columns to be updated?
boolean	isAnyType()           Is this an "any" type.
boolean	isAssociationType()           Return true if the implementation is castable to AssociationType.
boolean	isComponentType()           Is this type a component type.
boolean	isDirty(Object old, Object current, boolean[] checkable, SessionImplementor session)           Should the parent be considered dirty, given both the old and current field or element value?
boolean	isEmbedded()
boolean	isEmbeddedInXML()
boolean	isMethodOf(Method method)
boolean	isModified(Object old, Object current, boolean[] checkable, SessionImplementor session)           Has the parent object been modified, compared to the current database state?
boolean	isMutable()           Are objects of this type mutable.
boolean	isReferenceToPrimaryKey()
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.
Object	nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner)           Retrieve an instance of the mapped class from a JDBC resultset.
Object	nullSafeGet(ResultSet rs, String name, SessionImplementor session, Object owner)           Retrieve an instance of the mapped class from a JDBC resultset.
void	nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SessionImplementor session)           Write an instance of the mapped class to a prepared statement, ignoring some columns.
void	nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session)           Write an instance of the mapped class to a prepared statement.
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	resolve(Object value, SessionImplementor session, Object owner)           Map identifiers to entities or collections.
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	setPropertyValues(Object component, Object[] values, EntityMode entityMode)           Optional operation
void	setToXMLNode(org.dom4j.Node xml, Object value, SessionFactoryImplementor factory)           A representation of the value to be embedded in an XML element.
int[]	sqlTypes(Mapping mapping)           Return the SQL type codes 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.
String	toLoggableString(Object value, SessionFactoryImplementor factory)           A representation of the value to be embedded in a log file.
boolean	useLHSPrimaryKey()           Is the primary key of the owning entity table to be used in the join?

 

Methods inherited from class org.hibernate.type.AbstractType

beforeAssemble, getHashCode, getHashCode, getSemiResolvedType, isCollectionType, isDirty, isEntityType, isEqual, isEqual, isXMLElement, replace, replaceNode

 

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

beforeAssemble, getHashCode, getHashCode, getSemiResolvedType, isCollectionType, isDirty, isEntityType, isEqual, isEqual, isXMLElement, replace

 

Constructor Detail

AnyType

public AnyType(Type metaType,
               Type identifierType)

---

AnyType

public AnyType()

Method Detail

deepCopy

public Object deepCopy(Object value,
                       EntityMode entityMode,
                       SessionFactoryImplementor factory)
                throws HibernateException

Description copied from interface: Type

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

Throws:

HibernateException

---

isMethodOf

public boolean isMethodOf(Method method)

Specified by:

isMethodOf in interface AbstractComponentType

---

isSame

public boolean isSame(Object x,
                      Object y,
                      EntityMode entityMode)
               throws HibernateException

Description copied from interface: Type

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 class AbstractType

Throws:

HibernateException

---

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

---

getColumnSpan

public int getColumnSpan(Mapping session)
                  throws MappingException

Description copied from interface: Type

How many columns are used to persist this type.

Specified by:

getColumnSpan in interface Type

Throws:

MappingException

---

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

---

isMutable

public boolean isMutable()

Description copied from interface: Type

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

---

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String name,
                          SessionImplementor session,
                          Object owner)
                   throws HibernateException,
                          SQLException

Description copied from interface: Type

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:

SQLException

HibernateException

---

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String[] names,
                          SessionImplementor session,
                          Object owner)
                   throws HibernateException,
                          SQLException

Description copied from interface: Type

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:

SQLException

HibernateException

See Also:

alternative, 2-phase property initialization

---

hydrate

public Object hydrate(ResultSet rs,
                      String[] names,
                      SessionImplementor session,
                      Object owner)
               throws HibernateException,
                      SQLException

Description copied from interface: Type

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 class AbstractType

Throws:

HibernateException

SQLException

---

resolve

public Object resolve(Object value,
                      SessionImplementor session,
                      Object owner)
               throws HibernateException

Description copied from interface: Type

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 class AbstractType

Throws:

HibernateException

---

semiResolve

public Object semiResolve(Object value,
                          SessionImplementor session,
                          Object owner)
                   throws HibernateException

Description copied from interface: Type

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 class AbstractType

Throws:

HibernateException

---

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int index,
                        SessionImplementor session)
                 throws HibernateException,
                        SQLException

Description copied from interface: Type

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

SQLException

---

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int index,
                        boolean[] settable,
                        SessionImplementor session)
                 throws HibernateException,
                        SQLException

Description copied from interface: Type

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:

SQLException

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

---

sqlTypes

public int[] sqlTypes(Mapping mapping)
               throws MappingException

Description copied from interface: Type

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:

Types

---

setToXMLNode

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

Description copied from interface: Type

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

Specified by:

setToXMLNode in interface Type

Parameters:

value -

factory -

Returns:

String

---

toLoggableString

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

Description copied from interface: Type

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

---

fromXMLNode

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

Description copied from interface: Type

Parse the XML representation of an instance.

Specified by:

fromXMLNode in interface Type

Parameters:

xml -

factory -

Returns:

an instance of the type

Throws:

HibernateException

---

assemble

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

Description copied from interface: Type

Reconstruct the object from its cached "disassembled" state.

Specified by:

assemble in interface Type

Overrides:

assemble in class AbstractType

Throws:

HibernateException

---

disassemble

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

Description copied from interface: Type

Return a cacheable "disassembled" representation of the object.

Specified by:

disassemble in interface Type

Overrides:

disassemble in class AbstractType

Throws:

HibernateException

---

isAnyType

public boolean isAnyType()

Description copied from interface: Type

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 class AbstractType

---

replace

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

Description copied from interface: Type

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

Throws:

HibernateException

---

getCascadeStyle

public CascadeStyle getCascadeStyle(int i)

Specified by:

getCascadeStyle in interface AbstractComponentType

---

getFetchMode

public FetchMode getFetchMode(int i)

Specified by:

getFetchMode in interface AbstractComponentType

---

getPropertyNames

public String[] getPropertyNames()

Description copied from interface: AbstractComponentType

Get the names of the component properties

Specified by:

getPropertyNames in interface AbstractComponentType

---

getPropertyValue

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

Specified by:

getPropertyValue in interface AbstractComponentType

Throws:

HibernateException

---

getPropertyValues

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

Description copied from interface: AbstractComponentType

Get the values of the component properties of a component instance

Specified by:

getPropertyValues in interface AbstractComponentType

Throws:

HibernateException

---

getSubtypes

public Type[] getSubtypes()

Description copied from interface: AbstractComponentType

Get the types of the component properties

Specified by:

getSubtypes in interface AbstractComponentType

---

setPropertyValues

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

Description copied from interface: AbstractComponentType

Optional operation

Specified by:

setPropertyValues in interface AbstractComponentType

Throws:

HibernateException

---

getPropertyValues

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

Description copied from interface: AbstractComponentType

Optional operation

Specified by:

getPropertyValues in interface AbstractComponentType

---

isComponentType

public boolean isComponentType()

Description copied from interface: Type

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 class AbstractType

---

getForeignKeyDirection

public ForeignKeyDirection getForeignKeyDirection()

Description copied from interface: AssociationType

Get the foreign key directionality of this association

Specified by:

getForeignKeyDirection in interface AssociationType

---

isAssociationType

public boolean isAssociationType()

Description copied from interface: Type

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 class AbstractType

---

useLHSPrimaryKey

public boolean useLHSPrimaryKey()

Description copied from interface: AssociationType

Is the primary key of the owning entity table to be used in the join?

Specified by:

useLHSPrimaryKey in interface AssociationType

---

getAssociatedJoinable

public Joinable getAssociatedJoinable(SessionFactoryImplementor factory)

Description copied from interface: AssociationType

Get the "persister" for this association - a class or collection persister

Specified by:

getAssociatedJoinable in interface AssociationType

---

isModified

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

Description copied from interface: Type

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

Specified by:

isModified in interface Type

Overrides:

isModified in class AbstractType

Throws:

HibernateException

---

getAssociatedEntityName

public String getAssociatedEntityName(SessionFactoryImplementor factory)
                               throws MappingException

Description copied from interface: AssociationType

Get the entity name of the associated entity

Specified by:

getAssociatedEntityName in interface AssociationType

Throws:

MappingException

---

getPropertyNullability

public boolean[] getPropertyNullability()

Description copied from interface: AbstractComponentType

Optional operation

Specified by:

getPropertyNullability in interface AbstractComponentType

Returns:

nullability of component properties

---

getOnCondition

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

Description copied from interface: AssociationType

Get the "filtering" SQL fragment that is applied in the SQL on clause, in addition to the usual join condition

Specified by:

getOnCondition in interface AssociationType

Throws:

MappingException

---

isReferenceToPrimaryKey

public boolean isReferenceToPrimaryKey()

---

getRHSUniqueKeyPropertyName

public String getRHSUniqueKeyPropertyName()

Description copied from interface: AssociationType

The name of a unique property of the associated entity that provides the join key (null if the identifier of an entity, or key of a collection)

Specified by:

getRHSUniqueKeyPropertyName in interface AssociationType

---

getLHSPropertyName

public String getLHSPropertyName()

Description copied from interface: AssociationType

Get the name of a property in the owning entity that provides the join key (null if the identifier)

Specified by:

getLHSPropertyName in interface AssociationType

---

isAlwaysDirtyChecked

public boolean isAlwaysDirtyChecked()

Description copied from interface: AssociationType

Do we dirty check this association, even when there are no columns to be updated?

Specified by:

isAlwaysDirtyChecked in interface AssociationType

---

isEmbeddedInXML

public boolean isEmbeddedInXML()

Specified by:

isEmbeddedInXML in interface AssociationType

---

toColumnNullness

public boolean[] toColumnNullness(Object value,
                                  Mapping mapping)

Description copied from interface: Type

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

---

isDirty

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

Description copied from interface: Type

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

Throws:

HibernateException

---

isEmbedded

public boolean isEmbedded()

Specified by:

isEmbedded in interface AbstractComponentType

---

Overview  Package   Class  Use  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---