uk.ac.ed.epcc.safe.accounting.policy

Class AggregationPolicy

java.lang.Object

uk.ac.ed.epcc.safe.accounting.update.AbstractPropertyContainerUpdater

uk.ac.ed.epcc.safe.accounting.policy.BasePolicy

uk.ac.ed.epcc.safe.accounting.policy.BaseUsageRecordPolicy

uk.ac.ed.epcc.safe.accounting.policy.AggregationPolicy

All Implemented Interfaces:

PropertyContainerPolicy, PropertyContainerUpdater, UsageRecordPolicy

Deprecated.

Use the more general ListenerPolicy

public class AggregationPolicy
extends BaseUsageRecordPolicy

The AggregationPolicy creates aggregated usage records into a different table. Most of the work is handled by the AggregateUsageRecordFactory. This policy is unusual in that it does not generate any new properties only consume them. Configuration Properties:

• AggregationPolicy.target.table-name defines a comma separated list of remote tables we are updating.

Author:

spb

See Also:

AggregateUsageRecordFactory

Constructor Summary

Constructors

Constructor and Description
AggregationPolicy() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	endParse() Deprecated. End a batch parse this de-allocates any temporary storage and and perform any final operations.
PropertyFinder	initFinder(uk.ac.ed.epcc.webapp.AppContext ctx, PropertyFinder prev, java.lang.String table) Deprecated. Generate a PropertyFinder that will find any PropertyTag generated by this class.
void	postCreate(PropertyContainer props, UsageRecord rec) Deprecated. once record has been committed apply any side effects such as budget charging.
void	preDelete(UsageRecord rec) Deprecated. perform any operations required prior to an existing record being deleted, such as budget refunds
void	startParse(PropertyContainer defaults) Deprecated. Start a batch parse.

Methods inherited from class uk.ac.ed.epcc.safe.accounting.policy.BaseUsageRecordPolicy

allowReplace

Methods inherited from class uk.ac.ed.epcc.safe.accounting.policy.BasePolicy

parse

Methods inherited from class uk.ac.ed.epcc.safe.accounting.update.AbstractPropertyContainerUpdater

getDerivedProperties, modifyDefaultTableSpecification, unique

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface uk.ac.ed.epcc.safe.accounting.update.PropertyContainerPolicy

parse

Methods inherited from interface uk.ac.ed.epcc.safe.accounting.update.PropertyContainerUpdater

getDerivedProperties, modifyDefaultTableSpecification

Constructor Detail

AggregationPolicy

public AggregationPolicy()

Deprecated.

Method Detail

postCreate

public void postCreate(PropertyContainer props,
              UsageRecord rec)
                throws java.lang.Exception

Deprecated.

Description copied from interface: UsageRecordPolicy

once record has been committed apply any side effects such as budget charging.

Specified by:

postCreate in interface UsageRecordPolicy

Overrides:

postCreate in class BaseUsageRecordPolicy

Throws:

java.lang.Exception

Parameters:

props - Full set of properties from the parse stage

rec - The actual committed record

preDelete

public void preDelete(UsageRecord rec)
               throws java.lang.Exception

Deprecated.

Description copied from interface: UsageRecordPolicy

perform any operations required prior to an existing record being deleted, such as budget refunds

Specified by:

preDelete in interface UsageRecordPolicy

Overrides:

preDelete in class BaseUsageRecordPolicy

Throws:

java.lang.Exception

initFinder

public PropertyFinder initFinder(uk.ac.ed.epcc.webapp.AppContext ctx,
                        PropertyFinder prev,
                        java.lang.String table)

Deprecated.

Description copied from interface: PropertyContainerUpdater

Generate a PropertyFinder that will find any PropertyTag generated by this class. This call should be treated as a secondary constructor and should be called before any other method from this interface.

All properties defined at run-time should have their PropertyTag objects constructed by the time the first call to this method returns. As some parsers properties will generate different things depending on the other properties already in scope this method is passed a PropertyFinder for any properties that may already be in scope. This will include any default parameters specified when the data was uploaded and any properties generated from the database meta-data. Though it is perfectly legal to return a PropertyFinder that returns a superset of the generated properties the only requirement is that the returned finder can find any property that this classes parse method may actually generate values for. So Normally the contents of the super-finder are not included in the result unless these values are actually generated by the parse. If values are generated then a MultiFinder can be populated with the PropertyRegistrys from the generated properties

prev - PropertyFinder for the higher levels in the call chain.

table - String name of the destination table in case per-table customisation is needed

Returns:

PropertyFinder or null

startParse

public void startParse(PropertyContainer defaults)
                throws uk.ac.ed.epcc.webapp.jdbc.exception.DataException,
                       InvalidPropertyException

Deprecated.

Description copied from interface: PropertyContainerUpdater

Start a batch parse. This allocates any temporary state appropriate to the policy. Some properties may be set globally for all records in the parse rather than provided record by record. The startParse method is passed all known properties of this type as they may be useful in setting up the parse. There is no requirement to process these in any way.

Specified by:

startParse in interface PropertyContainerUpdater

Overrides:

startParse in class AbstractPropertyContainerUpdater

Throws:

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

InvalidPropertyException

Parameters:

defaults - properties constant for this accounting run.

endParse

public java.lang.String endParse()

Deprecated.

Description copied from interface: PropertyContainerUpdater

End a batch parse this de-allocates any temporary storage and and perform any final operations.

Specified by:

endParse in interface PropertyContainerUpdater

Overrides:

endParse in class AbstractPropertyContainerUpdater

Returns:

Error string if any