uk.ac.ed.epcc.safe.accounting.db

Class DataObjectPropertyFactory<T extends DataObjectPropertyContainer>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.DataObjectFactory<BDO>

uk.ac.ed.epcc.webapp.model.data.table.TableStructureDataObjectFactory<T>

uk.ac.ed.epcc.safe.accounting.db.DataObjectPropertyFactory<T>

Type Parameters:

T -

All Implemented Interfaces:

DerivedPropertyFactory, ExpressionFilterTarget<T>, ExpressionTargetFactory<T>, ExpressionTargetGenerator<T>, PropertyTargetFactory, PropertyTargetGenerator<T>, uk.ac.ed.epcc.webapp.Contexed, uk.ac.ed.epcc.webapp.ContextCached, uk.ac.ed.epcc.webapp.forms.factory.FormCreatorProducer, uk.ac.ed.epcc.webapp.forms.factory.FormUpdateProducer<T>, uk.ac.ed.epcc.webapp.jdbc.table.TableStructureTransitionTarget, uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget, uk.ac.ed.epcc.webapp.model.data.convert.TypeConverter<T,java.lang.Number>, uk.ac.ed.epcc.webapp.model.data.forms.Selector<uk.ac.ed.epcc.webapp.model.data.forms.inputs.DataObjectItemInput<T>>, uk.ac.ed.epcc.webapp.model.data.Owner, uk.ac.ed.epcc.webapp.model.data.reference.IndexedProducer<T>, uk.ac.ed.epcc.webapp.Tagged, uk.ac.ed.epcc.webapp.Targetted<T>

Direct Known Subclasses:

DefaultDataObjectPropertyFactory, DefaultUsageProducer

public abstract class DataObjectPropertyFactory<T extends DataObjectPropertyContainer>
extends uk.ac.ed.epcc.webapp.model.data.table.TableStructureDataObjectFactory<T>
implements ExpressionTargetFactory<T>, DerivedPropertyFactory

Base class for DataObjectFactories that hold accounting properties

Author:

spb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DataObjectPropertyFactory.DataObjectTableRegistry

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.CounterMapper, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.DataObjectAcceptFilter, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.DataObjectInput, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.DataObjectIntegerInput, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.DestFilter<T extends uk.ac.ed.epcc.webapp.model.data.DataObject>, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.ExistsMapper, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.FilterAdapter, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.FilterCounter, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.FilterExists, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.FilterIterator, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.FilterSet, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.Finder, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.MatchFilter, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.ReferenceAcceptFilter<R extends uk.ac.ed.epcc.webapp.Indexed,T extends uk.ac.ed.epcc.webapp.model.data.DataObject>, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.ReferencedAdapter<I extends uk.ac.ed.epcc.webapp.Indexed>, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.ReferenceIterator<I extends uk.ac.ed.epcc.webapp.Indexed>, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.RemoteFilter<T extends uk.ac.ed.epcc.webapp.model.data.DataObject>, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.SortingDataObjectInput, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.TimeAcceptFilter<T extends uk.ac.ed.epcc.webapp.model.data.DataObject>, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.TimeFilter

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

AUTO_CREATE_TABLES_FEATURE, res

Constructor Summary

Constructors

Constructor and Description
DataObjectPropertyFactory()

Method Summary

Methods

Modifier and Type	Method and Description
<I> boolean	compatible(PropExpression<I> expr) Check if the expression is compatible with this class.
boolean	compatible(RecordSelector sel) Is the RecordSelector compatible with this class.
T	find(RecordSelector sel)
protected abstract AccessorMap<T>	getAccessorMap()
<R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<T>	getFilter(PropExpression<R> expr, uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition match, R value) get a filter based on comparing a PropExpression to a value.
protected uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<T>	getFilter(RecordSelector selector) Get a filter from a RecordSelector
java.util.Iterator<T>	getIterator(RecordSelector sel) Get an Iterator over selected records.
java.util.Iterator<T>	getIterator(RecordSelector sel, int skip, int count) Get an Iterator over selected records.
<R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<T>	getNullFilter(PropExpression<R> expr, boolean is_null) get a filter that checks null status of an expression.
<I> uk.ac.ed.epcc.webapp.jdbc.filter.OrderFilter<T>	getOrderFilter(boolean descending, PropExpression<I> expr)
uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<T>	getPeriodFilter(uk.ac.ed.epcc.webapp.time.Period period, PropExpression<java.util.Date> start, PropExpression<java.util.Date> end, OverlapType type, long cutoff) Generate an overlap filter
java.util.Set<PropertyTag>	getProperties() Get the set of Defined properties.
long	getRecordCount(RecordSelector selector) Get the number of records matching a RecordSelector
<R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<T>	getRelationFilter(PropExpression<R> left, uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition match, PropExpression<R> right) get a filter that compares two expressions.
<I> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<T>	getSelectClauseFilter(SelectClause<I> c)
protected java.util.Map<java.lang.String,java.lang.Object>	getSelectors()
<R> uk.ac.ed.epcc.webapp.jdbc.expr.SQLExpression<R>	getSQLExpression(PropExpression<R> exp)
java.lang.Class<? super T>	getTarget()
<PT> java.util.Set<PT>	getValues(PropertyTag<PT> tag, RecordSelector selector) Gets the distinct property values for the set of records identified by the RecordSelector
<X> boolean	hasProperty(PropertyTag<X> p) Is this a defined property
protected DataObjectPropertyFactory.DataObjectTableRegistry	makeTableRegistry()
<X> int	update(PropertyTag<X> tag, X value, RecordSelector sel) Perform an update in the database

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.table.TableStructureDataObjectFactory

