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

Class AbstractSelfSQLValue<T extends DataObject,R>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.AbstractSelfSQLValue<T,R>

Type Parameters:

T - type of reference/repository

R - type of filter

All Implemented Interfaces:

Accessor<IndexedReference,R>, FilterProvider<R,IndexedReference>, GroupingSQLValue<IndexedReference>, IndexedSQLValue<R,T>, SQLAccessor<IndexedReference,R>, SQLValue<IndexedReference>, Targetted<IndexedReference>

Direct Known Subclasses:

SelfSQLValue, TupleSelfSQLValue

public abstract class AbstractSelfSQLValue<T extends DataObject,R>
extends java.lang.Object
implements SQLAccessor<IndexedReference,R>, FilterProvider<R,IndexedReference>, IndexedSQLValue<R,T>, GroupingSQLValue<IndexedReference>

Field value for a self reference It targets the primary key of the factory. The filter type may be different but the repository is assumed to be added to the query source.

See Also:

SelfSQLValue, TupleSelfSQLValue

Constructor Summary

Constructors

Constructor and Description
AbstractSelfSQLValue(DataObjectFactory<T> fac)

Method Summary

Modifier and Type	Method and Description
int	add(java.lang.StringBuilder sb, boolean qualify) Add the expression to a StringBuilder
boolean	canSet() does this Accessor support setting values.
DataObjectFactory<T>	getFactory() get the remote DataObjectFactory
SQLFilter<R>	getFilter(MatchCondition match, IndexedReference val) Create a SQLFilter comparing against the target value
SQLExpression<java.lang.Integer>	getIDExpression() Get a Integer valued SQLExpression for the id of the referenced value.
SQLFilter<R>	getNullFilter(boolean is_null) create a SQLFilter checking if the target value is or is not null.
SQLFilter<R>	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.
java.lang.Class<IndexedReference>	getTarget() Get the type of the returned object as far as it is known.
boolean	groupingIsomorphic() Is there always a one-to-one mapping between groups and values
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.
IndexedReference<T>	makeReference(int id)
void	setValue(R r, IndexedReference value) Set value if supported otherwise throw a UnsupportedOperationException.
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.Accessor

getValue

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

addGroup, checkContentsCanGroup, getGroupParameters

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

getSQLFilter

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

getFilterType

Constructor Detail

AbstractSelfSQLValue

public AbstractSelfSQLValue(DataObjectFactory<T> fac)

Method Detail

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<R,T extends DataObject>

Returns:

SQLExpression

add

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

makeReference

public final IndexedReference<T> makeReference(int id)

getTarget

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRequiredFilter

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

canSet

public final boolean canSet()

Description copied from interface: Accessor

does this Accessor support setting values.

Specified by:

canSet in interface Accessor<IndexedReference,R>

Returns:

setValue

public final void setValue(R r,
                           IndexedReference value)

Description copied from interface: Accessor

Set value if supported otherwise throw a UnsupportedOperationException.

Specified by:

setValue in interface Accessor<IndexedReference,R>

getFilter

public final SQLFilter<R> getFilter(MatchCondition match,
                                    IndexedReference val)
                             throws CannotFilterException

Description copied from interface: FilterProvider

Create a SQLFilter comparing against the target value

Specified by:

getFilter in interface FilterProvider<R,IndexedReference>

Returns:

SQLFilter

Throws:

CannotFilterException

getNullFilter

public final SQLFilter<R> getNullFilter(boolean is_null)
                                 throws CannotFilterException

Description copied from interface: FilterProvider

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

Specified by:

getNullFilter in interface FilterProvider<R,IndexedReference>

Returns:

SQLFilter

Throws:

CannotFilterException

getOrderFilter

public final SQLFilter<R> getOrderFilter(boolean descending)
                                  throws CannotFilterException

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<R,IndexedReference>

Returns:

SQLFilter

Throws:

CannotFilterException

getFactory

public final DataObjectFactory<T> getFactory()

Description copied from interface: IndexedSQLValue

get the remote DataObjectFactory

Specified by:

getFactory in interface IndexedSQLValue<R,T extends DataObject>

Returns:

DataObjectFactory

groupingIsomorphic

public final boolean groupingIsomorphic()

Description copied from interface: GroupingSQLValue

Is there always a one-to-one mapping between groups and values

Specified by:

groupingIsomorphic in interface GroupingSQLValue<IndexedReference>

Returns: