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

ObjectType (Hibernate API Documentation) - Hibernate 2.1.8 正式版 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

---

net.sf.hibernate.type
Class ObjectType

java.lang.Object
  net.sf.hibernate.type.AbstractType
      net.sf.hibernate.type.ObjectType

All Implemented Interfaces:

AbstractComponentType, AssociationType, Serializable, Type

---

public class ObjectType

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

 

Constructor Summary

ObjectType()

ObjectType(Type metaType, Type identifierType)

 

Method Summary
Object	assemble(Serializable cached, SessionImplementor session, Object owner)           Reconstruct the object from its cached "disassembled" state.
Cascades.CascadeStyle	cascade(int i)
Object	deepCopy(Object value)           Return a deep copy of the persistent state, stopping at entities and at collections.
Serializable	disassemble(Object value, SessionImplementor session)           Return a cacheable "disassembled" representation of the object.
int	enableJoinedFetch(int i)
boolean	equals(Object object)
boolean	equals(Object x, Object y)           Compare two instances of the class mapped by this type for persistence "equality", ie.
Object	fromString(String xml)           Parse the XML representation of an instance.
Class	getAssociatedClass(SessionFactoryImplementor factory)
int	getColumnSpan(Mapping session)           How many columns are used to persist this type.
ForeignKeyDirection	getForeignKeyDirection()           Get the foreign key directionality of this association
Joinable	getJoinable(SessionFactoryImplementor factory)           Get the "persister" for this association - a class or collection persister
String	getName()           Returns the abbreviated name of the type.
String[]	getPropertyNames()
Object	getPropertyValue(Object component, int i, SessionImplementor session)
Object[]	getPropertyValues(Object component)           Optional operation
Object[]	getPropertyValues(Object component, SessionImplementor session)
String[]	getReferencedColumns(SessionFactoryImplementor factory)           Get the columns referenced by this association.
Class	getReturnedClass()           The class returned by nullSafeGet() methods.
Type[]	getSubtypes()
int	hashCode()
boolean	hasNiceEquals()           Does this type implement a well-behaved equals() method.
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	isAssociationType()           Return true if the implementation is castable to AssociationType.
boolean	isComponentType()           Is this type a component type.
boolean	isModified(Object old, Object current, SessionImplementor session)           Has the parent object been modified, compared to the current database state?
boolean	isMutable()           Are objects of this type mutable.
boolean	isObjectType()           Is this an "object" type.
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, SessionImplementor session)           Write an instance of the mapped class to a prepared statement.
Object	resolveIdentifier(Object value, SessionImplementor session, Object owner)           Map identifiers to entities or collections.
void	setPropertyValues(Object component, Object[] values)           Optional operation
int[]	sqlTypes(Mapping mapping)           Return the SQL type codes for the columns mapped by this type.
String	toString(Object value, SessionFactoryImplementor factory)           A representation of the value to be embedded in an XML element.
boolean	usePrimaryKeyAsForeignKey()           Not really relevant to ObjectType, since it cannot by "joined"!

 

Methods inherited from class net.sf.hibernate.type.AbstractType

copy, isDirty, isEntityType, isPersistentCollectionType

 

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface net.sf.hibernate.type.Type

copy, isDirty, isEntityType, isPersistentCollectionType

 

Constructor Detail

ObjectType

public ObjectType(Type metaType,
                  Type identifierType)

---

ObjectType

public ObjectType()

Method Detail

deepCopy

public Object deepCopy(Object value)
                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

Returns:

Object a copy

Throws:

HibernateException

See Also:

Type.deepCopy(Object)

---

equals

public boolean equals(Object x,
                      Object y)
               throws HibernateException

Description copied from interface: Type

Compare two instances of the class mapped by this type for persistence "equality", ie. Equality of persistent state.

Specified by:

equals in interface Type

Parameters:

x -

y -

Returns:

boolean

Throws:

