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

Class UsageRecordParseTargetPlugIn<T extends UsageRecordFactory.Use>

java.lang.Object

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

Type Parameters:

T - type of usage record

All Implemented Interfaces:

PropertyContainerParseTarget<T>, UsageRecordParseTarget<T>, uk.ac.ed.epcc.webapp.Contexed

public class UsageRecordParseTargetPlugIn<T extends UsageRecordFactory.Use>
extends java.lang.Object
implements UsageRecordParseTarget<T>, uk.ac.ed.epcc.webapp.Contexed

Class to implement UsageRecordParseTarget using a PlugInOwner and a UsageRecordFactory. This is usually used in composition so that the UsageRecordFactory can implement the interface directly. Note that the default implementation of findDuplicate(uk.ac.ed.epcc.safe.accounting.db.UsageRecordFactory.Use) method provided in this class is independent of the other methods in UsageParseTarget so sub-classes can overrride and Factories using this class in composition can re-implement this method.

Author:

spb

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UNIQUE_PROPERTIES_PREFIX

Constructor Summary

Constructors

Constructor and Description
UsageRecordParseTargetPlugIn(uk.ac.ed.epcc.webapp.AppContext conn, PlugInOwner owner, UsageRecordFactory<T> fac)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowReplace(DerivedPropertyMap map, T record) Should replacement of the existing record with new values be allowed.
boolean	commitRecord(PropertyContainer map, T record) Commit a new record also apply any required side-effects As the record may only contain a sub-set of the known properties the full PropertyContainer is passed separately
void	deleteRecord(T old_record) Delete an existing Record including any required side-effects
java.lang.StringBuilder	endParse() Complete a batch parse.
T	findDuplicate(T r) find a record in the database that is a previous version of the current line.
uk.ac.ed.epcc.webapp.AppContext	getContext()
PropertyFinder	getFinder() Get the PropertyFinder corresponding to this parse
java.lang.String	getUniqueID(T r)
protected java.util.Set<PropertyTag>	getUniqueProperties() Get the set of unique properties to use for detecting re-inserts.
boolean	isComplete(T r) Is this a complete or partial record.
boolean	parse(DerivedPropertyMap map, java.lang.String current_line) Parse a text line into a DerivedPropertyMap.
protected java.util.Set<PropertyTag>	parsePropertyList(java.lang.String list)
T	prepareRecord(DerivedPropertyMap map) Create an uncommitted DB record from the property map.
java.util.Iterator<java.lang.String>	splitRecords(java.lang.String update) split update text into a series of lines.
void	startParse(PropertyMap defaults) Start a batch parse.
void	updateRecord(DerivedPropertyMap map, T record) Perform a full update of an existing record.

Methods inherited from class java.lang.Object

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

Field Detail

UNIQUE_PROPERTIES_PREFIX

public static final java.lang.String UNIQUE_PROPERTIES_PREFIX

See Also:

Constant Field Values

Constructor Detail

UsageRecordParseTargetPlugIn

public UsageRecordParseTargetPlugIn(uk.ac.ed.epcc.webapp.AppContext conn,
                            PlugInOwner owner,
                            UsageRecordFactory<T> fac)

Method Detail

getContext

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

Specified by:

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

parse

public boolean parse(DerivedPropertyMap map,
            java.lang.String current_line)
              throws AccountingParseException

Description copied from interface: PropertyContainerParseTarget

Parse a text line into a DerivedPropertyMap. This will add derived definitions as well as terminal data values.

Specified by:

parse in interface PropertyContainerParseTarget<T extends UsageRecordFactory.Use>

Throws:

AccountingParseException

Parameters:

map - DerivedPropertyMap to be populated

Returns:

true if ok false if this line should be skipped without error

splitRecords

public java.util.Iterator<java.lang.String> splitRecords(java.lang.String update)
                                                  throws AccountingParseException

Description copied from interface: PropertyContainerParseTarget

split update text into a series of lines.

Specified by:

splitRecords in interface PropertyContainerParseTarget<T extends UsageRecordFactory.Use>

Throws:

AccountingParseException

Returns:

Iterator

startParse

public void startParse(PropertyMap defaults)
                throws java.lang.Exception