getTableTransitionID, getTableTransitionRegistry, resetStructure

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

all, allowPreSelect, canCreate, canUpdate, customiseForm, equals, exists, find, find, find, find, find, getAllIterator, getComposite, getComposites, getConfigTag, getContext, getCount, getDefaults, getDefaultTableSpecification, getFormCreator, getFormUpdate, getIndex, getInput, getInput, getIterator, getLogger, getMaxIdentifierLength, getNullable, getOptional, getOrder, getProperty, getReferenced, getReferenceFieldType, getResult, getSelectFilter, getSupress, getTag, getTranslations, getUniqueIdName, hashCode, isMine, isMine, isMyReference, isValid, makeBDO, makeBDO, makeObject, makeRecord, makeReference, makeReference, makeSet, OrderBy, postCreateTableSetup, release, restrictDefaultInput, setContext, setContext, setContextWithMake, setProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.ac.ed.epcc.safe.accounting.properties.PropertyTargetFactory

getFinder

Methods inherited from interface uk.ac.ed.epcc.safe.accounting.expr.DerivedPropertyFactory

getDerivedProperties

Methods inherited from interface uk.ac.ed.epcc.webapp.Contexed

getContext

Constructor Detail

DataObjectPropertyFactory

public DataObjectPropertyFactory()

Method Detail

makeTableRegistry

protected DataObjectPropertyFactory.DataObjectTableRegistry makeTableRegistry()

Overrides:

makeTableRegistry in class uk.ac.ed.epcc.webapp.model.data.table.TableStructureDataObjectFactory<T extends DataObjectPropertyContainer>

getAccessorMap

protected abstract AccessorMap<T> getAccessorMap()

getSelectors

protected java.util.Map<java.lang.String,java.lang.Object> getSelectors()

Overrides:

getSelectors in class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory<T extends DataObjectPropertyContainer>

getSelectClauseFilter

public <I> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<T> getSelectClauseFilter(SelectClause<I> c)

getProperties

public final java.util.Set<PropertyTag> getProperties()

Get the set of Defined properties.

Returns:

Set

getTarget

public java.lang.Class<? super T> getTarget()

Specified by:

getTarget in interface uk.ac.ed.epcc.webapp.model.data.reference.IndexedProducer<T extends DataObjectPropertyContainer>

Specified by:

getTarget in interface uk.ac.ed.epcc.webapp.Targetted<T extends DataObjectPropertyContainer>

Overrides:

getTarget in class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory<T extends DataObjectPropertyContainer>

hasProperty

public final <X> boolean hasProperty(PropertyTag<X> p)

Is this a defined property

Specified by:

hasProperty in interface PropertyTargetFactory

Parameters:

p -

Returns:

boolean

getFilter

public final <R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<T> getFilter(PropExpression<R> expr,
                                                           uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition match,
                                                           R value)
                                                                                                   throws uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Description copied from interface: ExpressionFilterTarget

get a filter based on comparing a PropExpression to a value.

Specified by:

getFilter in interface ExpressionFilterTarget<T extends DataObjectPropertyContainer>

Throws:

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

Type Parameters:

R - type of prop-expression

Parameters:

expr - expression to match

match - kind of match

value - to math against

Returns:

SQLFilter

getRelationFilter

public final <R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<T> getRelationFilter(PropExpression<R> left,
                                                                   uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition match,
                                                                   PropExpression<R> right)
                                                                                                           throws uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Description copied from interface: ExpressionFilterTarget

get a filter that compares two expressions.

Specified by:

getRelationFilter in interface ExpressionFilterTarget<T extends DataObjectPropertyContainer>

Throws:

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

Returns:

Filter

getNullFilter

public final <R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<T> getNullFilter(PropExpression<R> expr,
                                                               boolean is_null)
                                                                                                       throws uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Description copied from interface: ExpressionFilterTarget

get a filter that checks null status of an expression.

Specified by:

getNullFilter in interface ExpressionFilterTarget<T extends DataObjectPropertyContainer>

Throws:

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

Type Parameters:

R - type of prop-expression

Parameters:

expr - expression to match

is_null - match if null when true

