uk.ac.ed.epcc.safe.accounting

Class UsageManager<UR extends UsageRecord>

java.lang.Object

uk.ac.ed.epcc.safe.accounting.UsageManager<UR>

Type Parameters:

UR -

All Implemented Interfaces:

DerivedPropertyFactory, ExpressionTargetGenerator<UR>, PropertyTargetFactory, ReductionProducer<UR>, PropertyTargetGenerator<UR>, UsageProducer<UR>, uk.ac.ed.epcc.webapp.Contexed, uk.ac.ed.epcc.webapp.forms.factory.FormUpdateProducer<UR>, uk.ac.ed.epcc.webapp.model.data.forms.Selector<uk.ac.ed.epcc.webapp.forms.inputs.ListInput<java.lang.String,UsageProducer>>, uk.ac.ed.epcc.webapp.Tagged

Direct Known Subclasses:

UsageRecordUsageManager

public abstract class UsageManager<UR extends UsageRecord>
extends java.lang.Object
implements UsageProducer<UR>, uk.ac.ed.epcc.webapp.model.data.forms.Selector<uk.ac.ed.epcc.webapp.forms.inputs.ListInput<java.lang.String,UsageProducer>>, DerivedPropertyFactory, uk.ac.ed.epcc.webapp.forms.factory.FormUpdateProducer<UR>

A composite UsageProducer that combines results from several underlying UsageProducers.

Author:

spb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	UsageManager.MultiIterator
class	UsageManager.ProducerInput FormInput for selecting UsageProducers.

Constructor Summary

Constructors

Constructor and Description
UsageManager(uk.ac.ed.epcc.webapp.AppContext c, java.lang.String tag) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addProducer(java.lang.String description, UsageProducer<UR> producer) method to be called by the populate method to register an additional Producer
<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.
uk.ac.ed.epcc.webapp.AppContext	getContext() get the AppContext
PropExpressionMap	getDerivedProperties()
PropertyFinder	getFinder() Produce a PropertyFinder that can find any of the PropertyTags that can be specified for the objects generated by this type.
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> targets, RecordSelector selector) General reduction operation.
uk.ac.ed.epcc.webapp.forms.inputs.ListInput<java.lang.String,UsageProducer>	getInput()
java.util.Iterator<UR>	getIterator(RecordSelector sel) Get an Iterator over selected records.
java.util.Iterator<UR>	getIterator(RecordSelector sel, int skip, int count) Get an Iterator over selected records.
uk.ac.ed.epcc.webapp.forms.inputs.ListInput<java.lang.String,UsageProducer>	getProducerInput(boolean allow_all)
<C extends UsageProducer> java.util.Vector<C>	getProducers(java.lang.Class<C> target)
java.lang.String	getProducerSelector(java.lang.String name, java.lang.String key)
java.lang.String	getProducerSelector(java.lang.String name, java.lang.String key, boolean allow_all)
java.lang.String	getProducerTag(java.lang.String key)
long	getRecordCount(RecordSelector sel) get the number of records matching the selector
<R> R	getReduction(ReductionTarget<R> type, RecordSelector selector) Perform a reduction over a set of records
<R> java.util.Map<R,java.lang.Number>	getReductionMap(PropExpression<R> tag, ReductionTarget<java.lang.Number> res, RecordSelector selector) sum the specified numerical quantity over all records that match the selector grouped by the other specified property
java.lang.String	getTag()
<PT> java.util.Set<PT>	getValues(PropertyTag<PT> propertyTag, RecordSelector selector) Gets the distinct property values for the set of records identified by the RecordSelector
boolean	hasProducers()
<X> boolean	hasProperty(PropertyTag<X> p) Does this class support the specified property.
UsageProducer	parseProducer(java.lang.String key)
protected abstract void	populate(java.lang.String tag) populate the factories and description table
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.forms.factory.FormUpdateProducer

canUpdate, getFormUpdate

Constructor Detail

UsageManager

public UsageManager(uk.ac.ed.epcc.webapp.AppContext c,
            java.lang.String tag)

Constructor

Parameters:

c -

tag -

Method Detail

getTag

public java.lang.String getTag()

Specified by:

getTag in interface uk.ac.ed.epcc.webapp.Tagged

getContext

public uk.ac.ed.epcc.webapp.AppContext getContext()

get the AppContext

Specified by:

getContext in interface uk.ac.ed.epcc.webapp.Contexed

Returns:

AppContext

getValues

