uk.ac.ed.epcc.safe.accounting.db

Class AccessorMap<X extends uk.ac.ed.epcc.webapp.model.data.DataObject & ExpressionTarget>

java.lang.Object

uk.ac.ed.epcc.safe.accounting.db.AccessorMap<X>

Type Parameters:

X - type of DataObject

All Implemented Interfaces:

ExpressionFilterTarget<X>, uk.ac.ed.epcc.webapp.Contexed, uk.ac.ed.epcc.webapp.Targetted<X>

public class AccessorMap<X extends uk.ac.ed.epcc.webapp.model.data.DataObject & ExpressionTarget>
extends java.lang.Object
implements uk.ac.ed.epcc.webapp.Contexed, ExpressionFilterTarget<X>, uk.ac.ed.epcc.webapp.Targetted<X>

Common PropExpression logic that can be incorporated (by composition) into factory classes for DataObjects that implement ExpressionTarget.

Contains maps from properties to the Accessor/SQLValue/SQLExpression needed to extract data from the record/query.

Also contains a PropExpressionMap allowing properties to be defined in terms of PropExpressions. Special extended PropExpressionVisitors are used when creating an SQLValue/SQLExpression or evaluating an expression so these derived properties can be consulted when processing a PropertyTag.

While it is legal for two properties to map to the same accessor this means that the properties are aliases and updating one will update the other. This can cause problems if a parser generates both properties so the default logic that populates the AccessorMap from the Repository avoids this. Where parsing is not required a class can add duplicate mapping explicitly.

Composite Accessors are not created as evaluating the expression directly with a visitor takes the same amount of recursive calls as a required by the Accessor.

Normally all properties are accessible from a SQLValue. This is true in the standard accouning classes but it is possible to install a custom Accessor for a value that can only be evaluated in java.

Author:

spb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AccessorMap.ExpressionTargetProxy Class to evaluate a PropExpression on a record.
class	AccessorMap.ImplementationVisitor
class	AccessorMap.ResolveChecker
class	AccessorMap.SQLExpressionVisitor
class	AccessorMap.SQLValueVisitor

Field Summary

Fields

Modifier and Type	Field and Description
static uk.ac.ed.epcc.webapp.Feature	EVALUATE_CACHE_FEATURE
static TagFilter	NumberFilter Encodes the rules for which kind of fields can be implemented as a numberif database field.

Constructor Summary

Constructors

Constructor and Description
AccessorMap(java.lang.Class<? super X> target, uk.ac.ed.epcc.webapp.model.data.Repository res, java.lang.String config_tag) create an empty AccessorMap

Method Summary

Methods