Description copied from interface: PropertyContainerParseTarget

Start a batch parse. This allocates any temporary state. 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 PropertyContainerParseTarget<T extends UsageRecordFactory.Use>

Throws:

java.lang.Exception

Parameters:

defaults - PropertyMap of default global properties

endParse

public java.lang.StringBuilder endParse()

Description copied from interface: PropertyContainerParseTarget

Complete a batch parse.

Specified by:

endParse in interface PropertyContainerParseTarget<T extends UsageRecordFactory.Use>

Returns:

StringBuilder containing any status report

getFinder

public PropertyFinder getFinder()

Description copied from interface: PropertyContainerParseTarget

Get the PropertyFinder corresponding to this parse

Specified by:

getFinder in interface PropertyContainerParseTarget<T extends UsageRecordFactory.Use>

Returns:

PropertyFinder

parsePropertyList

protected java.util.Set<PropertyTag> parsePropertyList(java.lang.String list)
                                                throws InvalidPropertyException

Throws:

InvalidPropertyException

getUniqueProperties

protected java.util.Set<PropertyTag> getUniqueProperties()

Get the set of unique properties to use for detecting re-inserts.

Returns:

findDuplicate

public T findDuplicate(T r)
                                               throws java.lang.Exception

Description copied from interface: UsageRecordParseTarget

find a record in the database that is a previous version of the current line.

Specified by:

findDuplicate in interface UsageRecordParseTarget<T extends UsageRecordFactory.Use>

Throws:

java.lang.Exception

Parameters:

r - Uncommitted AccountingRecord

Returns:

Old AccountingRecord or null if not found

isComplete

public boolean isComplete(T r)

Description copied from interface: UsageRecordParseTarget

Is this a complete or partial record.

Specified by:

isComplete in interface UsageRecordParseTarget<T extends UsageRecordFactory.Use>

Returns:

boolean

deleteRecord

public void deleteRecord(T old_record)
                  throws java.lang.Exception,
                         uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

Description copied from interface: UsageRecordParseTarget

Delete an existing Record including any required side-effects

Specified by:

deleteRecord in interface UsageRecordParseTarget<T extends UsageRecordFactory.Use>

Throws:

java.lang.Exception

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

commitRecord

public boolean commitRecord(PropertyContainer map,
                   T record)
                     throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

Description copied from interface: UsageRecordParseTarget

Commit a new record also apply any required side-effects As the record may only contain a sub-set of the known properties the full PropertyContainer is passed separately

Specified by:

commitRecord in interface UsageRecordParseTarget<T extends UsageRecordFactory.Use>

Throws:

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

Parameters:

map - Full PropertyContainer for new record

record - new record to commit

Returns:

true if record was complete

updateRecord

public void updateRecord(DerivedPropertyMap map,
                T record)
                  throws java.lang.Exception

Description copied from interface: UsageRecordParseTarget

Perform a full update of an existing record. This includes applying the side-effects corresponding to record delete and create

Specified by:

updateRecord in interface UsageRecordParseTarget<T extends UsageRecordFactory.Use>

Throws:

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

java.lang.Exception

allowReplace

public boolean allowReplace(DerivedPropertyMap map,
                   T record)

Description copied from interface: UsageRecordParseTarget

Should replacement of the existing record with new values be allowed. This is an extension point to allow policies to detect refunded jobs and veto a replacement.

Specified by:

allowReplace in interface UsageRecordParseTarget<T extends UsageRecordFactory.Use>

Parameters:

map - DerivedPropertyMap of new parsed values

record - existing record

Returns:

boolean

prepareRecord

public T prepareRecord(DerivedPropertyMap map)
                                               throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                                                      InvalidPropertyException,
                                                      AccountingParseException

Description copied from interface: UsageRecordParseTarget

Create an uncommitted DB record from the property map.

Specified by:

prepareRecord in interface UsageRecordParseTarget<T extends UsageRecordFactory.Use>

Throws:

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

InvalidPropertyException

AccountingParseException

Returns:

Uncommitted record

getUniqueID

public java.lang.String getUniqueID(T r)
                             throws java.lang.Exception

Throws:

java.lang.Exception