Hibernate Core 3.6.10.Final · org.hibernate.tuple.Tuplizer

A tuplizer defines the contract for things which know how to manage a particular representation of a piece of data, given that representation's org.hibernate.EntityMode (the entity-mode essentially defining which representation).

If that given piece of data is thought of as a data structure, then a tuplizer is the thing which knows how to

create such a data structure appropriately
extract values from and inject values into such a data structure

For example, a given piece of data might be represented as a POJO class. Here, it's representation and entity-mode is POJO. Well a tuplizer for POJO entity-modes would know how to

create the data structure by calling the POJO's constructor
extract and inject values through getters/setter, or by direct field access, etc

That same piece of data might also be represented as a DOM structure, using the tuplizer associated with the DOM4J entity-mode, which would generate instances of org.dom4j.Element as the data structure and know how to access the values as either nested org.dom4j.Elements or as org.dom4j.Attributes.

Method Summary

Modifier and Type	Method and Description
public Getter	Returns: The property getter. getGetter(int The property index. i) Retrieve the getter for the specified property.
public Class<T>	Returns: The persistent class. getMappedClass() Return the pojo class managed by this tuplizer.
public Object	Returns: The current value of the given property on the given entity. getPropertyValue(Object The entity from which to extract the property value. entity, int The index of the property for which to extract the value. i) Extract the value of a particular property from the given entity.
public Object[]	Returns: The current property values. getPropertyValues(Object The entity from which to extract values. entity) Extract the current values contained on the given entity.
public Object	Returns: The new, empty entity instance. instantiate() Generate a new, empty entity.
public boolean	Returns: True if the object is considered as an instance of this entity within the given mode. isInstance(Object The object to be checked. object) Is the given object considered an instance of the the entity (acconting for entity-mode) managed by this tuplizer.
public void	setPropertyValues(Object The entity. entity, Object[] The values to be injected. values) Inject the given values into the given entity.

Method Detail

getGetter	back to summary
public Getter getGetter(int i) Retrieve the getter for the specified property. Parameters i:int The property index. Returns:Getter The property getter.

getGetter

back to summary

public Getter getGetter(int i)

Retrieve the getter for the specified property.

Parameters

i:int: The property index.

Returns:Getter

The property getter.

getMappedClass	back to summary
public Class<T> getMappedClass() Return the pojo class managed by this tuplizer. Need to determine how to best handle this for the Tuplizers for EntityModes other than POJO. todo : be really nice to not have this here since it is essentially pojo specific... Returns:Class<T> The persistent class.

getMappedClass

back to summary

public Class<T> getMappedClass()

Return the pojo class managed by this tuplizer.

Need to determine how to best handle this for the Tuplizers for EntityModes other than POJO.

todo : be really nice to not have this here since it is essentially pojo specific...

Returns:Class<T>: The persistent class.

getPropertyValue	back to summary
public Object getPropertyValue(Object entity, int i) Extract the value of a particular property from the given entity. Parameters entity:Object The entity from which to extract the property value. i:int The index of the property for which to extract the value. Returns:Object The current value of the given property on the given entity.

getPropertyValue

back to summary

public Object getPropertyValue(Object entity, int i)

Extract the value of a particular property from the given entity.

Parameters

entity:Object: The entity from which to extract the property value.
i:int: The index of the property for which to extract the value.

Returns:Object

The current value of the given property on the given entity.

getPropertyValues	back to summary
public Object[] getPropertyValues(Object entity) Extract the current values contained on the given entity. Parameters entity:Object The entity from which to extract values. Returns:Object[] The current property values.

getPropertyValues

back to summary

public Object[] getPropertyValues(Object entity)

Extract the current values contained on the given entity.

Parameters

entity:Object: The entity from which to extract values.

Returns:Object[]

The current property values.

instantiate	back to summary
public Object instantiate() Generate a new, empty entity. Returns:Object The new, empty entity instance.

instantiate

back to summary

public Object instantiate()

Generate a new, empty entity.

Returns:Object: The new, empty entity instance.

isInstance	back to summary
public boolean isInstance(Object object) Is the given object considered an instance of the the entity (acconting for entity-mode) managed by this tuplizer. Parameters object:Object The object to be checked. Returns:boolean True if the object is considered as an instance of this entity within the given mode.

isInstance

back to summary

public boolean isInstance(Object object)

Is the given object considered an instance of the the entity (acconting for entity-mode) managed by this tuplizer.

Parameters

object:Object: The object to be checked.

Returns:boolean

True if the object is considered as an instance of this entity within the given mode.

setPropertyValues	back to summary
public void setPropertyValues(Object entity, Object[] values) Inject the given values into the given entity. Parameters entity:Object The entity. values:Object[] The values to be injected.

setPropertyValues

back to summary

public void setPropertyValues(Object entity, Object[] values)

Inject the given values into the given entity.

Parameters

entity:Object: The entity.
values:Object[]: The values to be injected.

public Interface Tuplizer

Method Summary

Method Detail