uk.ac.ed.epcc.webapp.jdbc.expr

Class CompositeIndexedSQLValue<H extends DataObject,I extends DataObject,T extends DataObject>

java.lang.Object

uk.ac.ed.epcc.webapp.jdbc.expr.CompositeIndexedSQLValue<H,I,T>

Type Parameters:

H - Type of home table

I - Type of intermediate table

T - Type of target table

All Implemented Interfaces:

FilterProvider<H,IndexedReference>, GroupingSQLValue<IndexedReference>, IndexedSQLValue<H,T>, SQLValue<IndexedReference>, Targetted<IndexedReference>

public class CompositeIndexedSQLValue<H extends DataObject,I extends DataObject,T extends DataObject>
extends java.lang.Object
implements IndexedSQLValue<H,T>, GroupingSQLValue<IndexedReference>

A IndexedSQLValue that extends through a join

Constructor Summary

Constructors

Constructor and Description
CompositeIndexedSQLValue(IndexedSQLValue<H,I> base, IndexedSQLValue<I,T> branch)

Method Summary

Modifier and Type	Method and Description
int	add(java.lang.StringBuilder sb, boolean qualify) Add the expression to a StringBuilder
DataObjectFactory<T>	getFactory() get the remote DataObjectFactory
SQLFilter<H>	getFilter(MatchCondition match, IndexedReference val) Create a SQLFilter comparing against the target value
java.lang.Class<H>	getFilterType() get the type bounds on the produced SQLFilter.
SQLExpression<java.lang.Integer>	getIDExpression() Get a Integer valued SQLExpression for the id of the referenced value.
SQLFilter<H>	getNullFilter(boolean is_null) create a SQLFilter checking if the target value is or is not null.
SQLFilter<H>	getOrderFilter(boolean descending) create a SQLFilter that orders results by the target value.
java.util.List<PatternArgument>	getParameters(java.util.List<PatternArgument> list) Add parameters for this value to a list.
SQLFilter	getRequiredFilter() Get an SQLFilter required to be added to the filter set.
SQLFilter<H>	getSQLFilter(SQLFilter<T> fil) Create a filter for the home table out of a a filter on the target object.
java.lang.Class<IndexedReference>	getTarget() Get the type of the returned object as far as it is known.
IndexedReference<T>	makeObject(java.sql.ResultSet rs, int pos) Extract a result of the expression from a ResultSet into an object of the specified type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.jdbc.expr.GroupingSQLValue

addGroup, checkContentsCanGroup, getGroupParameters, groupingIsomorphic

Constructor Detail

CompositeIndexedSQLValue

public CompositeIndexedSQLValue(IndexedSQLValue<H,I> base,
                                IndexedSQLValue<I,T> branch)
                         throws CannotFilterException

Throws:

CannotFilterException

Method Detail

add

public int add(java.lang.StringBuilder sb,
               boolean qualify)

Description copied from interface: SQLValue

Add the expression to a StringBuilder

Specified by:

add in interface SQLValue<IndexedReference>

Parameters:

sb - StringBuilder to modify

qualify - boolean should fields be qualified with the table name

Returns:

number of fields added

getParameters

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

Description copied from interface: SQLValue

Add parameters for this value to a list.

Specified by:

getParameters in interface SQLValue<IndexedReference>

Parameters:

list - to modify

Returns:

modified list of parameter objects

makeObject

public IndexedReference<T> makeObject(java.sql.ResultSet rs,
                                      int pos)
                               throws DataException,
                                      java.sql.SQLException

Description copied from interface: SQLValue

Extract a result of the expression from a ResultSet into an object of the specified type. Note that this method is also used to extract the result of functions over the result type.

Specified by:

makeObject in interface SQLValue<IndexedReference>

Parameters:

rs - ResultSet

Returns:

produced object

Throws:

DataException

java.sql.SQLException

getRequiredFilter

public SQLFilter getRequiredFilter()

Description copied from interface: SQLValue

Get an SQLFilter required to be added to the filter set. This is usually to implement a join.

Specified by:

getRequiredFilter in interface SQLValue<IndexedReference>

Returns:

null or SQLFilter

getTarget

public java.lang.Class<IndexedReference> getTarget()

Description copied from interface: Targetted

Get the type of the returned object as far as it is known. Normally this should be the erasure type corresponding to T.

Specified by:

getTarget in interface Targetted<IndexedReference>

Returns:

Class object for return type

getFilter

public SQLFilter<H> getFilter(MatchCondition match,
                              IndexedReference val)
                       throws CannotFilterException,
                              NoSQLFilterException

Description copied from interface: FilterProvider

Create a SQLFilter comparing against the target value

Specified by:

getFilter in interface FilterProvider<H extends DataObject,IndexedReference>

Returns:

SQLFilter

Throws:

CannotFilterException

NoSQLFilterException

getNullFilter

public SQLFilter<H> getNullFilter(boolean is_null)
                           throws CannotFilterException,
                                  NoSQLFilterException

Description copied from interface: FilterProvider

create a SQLFilter checking if the target value is or is not null.

Specified by:

getNullFilter in interface FilterProvider<H extends DataObject,IndexedReference>

Returns:

SQLFilter

Throws:

CannotFilterException

NoSQLFilterException

getOrderFilter

public SQLFilter<H> getOrderFilter(boolean descending)
                            throws CannotFilterException,
                                   NoSQLFilterException

Description copied from interface: FilterProvider

create a SQLFilter that orders results by the target value. This may involve joins so may not be just an OrderFilter though it will contain one.

Specified by:

getOrderFilter in interface FilterProvider<H extends DataObject,IndexedReference>

Returns:

SQLFilter

Throws:

CannotFilterException

NoSQLFilterException

getFilterType

public java.lang.Class<H> getFilterType()

Description copied from interface: FilterProvider

get the type bounds on the produced SQLFilter.

Specified by:

getFilterType in interface FilterProvider<H extends DataObject,IndexedReference>

Returns:

Class

getSQLFilter

public SQLFilter<H> getSQLFilter(SQLFilter<T> fil)
                          throws CannotFilterException

Description copied from interface: IndexedSQLValue

Create a filter for the home table out of a a filter on the target object. This adds any necessary join filters. If fil is null it only returns the necessary join filter.

Specified by:

getSQLFilter in interface IndexedSQLValue<H extends DataObject,T extends DataObject>

Returns:

SQLFilter

Throws:

CannotFilterException

getFactory

public DataObjectFactory<T> getFactory()
                                throws java.lang.Exception

Description copied from interface: IndexedSQLValue

get the remote DataObjectFactory

Specified by:

getFactory in interface IndexedSQLValue<H extends DataObject,T extends DataObject>

Returns:

DataObjectFactory

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIDExpression

public SQLExpression<java.lang.Integer> getIDExpression()

Description copied from interface: IndexedSQLValue

Get a Integer valued SQLExpression for the id of the referenced value. This is used to provide match filters for two references.

Specified by:

getIDExpression in interface IndexedSQLValue<H extends DataObject,T extends DataObject>

Returns:

SQLExpression