Modifier and Type	Method and Description
void	addDerived(uk.ac.ed.epcc.webapp.AppContext conn, PropExpressionMap input) Add definitions from a PropExpressionMap This will not override explicit accessors
PropertyContainer	addFormContents(PropertyContainer map, uk.ac.ed.epcc.webapp.forms.Form f) Try to read an update Form (keyed by field names) into a property container.
protected void	addSource(java.lang.StringBuilder sb)
void	clearUnresolvableDefinitions() clear any PropExpression definitions that cannot be resolved
protected <T> uk.ac.ed.epcc.webapp.jdbc.expr.CaseExpression<X,T>	getCaseExpression(CasePropExpression<T> expr)
uk.ac.ed.epcc.webapp.AppContext	getContext()
protected java.lang.String	getDBTag()
PropExpressionMap	getDerivedProperties()
java.lang.String	getField(PropertyTag t) Return the field name a PropertyTag maps to.
<R> java.util.Map<java.lang.String,R>	getFieldMap(java.util.Map<PropertyTag,R> input) Extract the entries from a map that are keyed by PropertyTags corresponding to database fields and return a new map re-keyed by the field names.
java.util.Set<java.lang.String>	getFieldSet(java.util.Set<PropertyTag> input) Map a set of PropertyTags to their corresponding database fields.
<I> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<X>	getFilter(PropExpression<I> expr, uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition match, I data) get a filter based on comparing a PropExpression to a value.
java.lang.String	getImplemenationInfo(PropertyTag<?> tag)
<I> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<X>	getNullFilter(PropExpression<I> expr, boolean is_null) get a filter that checks null status of an expression.
<I> uk.ac.ed.epcc.webapp.jdbc.filter.OrderFilter<X>	getOrderFilter(boolean descending, PropExpression<I> expr)
uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<X>	getPeriodFilter(uk.ac.ed.epcc.webapp.time.Period period, PropExpression<java.util.Date> start_prop, PropExpression<java.util.Date> end_prop, OverlapType type, long cutoff) Generate an overlap filter
java.util.Set<PropertyTag>	getProperties() Get the set of Defined properties.
java.util.Set<PropertyTag>	getProperties(java.lang.Class<?> c) Get the set of defines properties whose resutls may be assigned to the specified target type
ExpressionTargetContainer	getProxy(X record)
<R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<X>	getRelationFilter(PropExpression<R> left, uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition match, PropExpression<R> right) get a filter that compares two expressions.
java.util.Map<java.lang.String,java.lang.Object>	getSelectors() Generate default set of form selectors
<T> uk.ac.ed.epcc.webapp.jdbc.expr.SQLExpression<T>	getSQLExpression(PropExpression<T> expr)
<T> uk.ac.ed.epcc.webapp.jdbc.expr.SQLValue<T>	getSQLValue(PropExpression<T> expr) Get a SQLValue corresponding to the expression.
java.lang.Class<? super X>	getTarget()
<P> boolean	hasProperty(PropertyTag<P> tag) Is this a defined property
void	makeReferences(ReferencePropertyRegistry reference_registry) Register references from the ReferencePropertyRegistry This generates properties named after the target table.
void	populate(PropertyFinder finder, PropertyRegistry orphan_registy, boolean warn_orphan) Populate this AccessorMap for the specified repository using the best match to the field name from the PropertyFinder.
boolean	possibleCompatible(java.lang.Class a, java.lang.Class b) Test to see if it is possible to have an object that can be assigned to both of two specified types.
<T> void	put(PropertyTag<? extends T> tag, uk.ac.ed.epcc.webapp.Targetted<T> obj)
void	release()
<T> java.lang.Boolean	resolves(PropExpression<T> e, boolean require_sql) Does this property Expression resolve
PropertyFinder	setRelationshipProperties(java.lang.String tag) Add properties defined as a Relationship between the object and the current user.
boolean	writable(PropertyTag t)

Methods inherited from class java.lang.Object

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

Field Detail

EVALUATE_CACHE_FEATURE

public static final uk.ac.ed.epcc.webapp.Feature EVALUATE_CACHE_FEATURE

NumberFilter

public static final TagFilter NumberFilter

Encodes the rules for which kind of fields can be implemented as a numberif database field.

Constructor Detail

AccessorMap

public AccessorMap(java.lang.Class<? super X> target,
           uk.ac.ed.epcc.webapp.model.data.Repository res,
           java.lang.String config_tag)

create an empty AccessorMap

Parameters:

target - type of enclosing factory

res -

config_tag -

Method Detail

put

public <T> void put(PropertyTag<? extends T> tag,
           uk.ac.ed.epcc.webapp.Targetted<T> obj)

possibleCompatible

public boolean possibleCompatible(java.lang.Class a,
                         java.lang.Class b)

Test to see if it is possible to have an object that can be assigned to both of two specified types.

Parameters:

a -

b -

Returns:

boolean

getSQLExpression

public <T> uk.ac.ed.epcc.webapp.jdbc.expr.SQLExpression<T> getSQLExpression(PropExpression<T> expr)
                                                                 throws InvalidSQLPropertyException

Throws:

InvalidSQLPropertyException

getSQLValue

public <T> uk.ac.ed.epcc.webapp.jdbc.expr.SQLValue<T> getSQLValue(PropExpression<T> expr)
                                                       throws InvalidSQLPropertyException