public <PT> java.util.Set<PT> getValues(PropertyTag<PT> propertyTag,
                               RecordSelector selector)
                            throws java.lang.Exception

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<UR extends UsageRecord>

Throws:

java.lang.Exception

Parameters:

propertyTag - the data_tag

selector - the selector

Returns:

Set of property values

getRecordCount

public long getRecordCount(RecordSelector sel)
                    throws uk.ac.ed.epcc.webapp.jdbc.exception.DataException

Description copied from interface: PropertyTargetGenerator

get the number of records matching the selector

Specified by:

getRecordCount in interface PropertyTargetGenerator<UR extends UsageRecord>

Throws:

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

Returns:

number o matches

getIterator

public java.util.Iterator<UR> getIterator(RecordSelector sel)
                                                       throws java.lang.Exception

Description copied from interface: PropertyTargetGenerator

Get an Iterator over selected records.

Specified by:

getIterator in interface PropertyTargetGenerator<UR extends UsageRecord>

Throws:

java.lang.Exception

Parameters:

sel - RecordSelector to select data

Returns:

Iterator over selected records

getIterator

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

Description copied from interface: PropertyTargetGenerator

Get an Iterator over selected records.

Specified by:

getIterator in interface PropertyTargetGenerator<UR extends UsageRecord>

Throws:

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

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

getReductionMap

public <R> java.util.Map<R,java.lang.Number> getReductionMap(PropExpression<R> tag,
                                                    ReductionTarget<java.lang.Number> res,
                                                    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<UR extends UsageRecord>

Throws:

java.lang.Exception

Returns:

Map

getIndexedReductionMap

public java.util.Map<ExpressionTuple,ReductionMapResult> getIndexedReductionMap(java.util.Set<ReductionTarget> targets,
                                                                       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<UR extends UsageRecord>

Throws:

java.lang.Exception

Returns:

Map

getProducerSelector

public java.lang.String getProducerSelector(java.lang.String name,
                                   java.lang.String key)

getProducerSelector

public java.lang.String getProducerSelector(java.lang.String name,
                                   java.lang.String key,
                                   boolean allow_all)

getProducerInput

public uk.ac.ed.epcc.webapp.forms.inputs.ListInput<java.lang.String,UsageProducer> getProducerInput(boolean allow_all)

getProducers

public <C extends UsageProducer> java.util.Vector<C> getProducers(java.lang.Class<C> target)

getProducerTag

public java.lang.String getProducerTag(java.lang.String key)

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<UR extends UsageRecord>

Throws:

java.lang.Exception

Parameters:

type - ReductionTarget specifying reduction to perform

selector - RecordSelector to select target records

Returns:

result of reduction

hasProperty

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

Description copied from interface: UsageProducer

Does this class support the specified property. A false return value is a definitive statement that the property will not be available in any records this UsageProducer retrieves from the database though the properties may exist during the parse phase. A true return value indicates that some of the records returned may contain the specified property.

Specified by:

hasProperty in interface PropertyTargetFactory

Specified by:

hasProperty in interface UsageProducer<UR extends UsageRecord>

Returns:

boolean

hasProducers

public boolean hasProducers()

parseProducer

public UsageProducer parseProducer(java.lang.String key)

populate

protected abstract void populate(java.lang.String tag)

populate the factories and description table

addProducer

protected void addProducer(java.lang.String description,
               UsageProducer<UR> producer)

method to be called by the populate method to register an additional Producer

Parameters:

description -

producer -

getFinder

public PropertyFinder getFinder()

Description copied from interface: PropertyTargetFactory

Produce a PropertyFinder that can find any of the PropertyTags that can be specified for the objects generated by this type. The PropertyFinder may also contain additional PropertyTags as well.

Specified by:

getFinder in interface PropertyTargetFactory

Returns:

PropertyFinder

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<UR extends UsageRecord>

Parameters:

tag - PropertyTag

Returns:

String

getInput

public uk.ac.ed.epcc.webapp.forms.inputs.ListInput<java.lang.String,UsageProducer> getInput()

Specified by:

getInput in interface uk.ac.ed.epcc.webapp.model.data.forms.Selector<uk.ac.ed.epcc.webapp.forms.inputs.ListInput<java.lang.String,UsageProducer>>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDerivedProperties

public final PropExpressionMap getDerivedProperties()

Specified by:

getDerivedProperties in interface DerivedPropertyFactory

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<UR extends UsageRecord>

Returns:

boolean

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<UR extends UsageRecord>

Returns:

boolean