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

Class ClassificationPolicy

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

All Implemented Interfaces:

SummaryProvider, PropertyContainerPolicy, PropertyContainerUpdater, uk.ac.ed.epcc.webapp.Contexed, uk.ac.ed.epcc.webapp.jdbc.table.TransitionSource<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>

public class ClassificationPolicy
extends BasePolicy
implements uk.ac.ed.epcc.webapp.Contexed, uk.ac.ed.epcc.webapp.jdbc.table.TransitionSource<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>, SummaryProvider

Add Classification tables to raw usage data under the control of config parameters. For each known String PropertyTag if the config property classification.table-name.property-name is defined then this is taken as a remote table name and the corresponding Reference property is set. A derived properties is added for the original string property removing the need to also store the original field in the database. note that this will overwrite any derivations previously in force so derived expressions cannot be used to generate the input string property. The target Factory needs to implement NameFinder.

Author:

spb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ClassificationPolicy.AddClassifierAction
class	ClassificationPolicy.AddClassifierTransition
class	ClassificationPolicy.DeleteClassifierAction
class	ClassificationPolicy.DeleteClassifierTransition
class	ClassificationPolicy.RegenerateClassifierAction
class	ClassificationPolicy.RegenerateClassifierTransition

Constructor Summary

Constructors

Constructor and Description
ClassificationPolicy(uk.ac.ed.epcc.webapp.AppContext c)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	endParse() End a batch parse this de-allocates any temporary storage and and perform any final operations.
uk.ac.ed.epcc.webapp.AppContext	getContext()
PropExpressionMap	getDerivedProperties(PropExpressionMap previous) return a set of derived property definitions.
void	getTableTransitionSummary(uk.ac.ed.epcc.webapp.content.ContentBuilder hb, uk.ac.ed.epcc.webapp.session.SessionService operator)
java.util.Map<uk.ac.ed.epcc.webapp.model.data.transition.TransitionKey<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>,uk.ac.ed.epcc.webapp.forms.transition.Transition<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>>	getTransitions()
PropertyFinder	initFinder(uk.ac.ed.epcc.webapp.AppContext c, PropertyFinder finder, java.lang.String table) Generate a PropertyFinder that will find any PropertyTag generated by this class.
uk.ac.ed.epcc.webapp.jdbc.table.TableSpecification	modifyDefaultTableSpecification(uk.ac.ed.epcc.webapp.AppContext conn, uk.ac.ed.epcc.webapp.jdbc.table.TableSpecification t, java.lang.String tag_name) Modify the default table specification if appropriate A null specification denotes that a table should not be auto-created.
void	parse(PropertyMap rec) Generate additional properties based on properties from the basic parse and previously applied Policies
void	startParse(PropertyContainer defaults) Start a batch parse.

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

unique

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassificationPolicy

public ClassificationPolicy(uk.ac.ed.epcc.webapp.AppContext c)

Method Detail

parse

public void parse(PropertyMap rec)
           throws AccountingParseException

Description copied from interface: PropertyContainerPolicy

Generate additional properties based on properties from the basic parse and previously applied Policies

Specified by:

parse in interface PropertyContainerPolicy

Overrides:

parse in class BasePolicy

Throws:

AccountingParseException

Parameters:

rec - PropertyMap being modified

endParse

public java.lang.String endParse()

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

startParse

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

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.

getContext

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

Specified by:

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

initFinder

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

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

Specified by:

initFinder in interface PropertyContainerUpdater

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

getDerivedProperties

public PropExpressionMap getDerivedProperties(PropExpressionMap previous)

Description copied from interface: PropertyContainerUpdater

return a set of derived property definitions. Each derived property is defined in terms of a simple expression over other properties (that may themselves be derived properties).

Definitions are allowed for properties that are also generated directly in the parse phase. In this case the parse value should always be used by preference and the derived definition only provides a fall-back implementation if the parse value is unavailable. For example if not persisted in the database layer. This allows one parser/policy to specify a default implementation as a derived property definition which is then overridden by having the same property generated in a parse method of a different policy/parser

Specified by:

getDerivedProperties in interface PropertyContainerUpdater

Overrides:

getDerivedProperties in class AbstractPropertyContainerUpdater

Parameters:

previous - Previous definitions

Returns:

Map modified map

getTransitions

public java.util.Map<uk.ac.ed.epcc.webapp.model.data.transition.TransitionKey<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>,uk.ac.ed.epcc.webapp.forms.transition.Transition<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>> getTransitions()

Specified by:

getTransitions in interface uk.ac.ed.epcc.webapp.jdbc.table.TransitionSource<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>

getTableTransitionSummary

public void getTableTransitionSummary(uk.ac.ed.epcc.webapp.content.ContentBuilder hb,
                             uk.ac.ed.epcc.webapp.session.SessionService operator)

Specified by:

getTableTransitionSummary in interface SummaryProvider

modifyDefaultTableSpecification

public uk.ac.ed.epcc.webapp.jdbc.table.TableSpecification modifyDefaultTableSpecification(uk.ac.ed.epcc.webapp.AppContext conn,
                                                                                 uk.ac.ed.epcc.webapp.jdbc.table.TableSpecification t,
                                                                                 java.lang.String tag_name)

Description copied from interface: PropertyContainerUpdater

Modify the default table specification if appropriate A null specification denotes that a table should not be auto-created. Most work is usually done by the parser (modifying a blank or minimal specification) A policy may alo make changes if it is pre-configured before the table is created. Normally policies are added to an existing table where this method is not relevant.

Specified by:

modifyDefaultTableSpecification in interface PropertyContainerUpdater

Overrides:

modifyDefaultTableSpecification in class AbstractPropertyContainerUpdater

Parameters:

conn - AppContext

t - TableSpecification or null

Returns:

modified TableSpecification