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

Class DefaultUsageProducer<T extends DataObjectPropertyContainer & UsageRecord>

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>

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

Type Parameters:

T - class of UsageRecord

All Implemented Interfaces:

DerivedPropertyFactory, ExpressionFilterTarget<T>, ExpressionTargetFactory<T>, ExpressionTargetGenerator<T>, PropertyTargetFactory, ReductionProducer<T>, PropertyTargetGenerator<T>, UsageProducer<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:

UsageRecordFactory

public abstract class DefaultUsageProducer<T extends DataObjectPropertyContainer & UsageRecord>
extends DataObjectPropertyFactory<T>
implements UsageProducer<T>

Common base class for turning a DataObjectPropertyFactory into a UsageProducer This class implements most of the query logic needed to implement UsageProducer but down not constrain the class of the UsageRecord more than is required to implement UsageProducer

Author:

spb

Nested Class Summary

Nested classes/interfaces inherited from class uk.ac.ed.epcc.safe.accounting.db.DataObjectPropertyFactory

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

Modifier and Type	Field and Description
static uk.ac.ed.epcc.webapp.Feature	AUTO_CUTOFF_FEATURE
java.util.Map<uk.ac.ed.epcc.safe.accounting.db.DefaultUsageProducer.CutoffKey,java.lang.Long>	cutoffs
protected uk.ac.ed.epcc.webapp.logging.Logger	log

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

AUTO_CREATE_TABLES_FEATURE, res

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultUsageProducer()
protected	DefaultUsageProducer(uk.ac.ed.epcc.webapp.AppContext c, java.lang.String table)

Method Summary

Methods

Modifier and Type	Method and Description
PropExpressionMap	getDerivedProperties()
java.lang.String	getImplemenationInfo(PropertyTag<?> tag) Return a text description of how the property is implemented.
java.util.Map<ExpressionTuple,ReductionMapResult>	getIndexedReductionMap(java.util.Set<ReductionTarget> sum, RecordSelector selector) General reduction operation.
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
<R> R	getReduction(ReductionTarget<R> type, RecordSelector selector) Perform a reduction over a set of records
<I> java.util.Map<I,java.lang.Number>	getReductionMap(PropExpression<I> index, ReductionTarget<java.lang.Number> property, RecordSelector selector) sum the specified numerical quantity over all records that match the selector grouped by the other specified property

Methods inherited from class uk.ac.ed.epcc.safe.accounting.db.DataObjectPropertyFactory

compatible, compatible, find, getAccessorMap, getFilter, getFilter, getIterator, getIterator, getNullFilter, getOrderFilter, getProperties, getRecordCount, getRelationFilter, getSelectClauseFilter, getSelectors, getSQLExpression, getTarget, getValues, hasProperty, makeTableRegistry, update

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.UsageProducer

hasProperty

Methods inherited from interface uk.ac.ed.epcc.safe.accounting.ExpressionTargetGenerator

compatible

Methods inherited from interface uk.ac.ed.epcc.safe.accounting.selector.PropertyTargetGenerator

compatible, getIterator, getIterator, getRecordCount, getValues

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

getFinder

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

getTag

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

getContext

Field Detail

log

protected uk.ac.ed.epcc.webapp.logging.Logger log

cutoffs

public java.util.Map<uk.ac.ed.epcc.safe.accounting.db.DefaultUsageProducer.CutoffKey,java.lang.Long> cutoffs

AUTO_CUTOFF_FEATURE

public static final uk.ac.ed.epcc.webapp.Feature AUTO_CUTOFF_FEATURE

Constructor Detail

DefaultUsageProducer

protected DefaultUsageProducer()

DefaultUsageProducer

protected DefaultUsageProducer(uk.ac.ed.epcc.webapp.AppContext c,
                    java.lang.String table)

Method Detail

getImplemenationInfo

public java.lang.String getImplemenationInfo(PropertyTag<?> tag)

Description copied from interface: UsageProducer

Return a text description of how the property is implemented. if the object is composite this may generate a list of different implementations.

Specified by:

getImplemenationInfo in interface UsageProducer<T extends DataObjectPropertyContainer & UsageRecord>

Parameters:

tag - PropertyTag

Returns:

String

getDerivedProperties

public final PropExpressionMap getDerivedProperties()

Specified by:

getDerivedProperties in interface DerivedPropertyFactory

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 & UsageRecord>

Overrides:

getPeriodFilter in class DataObjectPropertyFactory<T extends DataObjectPropertyContainer & UsageRecord>

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

getReductionMap

public <I> java.util.Map<I,java.lang.Number> getReductionMap(PropExpression<I> index,
                                                    ReductionTarget<java.lang.Number> property,
                                                    RecordSelector selector)
                                                  throws java.lang.Exception

Description copied from interface: ReductionProducer

sum the specified numerical quantity over all records that match the selector grouped by the other specified property

Specified by:

getReductionMap in interface ReductionProducer<T extends DataObjectPropertyContainer & UsageRecord>

Throws:

java.lang.Exception

Returns:

Map

getIndexedReductionMap

public java.util.Map<ExpressionTuple,ReductionMapResult> getIndexedReductionMap(java.util.Set<ReductionTarget> sum,
                                                                       RecordSelector selector)
                                                                         throws java.lang.Exception

Description copied from interface: ReductionProducer

General reduction operation. The reduction is specified by a set of ReductionTarget objects. This method generates Maps from the requested ReductionTarget to the result of the corresponding reduction. If the list of ReductionTargets contains any IndexReduction objects then multiple results will be returned so these results are themselves returned as a Map indexed by PropertyTuple objects representing the Index values. If there are no IndexValues an empty PropertyTuple will be used. A non-index target that does not resolve may be ignored or return the default value for the ReductionTarget. This is so target set compatible with composite UsageProducers can contain targets only relevant to some of its parts without suppressing all output from the tables that don't support the property. This does run the risk that spurious index-tuples might be generated from tables that support none of the non-index targets. In that case the producer has to be tuned.

Specified by:

getIndexedReductionMap in interface ReductionProducer<T extends DataObjectPropertyContainer & UsageRecord>

Throws:

java.lang.Exception

Returns:

Map

getReduction

public <R> R getReduction(ReductionTarget<R> type,
                 RecordSelector selector)
               throws java.lang.Exception

Description copied from interface: ReductionProducer

Perform a reduction over a set of records

Specified by:

getReduction in interface ReductionProducer<T extends DataObjectPropertyContainer & UsageRecord>

Throws:

java.lang.Exception

Parameters:

type - ReductionTarget specifying reduction to perform

selector - RecordSelector to select target records

Returns:

result of reduction