|
||||||||||
| 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.CompositeCustomType
public class CompositeCustomType
Adapts CompositeUserType to the Type interface
| Field Summary |
|---|
| Fields inherited from class org.hibernate.type.AbstractType |
|---|
LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE |
| Constructor Summary | |
|---|---|
CompositeCustomType(CompositeUserType userType)
|
|
CompositeCustomType(CompositeUserType userType,
String[] registrationKeys)
|
|
| Method Summary | |
|---|---|
Object |
assemble(Serializable cached,
SessionImplementor session,
Object owner)
Reconstruct the object from its disassembled state. |
Object |
deepCopy(Object value,
SessionFactoryImplementor factory)
Return a deep copy of the persistent state, stopping at entities and at collections. |
Size[] |
defaultSizes(Mapping mapping)
Defines the column sizes to use according to this type if the user did not explicitly say (and if no Type.dictatedSizes(org.hibernate.engine.spi.Mapping) were given). |
Size[] |
dictatedSizes(Mapping mapping)
Return the column sizes dictated by this type. |
Serializable |
disassemble(Object value,
SessionImplementor session,
Object owner)
Return a 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)
Get a hash code, consistent with persistence "equality". |
String |
getName()
Returns the abbreviated name of the type. |
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)
|
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 |
String[] |
getRegistrationKeys()
Get the names under which this type should be registered in the type registry. |
Class |
getReturnedClass()
The class returned by Type.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SessionImplementor, java.lang.Object) methods. |
Type[] |
getSubtypes()
Get the types of the component properties |
CompositeUserType |
getUserType()
|
boolean |
isComponentType()
Return true if the implementation is castable to CompositeType. |
boolean |
isDirty(Object old,
Object current,
boolean[] checkable,
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)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state). |
boolean |
isMethodOf(Method method)
Is the given method a member of this component's class? |
boolean |
isMutable()
Are objects of this type mutable. |
Object |
nullSafeGet(ResultSet rs,
String[] names,
SessionImplementor session,
Object owner)
Extract a value of the mapped class from the JDBC result set. |
Object |
nullSafeGet(ResultSet rs,
String columnName,
SessionImplementor session,
Object owner)
Extract a value of the mapped class from the JDBC result set. |
void |
nullSafeSet(PreparedStatement st,
Object value,
int index,
boolean[] settable,
SessionImplementor session)
Bind a value represented by an instance of the mapped class to the JDBC prepared
statement, ignoring some columns as dictated by the 'settable' parameter. |
void |
nullSafeSet(PreparedStatement st,
Object value,
int index,
SessionImplementor session)
Bind a value represented by an instance of the mapped class to the JDBC 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. |
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)
Generate a representation of the value for logging purposes. |
| Methods inherited from class org.hibernate.type.AbstractType |
|---|
beforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isDirty, isEntityType, isEqual, isModified, isSame, isXMLElement, replace, replaceNode, resolve, semiResolve |
| 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, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isDirty, isEntityType, isEqual, isModified, isSame, isXMLElement, replace, resolve, semiResolve |
| Constructor Detail |
|---|
public CompositeCustomType(CompositeUserType userType)
public CompositeCustomType(CompositeUserType userType,
String[] registrationKeys)
| Method Detail |
|---|
public String[] getRegistrationKeys()
BasicType
getRegistrationKeys in interface BasicTypepublic CompositeUserType getUserType()
public boolean isMethodOf(Method method)
CompositeType
isMethodOf in interface CompositeTypemethod - The method to check
public Type[] getSubtypes()
CompositeType
getSubtypes in interface CompositeTypepublic String[] getPropertyNames()
CompositeType
getPropertyNames in interface CompositeType
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 injection
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)
throws HibernateException
HibernateExceptionpublic CascadeStyle getCascadeStyle(int i)
CompositeType
getCascadeStyle in interface CompositeTypei - The property index,
public FetchMode getFetchMode(int i)
CompositeType
getFetchMode in interface CompositeTypei - The property index,
public 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 Object deepCopy(Object value,
SessionFactoryImplementor factory)
throws HibernateException
Type
deepCopy in interface Typevalue - The value to be copiedfactory - The session factory
HibernateException - An error from Hibernate
public Object assemble(Serializable cached,
SessionImplementor session,
Object owner)
throws HibernateException
TypeType.disassemble(java.lang.Object, org.hibernate.engine.spi.SessionImplementor, java.lang.Object)
assemble in interface Typeassemble in class AbstractTypecached - the disassembled state from the cachesession - the originating sessionowner - the parent entity object
HibernateException - An error from Hibernate
public Serializable disassemble(Object value,
SessionImplementor session,
Object owner)
throws HibernateException
Type
disassemble in interface Typedisassemble in class AbstractTypevalue - the value to cachesession - the originating sessionowner - optional parent entity object (needed for collections)
HibernateException - An error from Hibernate
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 entitysession - The originating sessionowner - The owner of the valuecopyCache - The cache of already copied/replaced values
HibernateException - An error from Hibernate
public boolean isEqual(Object x,
Object y)
throws HibernateException
Type
isEqual in interface TypeisEqual in class AbstractTypex - The first valuey - The second value
HibernateException - A problem occurred performing the comparisonpublic int getHashCode(Object x)
TypehashCode.
getHashCode in interface TypegetHashCode in class AbstractTypex - The value for which to retrieve a hash code
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 String getName()
Type
getName in interface Typepublic Class getReturnedClass()
TypeType.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SessionImplementor, java.lang.Object) methods. This is used to establish the class of an array of
this type.
getReturnedClass in interface Typepublic boolean isMutable()
Type
isMutable in interface Type
public Object nullSafeGet(ResultSet rs,
String columnName,
SessionImplementor session,
Object owner)
throws HibernateException,
SQLException
Typemapped class from the JDBC result set. Implementors
should handle possibility of null values. This form might be called if the type is known to be a
single-column type.
nullSafeGet in interface Typers - The result set from which to extract value.columnName - the column name making up this type value (use to read from result set)session - The originating sessionowner - the parent entity
HibernateException - An error from Hibernate
SQLException - An error from the JDBC driver
public Object nullSafeGet(ResultSet rs,
String[] names,
SessionImplementor session,
Object owner)
throws HibernateException,
SQLException
Typemapped class from the JDBC result set. Implementors
should handle possibility of null values.
nullSafeGet in interface Typers - The result set from which to extract value.names - the column names making up this type value (use to read from result set)session - The originating sessionowner - the parent entity
HibernateException - An error from Hibernate
SQLException - An error from the JDBC driveralternative, 2-phase property initialization
public void nullSafeSet(PreparedStatement st,
Object value,
int index,
SessionImplementor session)
throws HibernateException,
SQLException
Typemapped class to the JDBC prepared
statement. Implementors should handle possibility of null values. A multi-column type should bind parameters
starting from index.
nullSafeSet in interface Typest - The JDBC prepared statement to which to bindvalue - the object to writeindex - starting parameter bind indexsession - The originating session
HibernateException - An error from Hibernate
SQLException - An error from the JDBC driver
public void nullSafeSet(PreparedStatement st,
Object value,
int index,
boolean[] settable,
SessionImplementor session)
throws HibernateException,
SQLException
Typemapped class to the JDBC prepared
statement, ignoring some columns as dictated by the 'settable' parameter. Implementors should handle the
possibility of null values. A multi-column type should bind parameters starting from index.
nullSafeSet in interface Typest - The JDBC prepared statement to which to bindvalue - the object to writeindex - starting parameter bind indexsettable - an array indicating which columns to bind/ignoresession - The originating session
HibernateException - An error from Hibernate
SQLException - An error from the JDBC driver
public int[] sqlTypes(Mapping mapping)
throws MappingException
TypeTypes) for the columns mapped by this type.
NOTE: The number of elements in this array matches the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping).
sqlTypes in interface Typemapping - The mapping object :/
MappingException - Generally indicates an issue accessing the passed mapping object.
public Size[] dictatedSizes(Mapping mapping)
throws MappingException
Typechar/Character would
have a dictated length limit of 1; for a string-based UUID would have a size limit of 36; etc.
NOTE: The number of elements in this array matches the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping).
dictatedSizes in interface Typemapping - The mapping object :/
MappingException - Generally indicates an issue accessing the passed mapping object.
public Size[] defaultSizes(Mapping mapping)
throws MappingException
TypeType.dictatedSizes(org.hibernate.engine.spi.Mapping) were given).
NOTE: The number of elements in this array matches the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping).
defaultSizes in interface Typemapping - The mapping object :/
MappingException - Generally indicates an issue accessing the passed mapping object.
public String toLoggableString(Object value,
SessionFactoryImplementor factory)
throws HibernateException
Type
toLoggableString in interface Typevalue - The value to be loggedfactory - The session factory
HibernateException - An error from Hibernatepublic boolean[] getPropertyNullability()
CompositeType
getPropertyNullability in interface CompositeType
public Object fromXMLNode(org.dom4j.Node xml,
Mapping factory)
throws HibernateException
Type
fromXMLNode in interface Typexml - The XML node from which to read the valuefactory - The session factory
mapped class
HibernateException - An error from Hibernate
public void setToXMLNode(org.dom4j.Node node,
Object value,
SessionFactoryImplementor factory)
throws HibernateException
Type
setToXMLNode in interface Typenode - The XML node to which to write the valuevalue - The value to writefactory - The session factory
HibernateException - An error from Hibernate
public boolean[] toColumnNullness(Object value,
Mapping mapping)
Type
toColumnNullness in interface Typevalue - an instance of the typemapping - The mapping abstraction
public boolean isDirty(Object old,
Object current,
boolean[] checkable,
SessionImplementor session)
throws HibernateException
Type
isDirty in interface Typeold - the old valuecurrent - 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 checkingpublic boolean isEmbedded()
CompositeType
isEmbedded in interface CompositeType
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||