uk.ac.ed.epcc.safe.accounting.reports

Class SelectBuilder

java.lang.Object

uk.ac.ed.epcc.safe.accounting.reports.SelectBuilder

Direct Known Subclasses:

ReportExtension

public abstract class SelectBuilder
extends java.lang.Object

Builds RecordSelector objects from a XML specification.

Author:

spb

Field Summary

Fields

Modifier and Type	Field and Description
protected uk.ac.ed.epcc.webapp.AppContext	conn
static java.lang.String	DESCENDING_ATTR
static java.lang.String	FILTER_AND_ELEMENT
static java.lang.String	FILTER_CONTAINER_ELEMENT
static java.lang.String	FILTER_EQ_ELEMENT
static java.lang.String	FILTER_NOT_NULL_ELEMENT
static java.lang.String	FILTER_NULL_ELEMENT
static java.lang.String	FILTER_OR_ELEMENT
static java.lang.String	FILTER_ORDER_BY_ELEMENT
static java.lang.String	FILTER_PRODUCER_ELEMENT
static java.lang.String	FORMAT_ATTR
protected ValueParserPolicy	parse_vis
static java.lang.String	PROPERTY_ELEMENT
static java.lang.String	TIME_BOUNDS_ELEMENT
static java.lang.String	VALUE_ELEMENT

Constructor Summary

Constructors

Constructor and Description
SelectBuilder(uk.ac.ed.epcc.webapp.AppContext conn)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	addError(java.lang.String type, java.lang.String details, org.w3c.dom.Node n)
protected abstract void	addError(java.lang.String type, java.lang.String details, java.lang.Throwable e)
protected abstract java.lang.String	debug(java.lang.String messg)
protected java.lang.String	getAttribute(java.lang.String name, org.w3c.dom.Element element)
uk.ac.ed.epcc.webapp.AppContext	getContext()
PropExpression<java.util.Date>[]	getDateProperties(ObjectSet recordSet, org.w3c.dom.Node datePropertyNode)
PropExpression	getExpression(PropertyFinder finder, java.lang.String name)
protected java.lang.String	getParam(java.lang.String name, org.w3c.dom.Element elem) Get a parameter contained in a child Element.
protected org.w3c.dom.Element	getParamElement(java.lang.String name, org.w3c.dom.Element e)
protected org.w3c.dom.Element	getParamElementNS(java.lang.String target_namespace, java.lang.String name, org.w3c.dom.Element elem) get a child element specified by namespace and tag.
protected <T> T	getParamExpressionValue(PropExpression<T> expr, java.lang.String name, org.w3c.dom.Element elem) Parse a PropExpression in a nested element this can be overridden so the value can also be provided as a ParameterRef element
protected java.lang.String	getParamNS(java.lang.String namespace, java.lang.String name, org.w3c.dom.Element elem)
protected java.lang.String	getParamNSWithDefault(java.lang.String namespace, java.lang.String name, java.lang.String def, org.w3c.dom.Element elem)
protected java.lang.String	getParamWithDefault(java.lang.String name, java.lang.String def, org.w3c.dom.Element elem)
protected RecordSelector	getRecordSelectElement(PropertyFinder up, org.w3c.dom.Element e) Generate a RecordSelect element.
protected <T> SelectClause<T>	getSelectClause(PropExpression<T> expr, uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition cond, org.w3c.dom.Element e)
protected java.lang.String	getText(org.w3c.dom.Element e) Get the text body of the Element The Element is assumed to be a leaf node with only text content.
protected <T> ValueParser<T>	getValueParser(java.lang.Class<? extends T> clazz)
protected <T> ValueParser<T>	getValueParser(java.lang.String fmt, PropExpression<T> tag)
protected boolean	hasChild(java.lang.String name, org.w3c.dom.Element elem)
<T> T	parse(PropExpression<T> tag, java.lang.String fmt, java.lang.String value)
void	setPolicy(ValueParserPolicy pol)

Methods inherited from class java.lang.Object

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

Field Detail

FILTER_CONTAINER_ELEMENT

public static final java.lang.String FILTER_CONTAINER_ELEMENT

See Also:

Constant Field Values

FORMAT_ATTR

public static final java.lang.String FORMAT_ATTR

See Also:

Constant Field Values

DESCENDING_ATTR

public static final java.lang.String DESCENDING_ATTR

See Also:

Constant Field Values

FILTER_ORDER_BY_ELEMENT

public static final java.lang.String FILTER_ORDER_BY_ELEMENT

See Also:

Constant Field Values

FILTER_PRODUCER_ELEMENT

public static final java.lang.String FILTER_PRODUCER_ELEMENT

See Also:

Constant Field Values

FILTER_AND_ELEMENT

public static final java.lang.String FILTER_AND_ELEMENT

See Also:

Constant Field Values

FILTER_OR_ELEMENT

public static final java.lang.String FILTER_OR_ELEMENT

See Also:

Constant Field Values

FILTER_NULL_ELEMENT

