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

Class IndexedFieldValue<T extends DataObject,I extends DataObject>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.IndexedFieldValue<T,I>

Type Parameters:

T - type of owning object

I - type of remote object

All Implemented Interfaces:

Accessor<IndexedReference,T>, FilterProvider<T,IndexedReference>, GroupingSQLValue<IndexedReference>, IndexedSQLValue<T,I>, SQLAccessor<IndexedReference,T>, SQLValue<IndexedReference>, FieldValue<IndexedReference,T>, Selector, Targetted<IndexedReference>

public class IndexedFieldValue<T extends DataObject,I extends DataObject>
extends java.lang.Object
implements FieldValue<IndexedReference,T>, IndexedSQLValue<T,I>, Selector, GroupingSQLValue<IndexedReference>

A SQLAccessor for a field referencing a remote table. This accessor returns an IndexedReference for the remote object.

Constructor Summary

Constructors

Constructor and Description
IndexedFieldValue(java.lang.Class<T> target, Repository repository, IndexedTypeProducer<I,? extends DataObjectFactory<I>> producer)

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<I>	getFactory() get the remote DataObjectFactory
java.lang.String	getFieldName() Get the corresponding field name.
SQLFilter<T>	getFilter(MatchCondition match, IndexedReference val) Create a SQLFilter comparing against the target value
java.lang.Class<T>	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.
I	getIndexed(T r)
Input	getInput() get the Input associated with this object.
SQLFilter<T>	getNullFilter(boolean is_null) create a SQLFilter checking if the target value is or is not null.
SQLFilter<T>	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.
IndexedTypeProducer<I,? extends DataObjectFactory<I>>	getProducer()
SQLFilter	getRequiredFilter() Get an SQLFilter required to be added to the filter set.
SQLFilter<T>	getSQLFilter(SQLFilter<I> 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<I>	getValue(T r) get the value from the target object
IndexedReference<I>	makeObject(java.sql.ResultSet rs, int pos) Extract a result of the expression from a ResultSet into an object of the specified type.
IndexedReference<I>	makeReference(int id)
void	setObject(java.sql.PreparedStatement stmt, int pos, IndexedReference value) Add an object of the target type to a prepared statement doing any necessary type conversion to map it to the SQL representation of the object (as generated by FieldValue.addField(StringBuilder, boolean) Note this is only valid if canSet from SQLAccessor returns true.
void	setValue(T 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.model.data.FieldValue

addField

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

addGroup, checkContentsCanGroup, getGroupParameters, groupingIsomorphic

Constructor Detail

IndexedFieldValue

public IndexedFieldValue(java.lang.Class<T> target,
                         Repository repository,
                         IndexedTypeProducer<I,? extends DataObjectFactory<I>> producer)

Method Detail

getValue

public IndexedReference<I> getValue(T r)

Description copied from interface: Accessor

get the value from the target object

Specified by:

getValue in interface Accessor<IndexedReference,T extends DataObject>

Parameters:

r - target object

Returns:

value

getIndexed

public I getIndexed(T r)

getProducer

public IndexedTypeProducer<I,? extends DataObjectFactory<I>> getProducer()

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<I> 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 IndexedReference<I> makeReference(int id)

setValue

public void setValue(T r,
                     IndexedReference value)

Description copied from interface: Accessor

Set value if supported otherwise throw a UnsupportedOperationException.

Specified by:

setValue in interface Accessor<IndexedReference,T extends DataObject>

setObject

public void setObject(java.sql.PreparedStatement stmt,
                      int pos,
                      IndexedReference value)
               throws java.sql.SQLException

Description copied from interface: FieldValue

Add an object of the target type to a prepared statement doing any necessary type conversion to map it to the SQL representation of the object (as generated by FieldValue.addField(StringBuilder, boolean) Note this is only valid if canSet from SQLAccessor returns true.

Specified by:

setObject in interface FieldValue<IndexedReference,T extends DataObject>

Throws:

java.sql.SQLException

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getFilter

public SQLFilter<T> getFilter(MatchCondition match,
                              IndexedReference val)

Description copied from interface: FilterProvider

Create a SQLFilter comparing against the target value

Specified by:

getFilter in interface FilterProvider<T extends DataObject,IndexedReference>

Returns:

SQLFilter

getNullFilter

public SQLFilter<T> getNullFilter(boolean is_null)

Description copied from interface: FilterProvider

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

Specified by:

getNullFilter in interface FilterProvider<T extends DataObject,IndexedReference>

Returns:

SQLFilter

getOrderFilter

public SQLFilter<T> getOrderFilter(boolean descending)

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

Returns:

SQLFilter

getSQLFilter

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

Create a filter for the home table out of a a filter on the target object

Specified by:

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

Parameters:

fil -

Returns:

SQLFilter

Throws:

CannotFilterException

getFieldName

public java.lang.String getFieldName()

Description copied from interface: FieldValue

Get the corresponding field name. This should not be used to create SQL fragments but can be used to identify Repository field names

Specified by:

getFieldName in interface FieldValue<IndexedReference,T extends DataObject>

Returns:

database field name

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

getInput

public Input getInput()

Description copied from interface: Selector

get the Input associated with this object.

Specified by:

getInput in interface Selector

Returns:

Input

getFactory

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

Description copied from interface: IndexedSQLValue

get the remote DataObjectFactory

Specified by:

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

Returns:

DataObjectFactory

Throws:

java.lang.Exception

canSet

public boolean canSet()

Description copied from interface: Accessor

does this Accessor support setting values.

Specified by:

canSet in interface Accessor<IndexedReference,T extends DataObject>

Returns:

getFilterType

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

Description copied from interface: FilterProvider

get the type bounds on the produced SQLFilter.

Specified by:

getFilterType in interface FilterProvider<T extends DataObject,IndexedReference>

Returns:

Class

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

Returns:

SQLExpression