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

Class XMLPropertyDomParser

java.lang.Object

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

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

All Implemented Interfaces:

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

public class XMLPropertyDomParser
extends AbstractPropertyContainerUpdater
implements uk.ac.ed.epcc.webapp.Contexed, PropertyContainerDomParser

An implementation of a PropertyContainerDomParser for data in an XML format.

Normally this is included into a target parser by composition. The class of the target parser is passed to the constructor to allow configuration by reflection and annotations.

Properties are extracted from each XML record using an Xpath expression to identify the fragment to parse and a DomValueParser to perform the parse. Target classes 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

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

Constructor Summary

Constructors

Constructor and Description
XMLPropertyDomParser(uk.ac.ed.epcc.webapp.AppContext context, java.lang.Class target, javax.xml.namespace.NamespaceContext ns, java.lang.String default_schema_name) Constructs a new XMLPropertyDomParser

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<PropertyTag>	defines(org.w3c.dom.Node record) Return the set of PropertyTags that may be defined by the record Node No attempt is made to parse the actual content so this method may be used on a template document where no actual values are specified.
java.lang.String	endParse() End a batch parse this de-allocates any temporary storage and and perform any final operations.
javax.xml.parsers.DocumentBuilder	getBuilder()
uk.ac.ed.epcc.webapp.AppContext	getContext()
<T> DomValueParser<? extends T>	getParser(java.lang.Class<T> clazz, org.w3c.dom.Node n)
<T> DomValueParser<? extends T>	getParser(org.w3c.dom.TypeInfo info, org.w3c.dom.Node n)
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.
boolean	parse(PropertyMap map, org.w3c.dom.Node record) Parse a Dom representation of a UsageRecord in an XML format.
void	startParse(PropertyContainer defaults) Start a batch parse.

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

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

getDerivedProperties, modifyDefaultTableSpecification

Field Detail

USE_SCHEMA_FEATURE_PREFIX

public static final java.lang.String USE_SCHEMA_FEATURE_PREFIX

See Also:

Constant Field Values

Constructor Detail

XMLPropertyDomParser

public XMLPropertyDomParser(uk.ac.ed.epcc.webapp.AppContext context,
                    java.lang.Class target,
                    javax.xml.namespace.NamespaceContext ns,
                    java.lang.String default_schema_name)

Constructs a new XMLPropertyDomParser

Parameters:

context - AppContext

target - target class to query for properties

default_schema_name -

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

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

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.

defines

public java.util.Set<PropertyTag> defines(org.w3c.dom.Node record)

Description copied from interface: PropertyContainerDomParser

Return the set of PropertyTags that may be defined by the record Node No attempt is made to parse the actual content so this method may be used on a template document where no actual values are specified.

Specified by:

defines in interface PropertyContainerDomParser

Returns:

Set of PropertyTag

parse

public boolean parse(PropertyMap map,
            org.w3c.dom.Node record)
              throws AccountingParseException

Description copied from interface: PropertyContainerDomParser

Parse a Dom representation of a UsageRecord in an XML format. If the parse needs to be aborted throw an 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 PropertyContainerDomParser

Throws:

AccountingParseException

Parameters:

map - PropertyMap to add quantities

Returns:

true if parse ok

getParser

public <T> DomValueParser<? extends T> getParser(org.w3c.dom.TypeInfo info,
                                        org.w3c.dom.Node n)

getParser

public <T> DomValueParser<? extends T> getParser(java.lang.Class<T> clazz,
                                        org.w3c.dom.Node n)

getBuilder

public javax.xml.parsers.DocumentBuilder getBuilder()