uk.ac.ed.epcc.webapp.model.data

Class TupleFactory.TupleMapper

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.TupleFactory.TupleMapper

All Implemented Interfaces:

ResultMapper<T>

Enclosing class:

TupleFactory<A extends DataObject,AF extends DataObjectFactory<A>,T extends TupleFactory.Tuple<A>>

public class TupleFactory.TupleMapper
extends java.lang.Object
implements ResultMapper<T>

Constructor Summary

Constructors

Constructor and Description
TupleMapper()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getModify() provide an override GROUP/ORDER by clause null to use default order from filters
java.util.List<PatternArgument>	getModifyParameters(java.util.List<PatternArgument> list) Add parameters for the GROUP/ORDER clause to a list.
SQLFilter	getRequiredFilter() Get an additional Filter required to make the target string work properly.
java.lang.String	getTarget() get the target clause of the SQL query.
java.util.List<PatternArgument>	getTargetParameters(java.util.List<PatternArgument> list) Add parameters for the target clause to a list.
T	makeDefault() Create a default Object to be returned if no SQL results are generated.
T	makeObject(java.sql.ResultSet rs) Convert a ResultSet into a domain object.
boolean	setQualify(boolean qualify) Request that field names should be qualified with the table name where appropriate.

Methods inherited from class java.lang.Object

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

Constructor Detail

TupleMapper

public TupleMapper()

Method Detail

setQualify

public boolean setQualify(boolean qualify)

Description copied from interface: ResultMapper

Request that field names should be qualified with the table name where appropriate. This is for use with joined tables. For some result mappers this does not make sense so this method always returns the same value.

Specified by:

setQualify in interface ResultMapper<T extends TupleFactory.Tuple<A>>

Returns:

previous value of qualify flag

makeObject

public T makeObject(java.sql.ResultSet rs)
             throws DataException

Description copied from interface: ResultMapper

Convert a ResultSet into a domain object. The ResultSet should already be positioned at the correct starting Row to start creating the object It is legal for this method to return null to indicate the ResultSet represents an invalid record that should be ignored by the higher levels of the code.

Specified by:

makeObject in interface ResultMapper<T extends TupleFactory.Tuple<A>>

Parameters:

rs - ResultSet or null

Returns:

domain object

Throws:

DataException

makeDefault

public T makeDefault()

Description copied from interface: ResultMapper

Create a default Object to be returned if no SQL results are generated. If there is no obvious default result then return null. Where there is an obvious result (like a sum=0 or an empty Map) this is less error prone than trying to trap null at the calling level. Note that FilterFinder can optionally check for null results and generate exceptions this still fails but makes it easier to find the problem.

Specified by:

makeDefault in interface ResultMapper<T extends TupleFactory.Tuple<A>>

Returns:

domain object

getTarget

public java.lang.String getTarget()

Description copied from interface: ResultMapper

get the target clause of the SQL query. it makes sense to set it here as it has to match what the ResultMapper is expecting

Specified by:

getTarget in interface ResultMapper<T extends TupleFactory.Tuple<A>>

Returns:

String

getTargetParameters

public java.util.List<PatternArgument> getTargetParameters(java.util.List<PatternArgument> list)

Description copied from interface: ResultMapper

Add parameters for the target clause to a list.

Specified by:

getTargetParameters in interface ResultMapper<T extends TupleFactory.Tuple<A>>

Parameters:

list - to modify

Returns:

modified list of parameter objects

getModify

public java.lang.String getModify()

Description copied from interface: ResultMapper

provide an override GROUP/ORDER by clause null to use default order from filters

Specified by:

getModify in interface ResultMapper<T extends TupleFactory.Tuple<A>>

Returns:

String SQL clause

getModifyParameters

public java.util.List<PatternArgument> getModifyParameters(java.util.List<PatternArgument> list)

Description copied from interface: ResultMapper

Add parameters for the GROUP/ORDER clause to a list.

Specified by:

getModifyParameters in interface ResultMapper<T extends TupleFactory.Tuple<A>>

Parameters:

list - to modify

Returns:

modified list of parameter objects

getRequiredFilter

public SQLFilter getRequiredFilter()

Description copied from interface: ResultMapper

Get an additional Filter required to make the target string work properly. This is usually used to add an additional join.

Specified by:

getRequiredFilter in interface ResultMapper<T extends TupleFactory.Tuple<A>>

Returns:

null or SQLFilter