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

Class AccountingClassificationFactory<T extends AccountingClassification>

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.webapp.model.ClassificationFactory<T>

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

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

Type Parameters:

T -

All Implemented Interfaces:

java.lang.Comparable<uk.ac.ed.epcc.webapp.model.ClassificationFactory>, ExpressionFilterTarget<T>, ExpressionTargetFactory<T>, ExpressionTargetGenerator<T>, PropertyTargetFactory, ReductionProducer<T>, FilterSelector<uk.ac.ed.epcc.webapp.model.data.forms.inputs.DataObjectItemInput<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.model.NameFinder<T>, uk.ac.ed.epcc.webapp.model.ParseFactory<T>, uk.ac.ed.epcc.webapp.Tagged, uk.ac.ed.epcc.webapp.Targetted<T>

public class AccountingClassificationFactory<T extends AccountingClassification>
extends PropertyTargetClassificationFactory<T>
implements UsageProducer<T>, FilterSelector<uk.ac.ed.epcc.webapp.model.data.forms.inputs.DataObjectItemInput<T>>

Factory class for AccountingClassification objects. By default the properties are generated from the Database fields but additional properties can be defined as derived properties

Author:

spb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AccountingClassificationFactory.AccountingClassificationTableRegistry
class	AccountingClassificationFactory.AddDerivedTransition

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

PropertyTargetClassificationFactory.PropertyTargetClassificationTableRegistry

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

uk.ac.ed.epcc.webapp.model.ClassificationFactory.ClassificationCreator, uk.ac.ed.epcc.webapp.model.ClassificationFactory.ClassificationTableRegistry, uk.ac.ed.epcc.webapp.model.ClassificationFactory.ClassificationUpdater<C extends uk.ac.ed.epcc.webapp.model.Classification>, uk.ac.ed.epcc.webapp.model.ClassificationFactory.NameInput

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 PropertyRegistry	classification
static PropertyTag<java.lang.String>	DESCRIPTION_PROP
static PropertyTag<java.lang.String>	NAME_PROP

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

AUTO_CREATE_TABLES_FEATURE, res

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	customAccessors(AccessorMap<T> mapi2, MultiFinder finder, PropExpressionMap derived) Extension point to allow custom accessors to be added.
protected AccessorMap<T>	getAccessorMap()
protected 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> sum, RecordSelector selector) General reduction operation.
uk.ac.ed.epcc.webapp.model.data.forms.inputs.DataObjectItemInput<T>	getInput(RecordSelector sel)
<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
<I> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<T>	getSelectClauseFilter(SelectClause<I> c)
protected AccountingClassificationFactory.AccountingClassificationTableRegistry	makeTableRegistry()
void	release()
void	resetStructure()

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

compatible, compatible, find, getFilter, getFilter, getIterator, getIterator, getNullFilter, getOrderFilter, getPeriodFilter, getRecordCount, getRelationFilter, getSQLExpression, getTarget, getValues, hasProperty, makeBDO

Methods inherited from class uk.ac.ed.epcc.webapp.model.ClassificationFactory

allowNameChange, compareTo, findByName, getDataCache, getDefaultTableSpecification, getFormCreator, getFormUpdate, getNameInput, getOrder, getTranslations, makeByName, postCreateTableSetup, postMakeByName

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

getTableTransitionID, getTableTransitionRegistry

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, getIndex, getInput, getInput, getIterator, getLogger, getMaxIdentifierLength, getNullable, getOptional, getProperty, getReferenced, getReferenceFieldType, getResult, getSelectFilter, getSelectors, getSupress, getTag, getUniqueIdName, hashCode, isMine, isMine, isMyReference, isValid, makeBDO, makeObject, makeRecord, makeReference, makeReference, makeSet, OrderBy, 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.webapp.Tagged

getTag

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

getContext

Field Detail

classification

public static final PropertyRegistry classification

NAME_PROP

public static final PropertyTag<java.lang.String> NAME_PROP

DESCRIPTION_PROP

public static final PropertyTag<java.lang.String> DESCRIPTION_PROP

Constructor Detail

AccountingClassificationFactory

public AccountingClassificationFactory(uk.ac.ed.epcc.webapp.AppContext c,
                               java.lang.String table)

Method Detail

customAccessors

protected void customAccessors(AccessorMap<T> mapi2,
                   MultiFinder finder,
                   PropExpressionMap derived)

Extension point to allow custom accessors to be added.

Parameters:

mapi2 -

finder -

derived -

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

getAccessorMap

protected AccessorMap<T> getAccessorMap()

Specified by:

getAccessorMap in class PropertyTargetClassificationFactory<T extends AccountingClassification>

getDerivedProperties

protected PropExpressionMap getDerivedProperties()

Specified by:

getDerivedProperties in class PropertyTargetClassificationFactory<T extends AccountingClassification>

resetStructure

public void resetStructure()

Specified by:

resetStructure in interface uk.ac.ed.epcc.webapp.jdbc.table.TableStructureTransitionTarget

Overrides:

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

getInput

public uk.ac.ed.epcc.webapp.model.data.forms.inputs.DataObjectItemInput<T> getInput(RecordSelector sel)
                                                                                                              throws java.lang.Exception

Specified by:

getInput in interface FilterSelector<uk.ac.ed.epcc.webapp.model.data.forms.inputs.DataObjectItemInput<T extends AccountingClassification>>

Throws:

java.lang.Exception

getSelectClauseFilter

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

makeTableRegistry

protected AccountingClassificationFactory.AccountingClassificationTableRegistry makeTableRegistry()

Overrides:

makeTableRegistry in class PropertyTargetClassificationFactory<T extends AccountingClassification>

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

Parameters:

tag - PropertyTag

Returns:

String

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

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

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

Throws:

java.lang.Exception

Parameters:

type - ReductionTarget specifying reduction to perform

selector - RecordSelector to select target records

Returns:

result of reduction

release

public void release()

Overrides:

release in class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory<T extends AccountingClassification>