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

Class ValueParserService

java.lang.Object

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

All Implemented Interfaces:

uk.ac.ed.epcc.webapp.AppContextService<ValueParserService>, uk.ac.ed.epcc.webapp.Contexed

public class ValueParserService
extends java.lang.Object
implements uk.ac.ed.epcc.webapp.Contexed, uk.ac.ed.epcc.webapp.AppContextService<ValueParserService>

This class may be used to fetch a ValueParser by a specific name. Parsers may be added by defining their class in the current AppContext with a property of the following Form:

class.value_parser.parserName = binary java name

for example:

class.value_parser.myParser = com.example.MySpecialParser

The class must be on the class path and implement the ValueParser interface.

Author:

jgreen4

Constructor Summary

Constructors

Constructor and Description
ValueParserService(uk.ac.ed.epcc.webapp.AppContext context) Constructs a new ValueParserService which will configure itself based on the state presented by context.

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanup()
uk.ac.ed.epcc.webapp.AppContext	getContext()
uk.ac.ed.epcc.webapp.content.Table	getDocumentationTable()
java.lang.Class<? super ValueParserService>	getType()
ValueParser	getValueParser(java.lang.String parserName) Returns a ValueParser with the specified name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValueParserService

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

Constructs a new ValueParserService which will configure itself based on the state presented by context.

Parameters:

context - The environment within which this service operates.

Method Detail

getContext

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

Specified by:

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

getValueParser

public ValueParser getValueParser(java.lang.String parserName)
                           throws java.lang.IllegalArgumentException

Returns a ValueParser with the specified name. Several names for parsers have already been predefined. Others may be defined via the AppContext provided during construction of this object.

Throws:

java.lang.IllegalArgumentException - If a ValueParser with the specified name cannot be found

Parameters:

parserName - The name of the parser to return

Returns:

The specified parser

cleanup

public void cleanup()

Specified by:

cleanup in interface uk.ac.ed.epcc.webapp.AppContextService<ValueParserService>

getDocumentationTable

public uk.ac.ed.epcc.webapp.content.Table getDocumentationTable()

getType

public java.lang.Class<? super ValueParserService> getType()

Specified by:

getType in interface uk.ac.ed.epcc.webapp.AppContextService<ValueParserService>