Tuplizer

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> hibernate >> [ tuple overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.hibernate.tuple.Tuplizer

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.hibernate.tuple
Interface Tuplizer

All Known Subinterfaces:: ComponentTuplizer, EntityTuplizer

All Known Implementing Classes:: AbstractComponentTuplizer, AbstractEntityTuplizer, AbstractTuplizer

public interface 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

java.lang.Class getMappedClass()
          Return the pojo class managed by this tuplizer.

java.lang.Object getPropertyValue(java.lang.Object entity, int i)
          Extract the value of a particular property from the given entity.

java.lang.Object[] getPropertyValues(java.lang.Object entity)
          Extract the current values contained on the given entity.

java.lang.Object instantiate()
          Generate a new, empty entity.

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

void setPropertyValues(java.lang.Object entity, java.lang.Object[] values)
          Inject the given values into the given entity.

Method Detail

getPropertyValues

public java.lang.Object[] getPropertyValues(java.lang.Object entity)
                                     throws org.hibernate.HibernateException

Extract the current values contained on the given entity.

setPropertyValues

public void setPropertyValues(java.lang.Object entity,
                              java.lang.Object[] values)
                       throws org.hibernate.HibernateException

Inject the given values into the given entity.

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.Object entity,
                                         int i)
                                  throws org.hibernate.HibernateException

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

instantiate

public java.lang.Object instantiate()
                             throws org.hibernate.HibernateException

Generate a new, empty entity.

isInstance

public boolean isInstance(java.lang.Object object)

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

getMappedClass

public java.lang.Class 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...