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

Class DurationFieldValue<X extends DataObject>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.DurationFieldValue<X>

Type Parameters:

X -

All Implemented Interfaces:

Accessor<Duration,X>, FilterProvider<X,Duration>, GroupingSQLValue<Duration>, SQLAccessor<Duration,X>, SQLValue<Duration>, Targetted<Duration>

public class DurationFieldValue<X extends DataObject>
extends java.lang.Object
implements SQLAccessor<Duration,X>, FilterProvider<X,Duration>

A wrapper that converts a NumberFieldExpression into an SQLAccessor for a Duration with a configurable resolution. Note that NumberFieldExpression can implement Duration directly (as a SQLExpression if millisecond resolution is used as Duration is a number. This class is only a SQLValue as the database resolution is different from the numerical value of the Duration.

Field Summary

Fields

Modifier and Type	Field and Description
protected NumberFieldExpression<java.lang.Number,X>	expression
protected long	resolution

Constructor Summary

Constructors

Constructor and Description
DurationFieldValue(NumberFieldExpression<java.lang.Number,X> expression, long resolution) convert a NumberFieldExpression into a DurationFieldValue

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.
java.lang.String	getFieldName()
SQLFilter<X>	getFilter(MatchCondition match, Duration val) Create a SQLFilter comparing against the target value
java.lang.Class<X>	getFilterType() get the type bounds on the produced SQLFilter.
SQLFilter<X>	getNullFilter(boolean is_null) create a SQLFilter checking if the target value is or is not null.
SQLFilter<X>	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<Duration>	getTarget() Get the type of the returned object as far as it is known.
Duration	getValue(X r) get the value from the target object
Duration	makeObject(java.sql.ResultSet rs, int pos) Extract a result of the expression from a ResultSet into an object of the specified type.
void	setObject(java.sql.PreparedStatement stmt, int pos, Duration value)
void	setValue(X rec, Duration duration) 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.GroupingSQLValue

addGroup, checkContentsCanGroup, getGroupParameters, groupingIsomorphic

Field Detail

expression

protected final NumberFieldExpression<java.lang.Number,X extends DataObject> expression

resolution

protected final long resolution

Constructor Detail

DurationFieldValue

public DurationFieldValue(NumberFieldExpression<java.lang.Number,X> expression,
                          long resolution)

convert a NumberFieldExpression into a DurationFieldValue

Parameters:

expression - underlying expression

resolution - resolution of stored value in milliseconds.

Method Detail

getTarget

public java.lang.Class<Duration> 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<Duration>

Returns:

Class object for return type

getValue

public Duration getValue(X r)

Description copied from interface: Accessor

get the value from the target object

Specified by:

getValue in interface Accessor<Duration,X extends DataObject>

Parameters:

r - target object

Returns:

value

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<Duration>

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<Duration>

Parameters:

list - to modify

Returns:

modified list of parameter objects

makeObject

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

Parameters:

rs - ResultSet

Returns:

produced object

Throws:

DataException

java.sql.SQLException

setValue

public void setValue(X rec,
                     Duration duration)

Description copied from interface: Accessor

Set value if supported otherwise throw a UnsupportedOperationException.

Specified by:

setValue in interface Accessor<Duration,X extends DataObject>

setObject

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

Throws:

java.sql.SQLException

getFieldName

public java.lang.String getFieldName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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<Duration>

Returns:

null or SQLFilter

canSet

public boolean canSet()

Description copied from interface: Accessor

does this Accessor support setting values.

Specified by:

canSet in interface Accessor<Duration,X extends DataObject>

Returns:

getFilter

public SQLFilter<X> getFilter(MatchCondition match,
                              Duration val)
                       throws CannotFilterException

Description copied from interface: FilterProvider

Create a SQLFilter comparing against the target value

Specified by:

getFilter in interface FilterProvider<X extends DataObject,Duration>

Returns:

SQLFilter

Throws:

CannotFilterException

getNullFilter

public SQLFilter<X> 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<X extends DataObject,Duration>

Returns:

SQLFilter

Throws:

CannotFilterException

getOrderFilter

public SQLFilter<X> 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<X extends DataObject,Duration>

Returns:

SQLFilter

Throws:

CannotFilterException

getFilterType

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

Description copied from interface: FilterProvider

get the type bounds on the produced SQLFilter.

Specified by:

getFilterType in interface FilterProvider<X extends DataObject,Duration>

Returns:

Class