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

Class XMLRecordParser

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.update.BaseParser

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

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

All Implemented Interfaces:

PropertyContainerParser, PropertyContainerUpdater, uk.ac.ed.epcc.webapp.Contexed

Direct Known Subclasses:

LoadLevelerParser, OGFXMLRecordParser

public class XMLRecordParser
extends BatchParser
implements uk.ac.ed.epcc.webapp.Contexed, PropertyContainerParser

Parser for usage records in an XML format.

Properties are extracted from each XML record using an Xpath expression to identify the fragment to parse and a DomValueParser to perform the parse. Subclasses can pre-define properties and use annotations to set the xpath and parser values.

New properties can be defined by setting: tag.prop.name=type where type is one of string, date or number.

The xpath target is set using tag.prop-name.xpath

Namespaces for use in these Xpaths can be defined using tag.namespace.prefix=uri

The DomValueParser can be set using tag.prop-name.parser though if this property is not set a default parser is generated using the schema type or the target type of the property.

Field Summary

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

ACCOUNT_PROP, batch, BATCH_SCRIPT_PROP, CPU_WAIT_PROP, EXPECTED_FINISH, JOB_ID_PROP, JOB_NAME_PROP, NODE_COUNT_PROP, PARTITION_PROP, PROC_COUNT_PROP, QUEUE_PROP, REQUEST_ACCURACY_PROP, REQUESTED_CPUS_PROP, REQUESTED_WALLCLOCK_PROP, RESIDENCY_PROP, SERIAL_PROP, SLOWDOWN_PROP, SUBJOB_PROP, SUBMITTED_PROP, SUBMITTED_TIMESTAMP, SUCCESS_PROP, TIME_PROP, WAIT_PROP, WALLCLOCK_PROP

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

DUPLICATE_KEY

Constructor Summary

Constructors

Constructor and Description
XMLRecordParser(uk.ac.ed.epcc.webapp.AppContext context) Constructs a new OGFUsageRecordParser.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	defaultSchemaName() Default Schema to use when none set via properties
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()
protected XMLSplitter	getSplitter()
protected java.lang.String[]	getTargets()
protected PropertyFinder	initFinder(uk.ac.ed.epcc.webapp.AppContext context2, PropertyFinder prev) First stage of the initFinder process.
PropertyFinder	initFinder(uk.ac.ed.epcc.webapp.AppContext context, PropertyFinder prev, java.lang.String mode) Generate a PropertyFinder that will find any PropertyTag generated by this class.
protected ParsernameSpaceContext	makeNameSpaceContext() This is used for namespace resolution In particular for the Xpath expressions used by the parser.
boolean	parse(PropertyMap map, java.lang.String record) Parse a String representation of the UsageRecord.
protected void	postProcess(PropertyMap map) Extension point to allow a parser to post-process the values.
java.util.Iterator<java.lang.String>	splitRecords(java.lang.String records) split a multiple record update into individual records in the way appropriate to this accountng scheme.
void	startParse(PropertyContainer defaults) Start a batch parse.

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

getDerivedProperties

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

readDouble, readInteger, readLong, readTime

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

getDefaultUniqueProperties, modifyDefaultTableSpecification, unique

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

getDefaultUniqueProperties

Methods inherited from interface uk.ac.ed.epcc.safe.accounting.update.PropertyContainerUpdater

getDerivedProperties, modifyDefaultTableSpecification

Constructor Detail

XMLRecordParser

public XMLRecordParser(uk.ac.ed.epcc.webapp.AppContext context)

Constructs a new OGFUsageRecordParser. This parser is cannot be considered properly constructed until a called to initFinder(AppContext, PropertyFinder, String) is made. Attempts to use this parser before either of the methods have been called will result in an IllegalStateException being thrown. The AppContext is replaced when initFinder(AppContext, PropertyFinder,String) is called.

Parameters:

context - The current AppContext

Method Detail

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

getContext

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

Specified by:

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

initFinder

public final PropertyFinder initFinder(uk.ac.ed.epcc.webapp.AppContext context,
                        PropertyFinder prev,
                        java.lang.String mode)

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

Overrides:

initFinder in class BaseParser

prev - PropertyFinder for the higher levels in the call chain.

mode - String name of the destination table in case per-table customisation is needed

Returns:

PropertyFinder or null

initFinder

protected PropertyFinder initFinder(uk.ac.ed.epcc.webapp.AppContext context2,
                        PropertyFinder prev)

First stage of the initFinder process. This only generates the PropertyFinder that is used by the normal initFinder call

Parameters:

context2 -

prev -

Returns:

defaultSchemaName

protected java.lang.String defaultSchemaName()

Default Schema to use when none set via properties

Returns:

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

Specified by:

parse in interface PropertyContainerParser

Throws:

AccountingParseException

Parameters:

map - PropertyMap to add quantities

Returns:

true if parse ok

postProcess

protected void postProcess(PropertyMap map)

Extension point to allow a parser to post-process the values. Though this could be performed by a policy this makes it easier to do post-processing that is specific to the parser

Parameters:

map -

splitRecords

public java.util.Iterator<java.lang.String> splitRecords(java.lang.String records)
                                                  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:

records - string containing multiple records

Returns:

Iterator

makeNameSpaceContext

protected ParsernameSpaceContext makeNameSpaceContext()

This is used for namespace resolution In particular for the Xpath expressions used by the parser. If a sub-class uses name-spaces in the Xpath then override this method to add them to the NameSpaceContext

Returns:

getTargets

protected java.lang.String[] getTargets()

getSplitter

protected XMLSplitter getSplitter()

startParse

public void startParse(PropertyContainer defaults)
                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:

defaults - properties constant for this accounting run.