Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.hibernate.type.AbstractType
org.hibernate.type.ComponentType
Field Summary | |
protected int | |
protected EntityModeToTuplizerMapping |
Constructor Summary | |
|
Method Summary | |
Object |
|
int |
|
Object |
|
Serializable |
|
Object |
|
CascadeStyle |
|
int |
|
FetchMode |
|
int |
|
int |
|
String |
|
String[] | |
boolean[] | |
Object |
|
Object |
|
Object[] |
|
Object[] |
|
Class |
|
Type[] | |
Object |
|
Object |
|
Object |
|
boolean |
|
boolean |
|
boolean |
|
boolean | |
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean | |
Object |
|
Object |
|
void |
|
void |
|
Object |
|
Object |
|
Object |
|
Object |
|
void |
|
void |
|
int[] | |
boolean[] |
|
String |
|
Methods inherited from class org.hibernate.type.AbstractType | |
assemble , beforeAssemble , compare , disassemble , getHashCode , getHashCode , getSemiResolvedType , hydrate , isAnyType , isAssociationType , isCollectionType , isComponentType , isDirty , isEntityType , isEqual , isEqual , isModified , isSame , isXMLElement , replace , replaceNode , resolve , semiResolve |
public Object assemble(Serializable object, SessionImplementor session, Object owner) throws HibernateException
Reconstruct the object from its cached "disassembled" state.
- Overrides:
- assemble in interface AbstractType
- Parameters:
session
- the sessionowner
- the parent entity object
- Returns:
- the the object
public int compare(Object x, Object y, EntityMode entityMode)
compare two instances of the type
- Overrides:
- compare in interface AbstractType
- Parameters:
entityMode
-
public Object deepCopy(Object component, EntityMode entityMode, SessionFactoryImplementor factory) throws HibernateException
Return a deep copy of the persistent state, stopping at entities and at collections.
- Parameters:
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 cachesession
- the sessionowner
- 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 CascadeStyle getCascadeStyle(int i)
- Specified by:
- getCascadeStyle in interface AbstractComponentType
public int getColumnSpan(Mapping mapping) 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 int getHashCode(Object x, EntityMode entityMode)
Get a hashcode, consistent with persistence "equality"
- Specified by:
- getHashCode in interface Type
- Overrides:
- getHashCode in interface AbstractType
- Parameters:
x
-entityMode
-
public int getHashCode(Object x, EntityMode entityMode, SessionFactoryImplementor factory)
Get a hashcode, consistent with persistence "equality"
- Specified by:
- getHashCode in interface Type
- Overrides:
- getHashCode in interface AbstractType
- Parameters:
x
-entityMode
-factory
-
public String getName()
Returns the abbreviated name of the type.
- Returns:
- String the Hibernate type name
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, EntityMode entityMode) throws HibernateException
public Object getPropertyValue(Object component, int i, SessionImplementor session) throws HibernateException
- Specified by:
- getPropertyValue in interface AbstractComponentType
public Object[] getPropertyValues(Object component, EntityMode entityMode) throws HibernateException
- Specified by:
- getPropertyValues in interface AbstractComponentType
public Object[] getPropertyValues(Object component, SessionImplementor session) throws HibernateException
- Specified by:
- getPropertyValues in interface AbstractComponentType
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 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().
- Overrides:
- hydrate in interface AbstractType
- Parameters:
rs
-names
- the column namessession
- the sessionowner
- the parent entity
- Returns:
- Object an identifier or actual value
- Throws:
HibernateException
-
public Object instantiate(Object parent, SessionImplementor session) throws HibernateException
public Object instantiate(EntityMode entityMode) throws HibernateException
This method does not populate the component parent
public final 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 x, Object y, boolean[] checkable, SessionImplementor session) throws HibernateException
Should the parent be considered dirty, given both the old and current field or element value?
- Parameters:
checkable
- which columns are actually updatablesession
-
- Returns:
- true if the field is dirty
public boolean isDirty(Object x, Object y, SessionImplementor session) throws HibernateException
Should the parent be considered dirty, given both the old and current field or element value?
- Overrides:
- isDirty in interface AbstractType
- Parameters:
session
-
- Returns:
- true if the field is dirty
public boolean isEqual(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.
- Overrides:
- isEqual in interface AbstractType
- Parameters:
x
-y
-entityMode
-
- Returns:
- boolean
- Throws:
HibernateException
-
public boolean isEqual(Object x, Object y, EntityMode entityMode, SessionFactoryImplementor factory) throws HibernateException
Compare two instances of the class mapped by this type for persistence "equality" - equality of persistent state.
- Overrides:
- isEqual in interface AbstractType
- Parameters:
x
-y
-entityMode
-
- Returns:
- boolean
- Throws:
HibernateException
-
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 updatablesession
-
- 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.)
- 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.
- Overrides:
- isSame in interface AbstractType
- Parameters:
x
-y
-entityMode
-
- Returns:
- boolean
- Throws:
HibernateException
-
public boolean isXMLElement()
- Specified by:
- isXMLElement in interface Type
- Overrides:
- isXMLElement in interface AbstractType
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 namesession
-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 namessession
-owner
- the parent entity
- Returns:
- Object
- Throws:
HibernateException
-
public void nullSafeSet(PreparedStatement st, Object value, int begin, 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 writesettable
- an array indicating which columns to ignoresession
-
- Throws:
HibernateException
-
public void nullSafeSet(PreparedStatement st, Object value, int begin, 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 writesession
-
- 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.
- Parameters:
original
- the value from the detached entity being mergedtarget
- the value in the managed entity
- Returns:
- the value to be merged
public Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache, ForeignKeyDirection foreignKeyDirection) 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.
- Overrides:
- replace in interface AbstractType
- Parameters:
original
- the value from the detached entity being mergedtarget
- 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.
- Overrides:
- resolve in interface AbstractType
- Parameters:
value
- an identifier or value returned by hydrate()session
- the sessionowner
- the parent entity
- Returns:
- the given value, or the value associated with the identifier
- Throws:
HibernateException
-
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 node, Object value, SessionFactoryImplementor factory) throws HibernateException
A representation of the value to be embedded in an XML element.
- Specified by:
- setToXMLNode in interface Type
- Parameters:
value
-factory
-
- Throws:
HibernateException
-
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.
- 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
-