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

Interface PropertyContainerParseTarget<T extends uk.ac.ed.epcc.webapp.model.data.DataObject & PropertyContainer>

Type Parameters:

T -

All Known Subinterfaces:

ClassificationParseTarget<T>, UsageRecordParseTarget<T>

All Known Implementing Classes:

AllocationFactory, CertificatePersonFactory, ChargedAllocationFactory, ConfigUsageRecordFactory, ParseAccountingClassificationFactory, ParseUsageRecordFactory, PersonFactory, SequenceAllocationFactory, UsageRecordParseTargetPlugIn

public interface PropertyContainerParseTarget<T extends uk.ac.ed.epcc.webapp.model.data.DataObject & PropertyContainer>

Common interface for classes that generate upload data.

Author:

spb

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.StringBuilder	endParse() Complete a batch parse.
PropertyFinder	getFinder() Get the PropertyFinder corresponding to this parse
boolean	parse(DerivedPropertyMap map, java.lang.String current_line) Parse a text line into a DerivedPropertyMap.
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.

Method Detail

parse

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

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

Throws:

AccountingParseException

Parameters:

map - DerivedPropertyMap to be populated

current_line -

Returns:

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

splitRecords

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

split update text into a series of lines.

Throws:

AccountingParseException

Parameters:

update -

Returns:

Iterator

startParse

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

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.

Throws:

java.lang.Exception

Parameters:

defaults - PropertyMap of default global properties

endParse

java.lang.StringBuilder endParse()

Complete a batch parse.

Returns:

StringBuilder containing any status report

getFinder

PropertyFinder getFinder()

Get the PropertyFinder corresponding to this parse

Returns:

PropertyFinder