uk.ac.ed.epcc.safe.accounting.parsers

Class RegexpParser

java.lang.Object

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

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

uk.ac.ed.epcc.safe.accounting.parsers.RegexpParser

All Implemented Interfaces:

PropertyContainerParser, PropertyContainerUpdater

Direct Known Subclasses:

VomsAccountingParser

public abstract class RegexpParser
extends AbstractPropertyContainerParser

PropertyContainerParser based on regular expressions. This class should be sub-classed to make a working parser. Any PropertyTag fields that are marked with the Regexp annotation will be parsed using the defined regular expression and the ValueParserPolicy

Author:

spb

Field Summary

Fields inherited from class uk.ac.ed.epcc.safe.accounting.update.AbstractPropertyContainerParser

DUPLICATE_KEY

Constructor Summary

Constructors

Constructor and Description
RegexpParser()

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.
abstract uk.ac.ed.epcc.webapp.AppContext	getContext()
boolean	parse(PropertyMap map, java.lang.String record) Parse a String representation of the UsageRecord.
java.util.Iterator<java.lang.String>	splitRecords(java.lang.String update) split a multiple record update into individual records in the way appropriate to this accountng scheme.
void	startParse(PropertyContainer staticProps) Start a batch parse.

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

getDefaultUniqueProperties, modifyDefaultTableSpecification, unique

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

getDerivedProperties

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

getDerivedProperties, initFinder

Constructor Detail

RegexpParser

public RegexpParser()

Method Detail

getContext

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

parse

public boolean parse(PropertyMap map,
            java.lang.String record)
              throws AccountingParseException

Description copied from interface: PropertyContainerParser

Parse a String representation of the UsageRecord. If the parse needs to be aborted throw and AccountingParseException. If the parse cannot succeed but no error needs to be reported (e.g. an empty or comment line) this method can return false

Throws:

AccountingParseException

Parameters:

map - PropertyMap to add quantities

Returns:

true if parse ok

splitRecords

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

Description copied from class: AbstractPropertyContainerParser

split a multiple record update into individual records in the way appropriate to this accountng scheme. Usually records are one per line but some schmemes may use other formats like XML

Specified by:

splitRecords in interface PropertyContainerParser

Overrides:

splitRecords in class AbstractPropertyContainerParser

Throws:

AccountingParseException - If a problem occurs while splitting the records

Parameters:

update - string containing multiple records

Returns:

Iterator

startParse

public void startParse(PropertyContainer staticProps)
                throws java.lang.Exception

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:

java.lang.Exception

Parameters:

staticProps - properties constant for this accounting run.

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