org.apache.ojb.broker.accesslayer
Class RowReaderDefaultImpl

java.lang.Object
  org.apache.ojb.broker.accesslayer.RowReaderDefaultImpl

All Implemented Interfaces:

Serializable, RowReader

public class RowReaderDefaultImpl
extends Object
implements RowReader

Default implementation of the RowReader interface.

Version:

$Id: RowReaderDefaultImpl.java,v 1.1 2007-08-24 22:17:30 ewestfal Exp $

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.ojb.broker.accesslayer.RowReader

serialVersionUID

Constructor Summary

RowReaderDefaultImpl(ClassDescriptor cld)

Method Summary

protected Object	buildOrRefreshObject(Map row, ClassDescriptor targetClassDescriptor, Object targetObject) Creates an object instance according to clb, and fills its fileds width data provided by row.
protected String	extractOjbConcreteClass(ClassDescriptor cld, ResultSet rs, Map row)
ClassDescriptor	getClassDescriptor() Returns the associated ClassDescriptor
void	readObjectArrayFrom(ResultSetAndStatement rs_stmt, Map row) materialize a single object, described by cld, from the first row of the ResultSet rs.
Object	readObjectFrom(Map row) materialize a single object, described by cld, from the first row of the ResultSet rs.
void	readPkValuesFrom(ResultSetAndStatement rs_stmt, Map row) Read primary key fields from the current ResultRow into the Object[] row.# ConversionStrategies are applied here!
protected void	readValuesFrom(ResultSetAndStatement rs_stmt, Map row, FieldDescriptor[] fields)
void	refreshObject(Object instance, Map row) refresh an existing instance from the values of the Map row.
protected ClassDescriptor	selectClassDescriptor(Map row) Check if there is an attribute which tells us which concrete class is to be instantiated.
void	setClassDescriptor(ClassDescriptor cld) Set the descriptor this RowReader worked with.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RowReaderDefaultImpl

public RowReaderDefaultImpl(ClassDescriptor cld)

Method Detail

readObjectFrom

public Object readObjectFrom(Map row)
                      throws PersistenceBrokerException

materialize a single object, described by cld, from the first row of the ResultSet rs. There are two possible strategies: 1. The persistent class defines a public constructor with arguments matching the persistent primitive attributes of the class. In this case we build an array args of arguments from rs and call Constructor.newInstance(args) to build an object. 2. The persistent class does not provide such a constructor, but only a public default constructor. In this case we create an empty instance with Class.newInstance(). This empty instance is then filled by calling Field::set(obj,getObject(matchingColumn)) for each attribute. The second strategy needs n calls to Field::set() which are much more expensive than the filling of the args array in the first strategy. client applications should therefore define adequate constructors to benefit from performance gain of the first strategy. MBAIRD: The rowreader is told what type of object to materialize, so we have to trust it is asked for the right type. It is possible someone marked an extent in the repository, but not in java, or vice versa and this could cause problems in what is returned. we *have* to be able to materialize an object from a row that has a objConcreteClass, as we retrieve ALL rows belonging to that table. The objects using the rowReader will make sure they know what they are asking for, so we don't have to make sure a descriptor is assignable from the selectClassDescriptor. This allows us to map both inherited classes and unrelated classes to the same table.

Specified by:

readObjectFrom in interface RowReader

Parameters:

row - the Map containing the new values

Returns:

a properly created instance.

Throws:

PersistenceBrokerException

refreshObject

public void refreshObject(Object instance,
                          Map row)

Description copied from interface: RowReader

refresh an existing instance from the values of the Map row.

Specified by:

refreshObject in interface RowReader

Parameters:

instance - the instance to refresh

row - the Map containing the new values

See Also:

RowReader.refreshObject(Object, Map)

buildOrRefreshObject

protected Object buildOrRefreshObject(Map row,
                                      ClassDescriptor targetClassDescriptor,
                                      Object targetObject)

Creates an object instance according to clb, and fills its fileds width data provided by row.

Parameters:

row - A Map contain the Object/Row mapping for the object.

targetClassDescriptor - If the "ojbConcreteClass" feature was used, the target ClassDescriptor could differ from the descriptor this class was associated - see selectClassDescriptor(java.util.Map).

targetObject - If 'null' a new object instance is build, else fields of object will be refreshed.

Throws:

PersistenceBrokerException - if there ewas an error creating the new object

readObjectArrayFrom

public void readObjectArrayFrom(ResultSetAndStatement rs_stmt,
                                Map row)

materialize a single object, described by cld, from the first row of the ResultSet rs. There are two possible strategies: 1. The persistent class defines a public constructor with arguments matching the persistent primitive attributes of the class. In this case we build an array args of arguments from rs and call Constructor.newInstance(args) to build an object. 2. The persistent class does not provide such a constructor, but only a public default constructor. In this case we create an empty instance with Class.newInstance(). This empty instance is then filled by calling Field::set(obj,getObject(matchingColumn)) for each attribute. The second strategy needs n calls to Field::set() which are much more expensive than the filling of the args array in the first strategy. client applications should therefore define adequate constructors to benefit from performance gain of the first strategy.

Specified by:

readObjectArrayFrom in interface RowReader

Throws:

PersistenceBrokerException - if there is an error accessing the access layer

readPkValuesFrom

public void readPkValuesFrom(ResultSetAndStatement rs_stmt,
                             Map row)

Description copied from interface: RowReader

Read primary key fields from the current ResultRow into the Object[] row.# ConversionStrategies are applied here!

Specified by:

readPkValuesFrom in interface RowReader

readValuesFrom

protected void readValuesFrom(ResultSetAndStatement rs_stmt,
                              Map row,
                              FieldDescriptor[] fields)

extractOjbConcreteClass

protected String extractOjbConcreteClass(ClassDescriptor cld,
                                         ResultSet rs,
                                         Map row)

selectClassDescriptor

protected ClassDescriptor selectClassDescriptor(Map row)
                                         throws PersistenceBrokerException

Check if there is an attribute which tells us which concrete class is to be instantiated.

Throws:

PersistenceBrokerException

setClassDescriptor

public void setClassDescriptor(ClassDescriptor cld)

Description copied from interface: RowReader

Set the descriptor this RowReader worked with.

Specified by:

setClassDescriptor in interface RowReader

getClassDescriptor

public ClassDescriptor getClassDescriptor()

Description copied from interface: RowReader

Returns the associated ClassDescriptor

Specified by:

getClassDescriptor in interface RowReader