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

Interface PropertyContainerUpdater

All Known Subinterfaces:

IncrementalPropertyContainerParser, PropertyContainerDomParser, PropertyContainerParser, PropertyContainerPolicy, UsageRecordPolicy

All Known Implementing Classes:

AbstractKeyPairParser, AbstractPbsParser, AbstractPropertyContainerParser, AbstractPropertyContainerUpdater, AggregationPolicy, AliasPropertyPolicy, BaseParser, BasePolicy, BaseUsageRecordPolicy, BatchParser, ClassificationPolicy, DerivedPropertyPolicy, DiracSLUMParser, ExpressionPropertyPolicy, GlobusJobManagerParser, GridFtpTransferParser, GridMapParser, GridPropertyPolicy, JobmanagerParser, LinkPolicy, ListenerPolicy, LoadLevelerParser, LSFParser, MatcherFinderPolicy, NGSXMLRecordParser, NullParser, OGFXMLRecordParser, PasswdParser, PbsParser, ReadOnlyParser, RegexpParser, SgeParser, VomsAccountingParser, XMLPropertyDomParser, XMLRecordParser

public interface PropertyContainerUpdater

An object that adds properties to a PropertyContainer. Note that the initFinder(AppContext, PropertyFinder, String) method should always be called before any other methods from this interface. While it would be cleaner to initialise the object within the constructor this process may need information about the higher stages of the call chain.

Author:

spb

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.
PropExpressionMap	getDerivedProperties(PropExpressionMap previous) return a set of derived property definitions.
PropertyFinder	initFinder(uk.ac.ed.epcc.webapp.AppContext ctx, PropertyFinder prev, 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 table_name) Modify the default table specification if appropriate A null specification denotes that a table should not be auto-created.
void	startParse(PropertyContainer static_props) Start a batch parse.

Method Detail

initFinder

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

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

Parameters:

ctx -

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

getDerivedProperties

PropExpressionMap getDerivedProperties(PropExpressionMap previous)

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

Parameters:

previous - Previous definitions

Returns:

Map modified map

startParse

void startParse(PropertyContainer static_props)
                throws java.lang.Exception

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.

Throws:

java.lang.Exception

Parameters:

static_props - properties constant for this accounting run.

endParse

java.lang.String endParse()

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

Returns:

Error string if any

modifyDefaultTableSpecification

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 table_name)

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.

Parameters:

conn - AppContext

t - TableSpecification or null

table_name -

Returns:

modified TableSpecification