public static final java.lang.String FILTER_NULL_ELEMENT

See Also:

Constant Field Values

FILTER_NOT_NULL_ELEMENT

public static final java.lang.String FILTER_NOT_NULL_ELEMENT

See Also:

Constant Field Values

FILTER_EQ_ELEMENT

public static final java.lang.String FILTER_EQ_ELEMENT

See Also:

Constant Field Values

PROPERTY_ELEMENT

public static final java.lang.String PROPERTY_ELEMENT

See Also:

Constant Field Values

VALUE_ELEMENT

public static final java.lang.String VALUE_ELEMENT

See Also:

Constant Field Values

TIME_BOUNDS_ELEMENT

public static final java.lang.String TIME_BOUNDS_ELEMENT

See Also:

Constant Field Values

conn

protected final uk.ac.ed.epcc.webapp.AppContext conn

parse_vis

protected ValueParserPolicy parse_vis

Constructor Detail

SelectBuilder

public SelectBuilder(uk.ac.ed.epcc.webapp.AppContext conn)

Method Detail

getContext

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

setPolicy

public void setPolicy(ValueParserPolicy pol)

addError

protected abstract void addError(java.lang.String type,
            java.lang.String details,
            org.w3c.dom.Node n)

addError

protected abstract void addError(java.lang.String type,
            java.lang.String details,
            java.lang.Throwable e)

debug

protected abstract java.lang.String debug(java.lang.String messg)

getAttribute

protected final java.lang.String getAttribute(java.lang.String name,
                            org.w3c.dom.Element element)

getParamExpressionValue

protected <T> T getParamExpressionValue(PropExpression<T> expr,
                            java.lang.String name,
                            org.w3c.dom.Element elem)
                             throws java.lang.Exception

Parse a PropExpression in a nested element this can be overridden so the value can also be provided as a ParameterRef element

Throws:

java.lang.Exception

Parameters:

expr -

name -

elem -

Returns:

parse

public <T> T parse(PropExpression<T> tag,
          java.lang.String fmt,
          java.lang.String value)
        throws java.lang.Exception

Throws:

java.lang.Exception

getExpression

public PropExpression getExpression(PropertyFinder finder,
                           java.lang.String name)

getValueParser

protected <T> ValueParser<T> getValueParser(java.lang.String fmt,
                                PropExpression<T> tag)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getValueParser

protected <T> ValueParser<T> getValueParser(java.lang.Class<? extends T> clazz)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getRecordSelectElement

protected RecordSelector getRecordSelectElement(PropertyFinder up,
                                    org.w3c.dom.Element e)
                                         throws java.lang.Exception

Generate a RecordSelect element.

Throws:

java.lang.Exception

Parameters:

up - PropertyFinder

e - Element

Returns:

RecordSelector or null

hasChild

protected final boolean hasChild(java.lang.String name,
               org.w3c.dom.Element elem)

getDateProperties

public final PropExpression<java.util.Date>[] getDateProperties(ObjectSet recordSet,
                                                 org.w3c.dom.Node datePropertyNode)

getSelectClause

protected <T> SelectClause<T> getSelectClause(PropExpression<T> expr,
                                  uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition cond,
                                  org.w3c.dom.Element e)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getText

protected java.lang.String getText(org.w3c.dom.Element e)
                            throws ReportException

Get the text body of the Element The Element is assumed to be a leaf node with only text content. The ParameterExtension overrides this to do on-the-fly parameter expansion for example standard pre-existing parameters like the current user.

Throws:

ReportException

Parameters:

e - Element

Returns:

String

getParam

protected final java.lang.String getParam(java.lang.String name,
                        org.w3c.dom.Element elem)
                                   throws ReportException

Get a parameter contained in a child Element. The Child Element must be in the same name-space as the target element

Throws:

java.lang.Exception

ReportException

Parameters:

name - Parameter Element name

elem - Target Element

Returns:

String

getParamNSWithDefault

protected final java.lang.String getParamNSWithDefault(java.lang.String namespace,
                                     java.lang.String name,
                                     java.lang.String def,
                                     org.w3c.dom.Element elem)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

getParamNS

protected final java.lang.String getParamNS(java.lang.String namespace,
                          java.lang.String name,
                          org.w3c.dom.Element elem)
                                     throws ReportException

Throws:

ReportException

getParamElement

protected final org.w3c.dom.Element getParamElement(java.lang.String name,
                                  org.w3c.dom.Element e)

getParamElementNS

protected final org.w3c.dom.Element getParamElementNS(java.lang.String target_namespace,
                                    java.lang.String name,
                                    org.w3c.dom.Element elem)

get a child element specified by namespace and tag.

Parameters:

target_namespace -

name -

elem -

Returns:

getParamWithDefault

protected final java.lang.String getParamWithDefault(java.lang.String name,
                                   java.lang.String def,
                                   org.w3c.dom.Element elem)
                                              throws java.lang.Exception

Throws:

java.lang.Exception