Returns:

Filter

getPeriodFilter

public uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<T> getPeriodFilter(uk.ac.ed.epcc.webapp.time.Period period,
                                                             PropExpression<java.util.Date> start,
                                                             PropExpression<java.util.Date> end,
                                                             OverlapType type,
                                                             long cutoff)
                                                                                                   throws uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Description copied from interface: ExpressionFilterTarget

Generate an overlap filter

Specified by:

getPeriodFilter in interface ExpressionFilterTarget<T extends DataObjectPropertyContainer>

Throws:

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

Parameters:

period - Period to overlap

start - start property

end - end property

type - OverlapType

cutoff - maximum length of records zero if not known

Returns:

Filter

getOrderFilter

public <I> uk.ac.ed.epcc.webapp.jdbc.filter.OrderFilter<T> getOrderFilter(boolean descending,
                                                                 PropExpression<I> expr)
                                                                                                   throws uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Specified by:

getOrderFilter in interface ExpressionFilterTarget<T extends DataObjectPropertyContainer>

Throws:

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

getFilter

protected final uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<T> getFilter(RecordSelector selector)
                                                                                                      throws uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Get a filter from a RecordSelector

Throws:

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

Parameters:

selector -

Returns:

getSQLExpression

public final <R> uk.ac.ed.epcc.webapp.jdbc.expr.SQLExpression<R> getSQLExpression(PropExpression<R> exp)
                                                                       throws InvalidSQLPropertyException

Specified by:

getSQLExpression in interface ExpressionTargetFactory<T extends DataObjectPropertyContainer>

Throws:

InvalidSQLPropertyException

getValues

public final <PT> java.util.Set<PT> getValues(PropertyTag<PT> tag,
                               RecordSelector selector)
                                  throws uk.ac.ed.epcc.webapp.jdbc.exception.DataException,
                                         InvalidPropertyException,
                                         uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Description copied from interface: PropertyTargetGenerator

Gets the distinct property values for the set of records identified by the RecordSelector

Specified by:

getValues in interface PropertyTargetGenerator<T extends DataObjectPropertyContainer>

Throws:

uk.ac.ed.epcc.webapp.jdbc.exception.DataException

InvalidPropertyException

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

Parameters:

tag - the data_tag

selector - the selector

Returns:

Set of property values

update

public final <X> int update(PropertyTag<X> tag,
             X value,
             RecordSelector sel)
                 throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                        InvalidPropertyException,
                        uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Perform an update in the database

Throws:

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

InvalidPropertyException

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

Type Parameters:

X -

Parameters:

tag -

value -

sel -

Returns:

number of recoreds modified

find

public final T find(RecordSelector sel)
                                                 throws uk.ac.ed.epcc.webapp.jdbc.exception.DataException,
                                                        uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Throws:

uk.ac.ed.epcc.webapp.jdbc.exception.DataException

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

compatible

public final <I> boolean compatible(PropExpression<I> expr)

Description copied from interface: ExpressionTargetGenerator

Check if the expression is compatible with this class. A false value indicates no record can ever evaluate the expression. For example if it includes properties that are not generated by the class.

Specified by:

compatible in interface ExpressionTargetGenerator<T extends DataObjectPropertyContainer>

Returns:

boolean

compatible

public final boolean compatible(RecordSelector sel)

Description copied from interface: PropertyTargetGenerator

Is the RecordSelector compatible with this class. This method will return false if it the selector is fundamentally incompatible with the properties supported by the class and no records can match the selector. It does NOT check if any matching records exist.

Specified by:

compatible in interface PropertyTargetGenerator<T extends DataObjectPropertyContainer>

Returns:

boolean

getIterator

public final java.util.Iterator<T> getIterator(RecordSelector sel)
                                                                            throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                                                                                   uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Description copied from interface: PropertyTargetGenerator

Get an Iterator over selected records.

Specified by:

getIterator in interface PropertyTargetGenerator<T extends DataObjectPropertyContainer>

Throws:

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

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

Parameters:

sel - RecordSelector to select data

Returns:

Iterator over selected records

getIterator

public final java.util.Iterator<T> getIterator(RecordSelector sel,
                                int skip,
                                int count)
                                                                            throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                                                                                   uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Description copied from interface: PropertyTargetGenerator

Get an Iterator over selected records.

Specified by:

getIterator in interface PropertyTargetGenerator<T extends DataObjectPropertyContainer>

Throws:

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

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

Parameters:

sel - RecordSelector to select data

skip - Number of initial records in sequence to skip

count - MAximum number of records to return

Returns:

Iterator over selected records

getRecordCount

public final long getRecordCount(RecordSelector selector)
                          throws java.lang.Exception

Get the number of records matching a RecordSelector

Specified by:

getRecordCount in interface PropertyTargetGenerator<T extends DataObjectPropertyContainer>

Throws:

java.lang.Exception

Returns:

number o matches