Get a SQLValue corresponding to the expression. Any supported property can be converted to a SQLValue

Throws:

InvalidSQLPropertyException

Type Parameters:

T -

Parameters:

expr -

Returns:

SQLValue

writable

public boolean writable(PropertyTag t)

getProperties

public java.util.Set<PropertyTag> getProperties()

Get the set of Defined properties.

Returns:

Set,PropertyTag>

getProxy

public ExpressionTargetContainer getProxy(X record)

getProperties

public java.util.Set<PropertyTag> getProperties(java.lang.Class<?> c)

Get the set of defines properties whose resutls may be assigned to the specified target type

Parameters:

c - Class of target type

Returns:

Set

hasProperty

public <P> boolean hasProperty(PropertyTag<P> tag)

Is this a defined property

Parameters:

tag -

Returns:

boolean

resolves

public <T> java.lang.Boolean resolves(PropExpression<T> e,
                             boolean require_sql)

Does this property Expression resolve

Type Parameters:

T -

Parameters:

e -

require_sql -

Returns:

boolean

populate

public void populate(PropertyFinder finder,
            PropertyRegistry orphan_registy,
            boolean warn_orphan)

Populate this AccessorMap for the specified repository using the best match to the field name from the PropertyFinder. Basically each database field is mapped to a property. The default algorithm is to search for a property with the same name as the database field. This can be overridden by setting the accounting.table-name.field-name property. As this can specify a fully qualified property name then this can also be useful if there is more than one property with the same name. Optionally unmatched fields can have corresponding properties created. Fields that reference have usually already been handled by makeReferences(uk.ac.ed.epcc.safe.accounting.reference.ReferencePropertyRegistry) so these can be safely ignored. However if there is a matching reference property then this is processed in case it is a static Property from a policy.

Parameters:

finder - PropertyFinder

orphan_registy - Optional registry to create tags without binding

warn_orphan - boolean set to true to make unmatched fields an error.

setRelationshipProperties

public PropertyFinder setRelationshipProperties(java.lang.String tag)

Add properties defined as a Relationship between the object and the current user.

Parameters:

tag -

Returns:

PropertyFinder

makeReferences

public void makeReferences(ReferencePropertyRegistry reference_registry)

Register references from the ReferencePropertyRegistry This generates properties named after the target table.

Parameters:

reference_registry -

getImplemenationInfo

public java.lang.String getImplemenationInfo(PropertyTag<?> tag)

addDerived

public void addDerived(uk.ac.ed.epcc.webapp.AppContext conn,
              PropExpressionMap input)

Add definitions from a PropExpressionMap This will not override explicit accessors

Parameters:

conn -

input -

getDerivedProperties

public PropExpressionMap getDerivedProperties()

clearUnresolvableDefinitions

public void clearUnresolvableDefinitions()

clear any PropExpression definitions that cannot be resolved

getField

public java.lang.String getField(PropertyTag t)

Return the field name a PropertyTag maps to. If the property is read-only, composite or unimplemented then return null.

Parameters:

t - PropertyTag

Returns:

String or null

getFieldSet

public java.util.Set<java.lang.String> getFieldSet(java.util.Set<PropertyTag> input)

Map a set of PropertyTags to their corresponding database fields.

Parameters:

input -

Returns:

Set of field names

getFieldMap

public <R> java.util.Map<java.lang.String,R> getFieldMap(java.util.Map<PropertyTag,R> input)

Extract the entries from a map that are keyed by PropertyTags corresponding to database fields and return a new map re-keyed by the field names.

Type Parameters:

R -

Parameters:

input - Map

Returns:

Map map keyed by field names

addFormContents

public PropertyContainer addFormContents(PropertyContainer map,
                                uk.ac.ed.epcc.webapp.forms.Form f)
                                  throws InvalidPropertyException

Try to read an update Form (keyed by field names) into a property container.

Throws:

InvalidPropertyException

Parameters:

map - PropertyContainer to modify

f - Form to read

Returns:

PropertyContainer

getFilter

public final <I> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<X> getFilter(PropExpression<I> expr,
                                                           uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition match,
                                                           I data)
                                                                                                                                    throws uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Description copied from interface: ExpressionFilterTarget

get a filter based on comparing a PropExpression to a value.

Specified by:

getFilter in interface ExpressionFilterTarget<X extends uk.ac.ed.epcc.webapp.model.data.DataObject & ExpressionTarget>

Throws:

uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Type Parameters:

I - type of prop-expression

Parameters:

expr - expression to match

match - kind of match

data - to math against

Returns:

SQLFilter

getRelationFilter

public <R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<X> getRelationFilter(PropExpression<R> left,
                                                                   uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition match,
                                                                   PropExpression<R> right)
                                                                                                                                      throws uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Description copied from interface: ExpressionFilterTarget

get a filter that compares two expressions.

Specified by:

getRelationFilter in interface ExpressionFilterTarget<X extends uk.ac.ed.epcc.webapp.model.data.DataObject & ExpressionTarget>

Throws:

uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Returns:

Filter

getNullFilter

public final <I> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<X> getNullFilter(PropExpression<I> expr,
                                                               boolean is_null)
                                                                                                                                        throws uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Description copied from interface: ExpressionFilterTarget

get a filter that checks null status of an expression.

Specified by:

getNullFilter in interface ExpressionFilterTarget<X extends uk.ac.ed.epcc.webapp.model.data.DataObject & ExpressionTarget>

Throws:

uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Type Parameters:

I - type of prop-expression

Parameters:

expr - expression to match

is_null - match if null when true

Returns:

Filter

getSelectors

public java.util.Map<java.lang.String,java.lang.Object> getSelectors()

Generate default set of form selectors

Returns:

Map of seelctors

getContext

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

Specified by:

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

getPeriodFilter

public uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<X> getPeriodFilter(uk.ac.ed.epcc.webapp.time.Period period,
                                                             PropExpression<java.util.Date> start_prop,
                                                             PropExpression<java.util.Date> end_prop,
                                                             OverlapType type,
                                                             long cutoff)
                                                                                                                                    throws uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Generate an overlap filter

Specified by:

getPeriodFilter in interface ExpressionFilterTarget<X extends uk.ac.ed.epcc.webapp.model.data.DataObject & ExpressionTarget>

Throws:

uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Parameters:

period - Period to overlap

start_prop - start property may be null

end_prop - end property

type - OverlapType

cutoff - maximum record length for cutoff calculation, zero for unknown

Returns:

BaseFilter

getOrderFilter

public <I> uk.ac.ed.epcc.webapp.jdbc.filter.OrderFilter<X> getOrderFilter(boolean descending,
                                                                 PropExpression<I> expr)
                                                                                                                                    throws uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Specified by:

getOrderFilter in interface ExpressionFilterTarget<X extends uk.ac.ed.epcc.webapp.model.data.DataObject & ExpressionTarget>

Throws:

uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

addSource

protected void addSource(java.lang.StringBuilder sb)

getDBTag

protected java.lang.String getDBTag()

getCaseExpression

protected <T> uk.ac.ed.epcc.webapp.jdbc.expr.CaseExpression<X,T> getCaseExpression(CasePropExpression<T> expr)
                                                                                                                                             throws uk.ac.ed.epcc.webapp.jdbc.filter.NoSQLFilterException,
                                                                                                                                                    InvalidSQLPropertyException,
                                                                                                                                                    java.lang.Exception

Throws:

uk.ac.ed.epcc.webapp.jdbc.filter.NoSQLFilterException

InvalidSQLPropertyException

java.lang.Exception

getTarget

public java.lang.Class<? super X> getTarget()

Specified by:

getTarget in interface uk.ac.ed.epcc.webapp.Targetted<X extends uk.ac.ed.epcc.webapp.model.data.DataObject & ExpressionTarget>

release

public void release()