| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.hibernate.type.AbstractType
org.hibernate.type.ComponentType
public class ComponentType
Handles "component" mappings
| Field Summary | |
|---|---|
| protected  int | propertySpan | 
| protected  EntityModeToTuplizerMapping | tuplizerMapping | 
| Constructor Summary | |
|---|---|
| ComponentType(TypeFactory.TypeScope typeScope,
              ComponentMetamodel metamodel) | |
| Method Summary | |
|---|---|
|  Object | assemble(Serializable object,
         SessionImplementor session,
         Object owner)Reconstruct the object from its cached "disassembled" state. | 
|  int | compare(Object x,
        Object y,
        EntityMode entityMode)Perform a Comparatorstyle comparison between values | 
|  Object | deepCopy(Object component,
         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. | 
|  CascadeStyle | getCascadeStyle(int i)Retrieve the cascade style of the indicated component property. | 
|  int | getColumnSpan(Mapping mapping)How many columns are used to persist this type. | 
|  FetchMode | getFetchMode(int i)Retrieve the fetch mode of the indicated component property. | 
|  int | getHashCode(Object x,
            EntityMode entityMode)Get a hash code, consistent with persistence "equality". | 
|  int | getHashCode(Object x,
            EntityMode entityMode,
            SessionFactoryImplementor factory)Get a hash code, consistent with persistence "equality". | 
|  String | getName()Returns the abbreviated name of the type. | 
|  int | getPropertyIndex(String name) | 
|  String[] | getPropertyNames()Get the names of the component properties | 
|  boolean[] | getPropertyNullability()Retrieve the indicators regarding which component properties are nullable. | 
|  Object | getPropertyValue(Object component,
                 int i,
                 EntityMode entityMode) | 
|  Object | getPropertyValue(Object component,
                 int i,
                 SessionImplementor session)Extract a particular component property value indicated by index. | 
|  Object[] | getPropertyValues(Object component,
                  EntityMode entityMode)Extract the values of the component properties from the given component instance without access to the session. | 
|  Object[] | getPropertyValues(Object component,
                  SessionImplementor session)Extract the values of the component properties from the given component instance | 
|  Class | getReturnedClass()The class returned by Type.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.SessionImplementor, java.lang.Object)methods. | 
|  Type[] | getSubtypes()Get the types of the component properties | 
|  EntityModeToTuplizerMapping | getTuplizerMapping() | 
|  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. | 
|  Object | instantiate(EntityMode entityMode)This method does not populate the component parent | 
|  Object | instantiate(Object parent,
            SessionImplementor session) | 
|  boolean | isComponentType()Return true if the implementation is castable to CompositeType. | 
|  boolean | isDirty(Object x,
        Object y,
        boolean[] checkable,
        SessionImplementor session)Should the parent be considered dirty, given both the old and current value? | 
|  boolean | isDirty(Object x,
        Object y,
        SessionImplementor session)Should the parent be considered dirty, given both the old and current value? | 
|  boolean | isEmbedded()Is this component embedded? "embedded" indicates that the component is "virtual", that its properties are "flattened" onto its owner | 
|  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). | 
|  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). | 
|  boolean | isKey() | 
|  boolean | isMethodOf(Method method)Is the given method a member of this component's class? | 
|  boolean | isModified(Object old,
           Object current,
           boolean[] checkable,
           SessionImplementor session)Has the value been modified compared to the current database state? The difference between this and the Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.SessionImplementor)methods is that here we need to account for "partially" built values. | 
|  boolean | isMutable()Are objects of this type mutable. | 
|  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. | 
|  boolean | isXMLElement() | 
|  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 begin,
            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 begin,
            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 | 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. | 
|  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)Inject property values onto the given component instance An optional operation | 
|  void | setToXMLNode(org.dom4j.Node node,
             Object value,
             SessionFactoryImplementor factory)A representation of the value to be embedded in an XML element. | 
|  int[] | sqlTypes(Mapping mapping)Return the JDBC types codes (per 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. | 
|  String | toLoggableString(Object value,
                 SessionFactoryImplementor factory)A representation of the value to be embedded in a log file. | 
| Methods inherited from class org.hibernate.type.AbstractType | 
|---|
| beforeAssemble, getSemiResolvedType, isAnyType, isAssociationType, isCollectionType, isEntityType, 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, getSemiResolvedType, isAnyType, isAssociationType, isCollectionType, isEntityType | 
| Field Detail | 
|---|
protected final int propertySpan
protected final EntityModeToTuplizerMapping tuplizerMapping
| Constructor Detail | 
|---|
public ComponentType(TypeFactory.TypeScope typeScope,
                     ComponentMetamodel metamodel)
| Method Detail | 
|---|
public boolean isKey()
public EntityModeToTuplizerMapping getTuplizerMapping()
public int[] sqlTypes(Mapping mapping)
               throws MappingException
TypeTypes) for the columns mapped by this type.
sqlTypes in interface Typemapping - The mapping object :/
MappingException - Generally indicates an issue accessing the passed mapping object.
public int getColumnSpan(Mapping mapping)
                  throws MappingException