HibernateException

See Also:

Type.equals(Object, Object)

---

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

See Also:

Type.getColumnSpan(Mapping)

---

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

---

hasNiceEquals

public boolean hasNiceEquals()

Description copied from interface: Type

Does this type implement a well-behaved equals() method. (ie. one that is consistent with Type.equals().) Strictly, if this method returns true then x.equals(y) implies Type.equals(x, y) and also Type.equals(x, y) implies that probably x.equals(y)

Specified by:

hasNiceEquals in interface Type

See Also:

Type.hasNiceEquals()

---

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

See Also:

Type.isMutable()

---

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

See Also:

Type.nullSafeGet(ResultSet, String, SessionImplementor, Object)

---

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:

HibernateException

SQLException

See Also:

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

---

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

---

resolveIdentifier

public Object resolveIdentifier(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:

resolveIdentifier in interface Type

Overrides:

resolveIdentifier 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:

SQLException

HibernateException

See Also:

Type.nullSafeSet(PreparedStatement, Object, int, SessionImplementor)

---

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

---

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:

Type.sqlTypes(Mapping)

---

toString

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

Description copied from interface: Type

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

Specified by:

toString in interface Type

Parameters:

value -

factory -

Returns:

String

Throws:

HibernateException

---

fromString

public Object fromString(String xml)
                  throws HibernateException

Description copied from interface: Type

Parse the XML representation of an instance.

Specified by:

fromString in interface Type

Parameters:

xml -

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

See Also:

Type.assemble(Serializable, SessionImplementor, Object)

---

disassemble

public Serializable disassemble(Object value,
                                SessionImplementor session)
                         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

See Also:

Type.disassemble(Object, SessionImplementor)

---

isObjectType

public boolean isObjectType()

Description copied from interface: Type

Is this an "object" type. I.e. a reference to a persistent entity that is not modelled as a (foreign key) association.

Specified by:

isObjectType in interface Type

Overrides:

isObjectType in class AbstractType

See Also:

Type.isObjectType()

---

cascade

public Cascades.CascadeStyle cascade(int i)

Specified by:

cascade in interface AbstractComponentType

---

enableJoinedFetch

public int enableJoinedFetch(int i)

Specified by:

enableJoinedFetch in interface AbstractComponentType

---

getPropertyNames

public String[] getPropertyNames()

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

Specified by:

getPropertyValues in interface AbstractComponentType

Throws:

HibernateException

---

getSubtypes

public Type[] getSubtypes()

Specified by:

getSubtypes in interface AbstractComponentType

---

setPropertyValues

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

Description copied from interface: AbstractComponentType

Optional operation

Specified by:

setPropertyValues in interface AbstractComponentType

Throws:

HibernateException

---

getPropertyValues

public Object[] getPropertyValues(Object component)

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

---

usePrimaryKeyAsForeignKey

public boolean usePrimaryKeyAsForeignKey()

Not really relevant to ObjectType, since it cannot by "joined"!

Specified by:

usePrimaryKeyAsForeignKey in interface AssociationType

---

getJoinable

public Joinable getJoinable(SessionFactoryImplementor factory)

Description copied from interface: AssociationType

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

Specified by:

getJoinable in interface AssociationType

---

getReferencedColumns

public String[] getReferencedColumns(SessionFactoryImplementor factory)
                              throws MappingException

Description copied from interface: AssociationType

Get the columns referenced by this association.

Specified by:

getReferencedColumns in interface AssociationType

Throws:

MappingException

---

isModified

public boolean isModified(Object old,
                          Object current,
                          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

---

getAssociatedClass

public Class getAssociatedClass(SessionFactoryImplementor factory)
                         throws MappingException

Specified by:

getAssociatedClass in interface AssociationType

Throws:

MappingException

---

equals

public boolean equals(Object object)

Overrides:

equals in class AbstractType

---

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractType

---

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

---