TypesqlTypes(mapping).length
getColumnSpan in interface Typemapping - The mapping object :/
MappingException - Generally indicates an issue accessing the passed mapping object.public final boolean isComponentType()
TypeCompositeType. Essentially a polymorphic
 version of (type instanceof CompositeType.class).  A component type may own collections or
 associations and hence must provide certain extra functionality.
isComponentType in interface TypeisComponentType in class AbstractTypeCompositeType implementor; false otherwise.public Class getReturnedClass()
TypeType.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.SessionImplementor, java.lang.Object) methods. This is used to  establish the class of an array of
 this type.
getReturnedClass in interface Type
public boolean isSame(Object x,
                      Object y,
                      EntityMode entityMode)
               throws HibernateException
Type#equals check on the values.  For associations the implication
 is a bit different.  For most types it is conceivable to simply delegate to Type.isEqual(java.lang.Object, java.lang.Object, org.hibernate.EntityMode)
isSame in interface TypeisSame in class AbstractTypex - The first valuey - The second valueentityMode - The entity mode of the values.
HibernateException - A problem occurred performing the comparison
public boolean isEqual(Object x,
                       Object y,
                       EntityMode entityMode)
                throws HibernateException
Type
isEqual in interface TypeisEqual in class AbstractTypex - The first valuey - The second valueentityMode - The entity mode of the values.
HibernateException - A problem occurred performing the comparison
public boolean isEqual(Object x,
                       Object y,
                       EntityMode entityMode,
                       SessionFactoryImplementor factory)
                throws HibernateException
Type
isEqual in interface TypeisEqual in class AbstractTypex - The first valuey - The second valueentityMode - The entity mode of the values.factory - The session factory
HibernateException - A problem occurred performing the comparison
public int compare(Object x,
                   Object y,
                   EntityMode entityMode)
TypeComparator style comparison between values
compare in interface Typecompare in class AbstractTypex - The first valuey - The second valueentityMode - The entity mode of the values.
Comparator.compare(T, T) for a discussion.public boolean isMethodOf(Method method)
CompositeType
isMethodOf in interface CompositeTypemethod - The method to check
public int getHashCode(Object x,
                       EntityMode entityMode)
Type#hashCode.
getHashCode in interface TypegetHashCode in class AbstractTypex - The value for which to retrieve a hash codeentityMode - The entity mode of the value.
public int getHashCode(Object x,
                       EntityMode entityMode,
                       SessionFactoryImplementor factory)
Type#hashCode.
getHashCode in interface TypegetHashCode in class AbstractTypex - The value for which to retrieve a hash codeentityMode - The entity mode of the value.factory - The session factory
public boolean isDirty(Object x,
                       Object y,
                       SessionImplementor session)
                throws HibernateException
Type
isDirty in interface TypeisDirty in class AbstractTypex - the old valuey - the current valuesession - The session from which the request originated.
HibernateException - A problem occurred performing the checking
public boolean isDirty(Object x,
                       Object y,
                       boolean[] checkable,
                       SessionImplementor session)
                throws HibernateException
Type
isDirty in interface Typex - the old valuey - the current valuecheckable - An array of booleans indicating which columns making up the value are actually checkablesession - The session from which the request originated.
HibernateException - A problem occurred performing the checking
public boolean isModified(Object old,
                          Object current,
                          boolean[] checkable,
                          SessionImplementor session)
                   throws HibernateException
TypeType.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.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
 Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.SessionImplementor) here/
isModified in interface TypeisModified in class AbstractTypeold - the database state, in a "hydrated" form, with identifiers unresolvedcurrent - the current state of the objectcheckable - which columns are actually updatablesession - The session from which the request originated.
HibernateException - A problem occurred performing the checking
public Object nullSafeGet(ResultSet rs,
                          String[] names,
                          SessionImplementor session,
                          Object owner)
                   throws HibernateException,
                          SQLException
Type
nullSafeGet in interface Typenames - the column namesowner - the parent entity
HibernateException
SQLExceptionalternative, 2-phase property initialization
public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int begin,
                        SessionImplementor session)
                 throws HibernateException,
                        SQLException
Type
nullSafeSet in interface Typevalue - the object to writebegin - statement parameter index
HibernateException
SQLException
public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int begin,
                        boolean[] settable,
                        SessionImplementor session)
                 throws HibernateException,
                        SQLException
Type
nullSafeSet in interface Typevalue - the object to writebegin - statement parameter indexsettable - an array indicating which columns to ignore
HibernateException
SQLException
public Object nullSafeGet(ResultSet rs,
                          String name,
                          SessionImplementor session,
                          Object owner)
                   throws HibernateException,
                          SQLException
Type
nullSafeGet in interface Typename - the column nameowner - the parent entity
HibernateException
SQLException
public Object getPropertyValue(Object component,
                               int i,
                               SessionImplementor session)
                        throws HibernateException
CompositeType
getPropertyValue in interface CompositeTypecomponent - The component instancei - The index of the property whose value is to be extractedsession - The session from which the request originates.
HibernateException - Indicates a problem access the property value.
public Object getPropertyValue(Object component,
                               int i,
                               EntityMode entityMode)
                        throws HibernateException
HibernateException
public Object[] getPropertyValues(Object component,
                                  SessionImplementor session)
                           throws HibernateException
CompositeType
getPropertyValues in interface CompositeTypecomponent - The component instancesession - The session from which the request originates
HibernateException - Indicates a problem access the property values.
public Object[] getPropertyValues(Object component,
                                  EntityMode entityMode)
                           throws HibernateException
CompositeType
getPropertyValues in interface CompositeTypecomponent - The component instanceentityMode - The entity mode
HibernateException - Indicates a problem access the property values.
public void setPropertyValues(Object component,
                              Object[] values,
                              EntityMode entityMode)
                       throws HibernateException
CompositeType
setPropertyValues in interface CompositeTypecomponent - The component instancevalues - The values to injectentityMode - The entity mode
HibernateException - Indicates an issue performing the injectionpublic Type[] getSubtypes()
CompositeType
getSubtypes in interface CompositeTypepublic String getName()
Type
getName in interface Type
public String toLoggableString(Object value,
                               SessionFactoryImplementor factory)
                        throws HibernateException
Type
toLoggableString in interface TypeHibernateExceptionpublic String[] getPropertyNames()
CompositeType
getPropertyNames in interface CompositeType
public Object deepCopy(Object component,
                       EntityMode entityMode,
                       SessionFactoryImplementor factory)
                throws HibernateException
Type
deepCopy in interface Typecomponent - generally a collection element or entity field
HibernateException
public Object replace(Object original,
                      Object target,
                      SessionImplementor session,
                      Object owner,
                      Map copyCache)
               throws HibernateException
Type
replace in interface Typeoriginal - the value from the detached entity being mergedtarget - the value in the managed entity
HibernateException
public Object replace(Object original,
                      Object target,
                      SessionImplementor session,
                      Object owner,
                      Map copyCache,
                      ForeignKeyDirection foreignKeyDirection)
               throws HibernateException
Type
replace in interface Typereplace in class AbstractTypeoriginal - the value from the detached entity being mergedtarget - the value in the managed entity
HibernateException
public Object instantiate(EntityMode entityMode)
                   throws HibernateException
HibernateException
public Object instantiate(Object parent,
                          SessionImplementor session)
                   throws HibernateException
HibernateExceptionpublic CascadeStyle getCascadeStyle(int i)
CompositeType
getCascadeStyle in interface CompositeTypei - The property index,
public boolean isMutable()
Type
isMutable in interface Type
public Serializable disassemble(Object value,
                                SessionImplementor session,
                                Object owner)
                         throws HibernateException
Type
disassemble in interface Typedisassemble in class AbstractTypevalue - the value to cachesession - the sessionowner - optional parent entity object (needed for collections)
HibernateException
public Object assemble(Serializable object,
                       SessionImplementor session,
                       Object owner)
                throws HibernateException
Type
assemble in interface Typeassemble in class AbstractTypeobject - the disassembled state from the cachesession - the sessionowner - the parent entity object
HibernateExceptionpublic FetchMode getFetchMode(int i)
CompositeType
getFetchMode in interface CompositeTypei - The property index,
public Object hydrate(ResultSet rs,
                      String[] names,
                      SessionImplementor session,
                      Object owner)
               throws HibernateException,
                      SQLException
Type
hydrate in interface Typehydrate in class AbstractTypenames - the column namessession - the sessionowner - the parent entity
HibernateException
SQLExceptionType.resolve(Object, SessionImplementor, Object)
public Object resolve(Object value,
                      SessionImplementor session,
                      Object owner)
               throws HibernateException
Type
resolve in interface Typeresolve in class AbstractTypevalue - an identifier or value returned by hydrate()session - the sessionowner - the parent entity
HibernateExceptionType.hydrate(ResultSet, String[], SessionImplementor, Object)
public Object semiResolve(Object value,
                          SessionImplementor session,
                          Object owner)
                   throws HibernateException
Type
semiResolve in interface TypesemiResolve in class AbstractTypeHibernateExceptionpublic boolean[] getPropertyNullability()
CompositeType
getPropertyNullability in interface CompositeTypepublic boolean isXMLElement()
isXMLElement in interface TypeisXMLElement in class AbstractType
public Object fromXMLNode(org.dom4j.Node xml,
                          Mapping factory)
                   throws HibernateException
Type
fromXMLNode in interface TypeHibernateException
public void setToXMLNode(org.dom4j.Node node,
                         Object value,
                         SessionFactoryImplementor factory)
                  throws HibernateException
Type
setToXMLNode in interface TypeHibernateException
public boolean[] toColumnNullness(Object value,
                                  Mapping mapping)
Type
toColumnNullness in interface Typevalue - an instance of the typepublic boolean isEmbedded()
CompositeType
isEmbedded in interface CompositeTypepublic int getPropertyIndex(String name)
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||