uk.ac.ed.epcc.safe.accounting.model

Class PersonFactory<P extends Person>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.DataObjectFactory<AU>

uk.ac.ed.epcc.webapp.session.AppUserFactory<T>

uk.ac.ed.epcc.webapp.session.ExtAuthAppUserFactory<P>

uk.ac.ed.epcc.safe.accounting.model.PersonFactory<P>

Type Parameters:

P -

All Implemented Interfaces:

ClassificationParseTarget<P>, PropertyContainerParseTarget<P>, ExpressionFilterTarget<P>, ExpressionTargetFactory<P>, ExpressionTargetGenerator<P>, PropertyTargetFactory, FilterSelector<uk.ac.ed.epcc.webapp.model.data.forms.inputs.DataObjectItemInput<P>>, PropertyTargetGenerator<P>, PlugInOwner, uk.ac.ed.epcc.webapp.Contexed, uk.ac.ed.epcc.webapp.ContextCached, uk.ac.ed.epcc.webapp.forms.factory.FormCreatorProducer, uk.ac.ed.epcc.webapp.forms.factory.FormUpdateProducer<P>, uk.ac.ed.epcc.webapp.jdbc.table.TableStructureTransitionTarget, uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget, uk.ac.ed.epcc.webapp.model.data.convert.TypeConverter<P,java.lang.Number>, uk.ac.ed.epcc.webapp.model.data.forms.Selector<uk.ac.ed.epcc.webapp.model.data.forms.inputs.DataObjectItemInput<P>>, uk.ac.ed.epcc.webapp.model.data.Owner, uk.ac.ed.epcc.webapp.model.data.reference.IndexedProducer<P>, uk.ac.ed.epcc.webapp.model.NameFinder<P>, uk.ac.ed.epcc.webapp.model.ParseFactory<P>, uk.ac.ed.epcc.webapp.Tagged, uk.ac.ed.epcc.webapp.Targetted<P>

Direct Known Subclasses:

CertificatePersonFactory

public class PersonFactory<P extends Person>
extends uk.ac.ed.epcc.webapp.session.ExtAuthAppUserFactory<P>
implements uk.ac.ed.epcc.webapp.model.NameFinder<P>, ExpressionTargetFactory<P>, uk.ac.ed.epcc.webapp.jdbc.table.TableStructureTransitionTarget, ClassificationParseTarget<P>, PlugInOwner, FilterSelector<uk.ac.ed.epcc.webapp.model.data.forms.inputs.DataObjectItemInput<P>>

Externally authenticated AppUserFactory extended to support properties. This class can also operate as a classification table based on the WEBNAME The property tag.parser can be used to define a parser to populate the table from form uploads. This will also require a PropExpression defining the WEBNAMe in terms of the parsed properties. By default this table is automatically populated when a new user appears at the web-site. This can be disabled by the disable.createusers service feature. Users can be forced through the user self-registration mechanism by setting both the disable.createusers feature and the self.register feature. If The bootstrap.admin feature is on then the first user to connect to the system will automatically be given the admin role. This is to simplify setup of an initial system with a blank database.

Author:

spb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PersonFactory.PersonTableRegistry

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.session.ExtAuthAppUserFactory

uk.ac.ed.epcc.webapp.session.ExtAuthAppUserFactory.ExtAuthUpdater, uk.ac.ed.epcc.webapp.session.ExtAuthAppUserFactory.SignupFormCreator<T extends uk.ac.ed.epcc.webapp.session.ExtAuthAppUser>

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.session.AppUserFactory

uk.ac.ed.epcc.webapp.session.AppUserFactory.AppUserCreator<AU extends uk.ac.ed.epcc.webapp.session.AppUser>, uk.ac.ed.epcc.webapp.session.AppUserFactory.CreateValidator<AU extends uk.ac.ed.epcc.webapp.session.AppUser>, uk.ac.ed.epcc.webapp.session.AppUserFactory.RoleFilter, uk.ac.ed.epcc.webapp.session.AppUserFactory.UpdatePersonRequiredPage

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.CounterMapper, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.DataObjectAcceptFilter, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.DataObjectInput, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.DataObjectIntegerInput, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.DestFilter<T extends uk.ac.ed.epcc.webapp.model.data.DataObject>, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.ExistsMapper, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.FilterAdapter, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.FilterCounter, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.FilterExists, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.FilterIterator, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.FilterSet, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.Finder, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.MatchFilter, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.ReferenceAcceptFilter<R extends uk.ac.ed.epcc.webapp.Indexed,T extends uk.ac.ed.epcc.webapp.model.data.DataObject>, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.ReferencedAdapter<I extends uk.ac.ed.epcc.webapp.Indexed>, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.ReferenceIterator<I extends uk.ac.ed.epcc.webapp.Indexed>, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.RemoteFilter<T extends uk.ac.ed.epcc.webapp.model.data.DataObject>, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.SortingDataObjectInput, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.TimeAcceptFilter<T extends uk.ac.ed.epcc.webapp.model.data.DataObject>, uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.TimeFilter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DISABLE_CREATEUSERS_FEATURE
static PropertyTag<java.lang.String>	EMAIL_PROP
static PropertyTag<java.lang.Boolean>	IS_ME_PROP
static java.lang.String	SELF_REGISTER_FEATURE
static PropertyTag<java.util.Date>	SIGNUP_PROP
static PropertyTag<java.lang.String>	WEBNAME_PROP

Fields inherited from class uk.ac.ed.epcc.webapp.session.AppUserFactory

ANONYMISE_DATABASE_FEATURE, BOOTSTRAP_ADMIN_FEATURE, BOOTSTRAP_ROLE_PROPERTY, EMAIL_MAXWIDTH_PROP, EXTERNAL_AUTH_ONLY_FEATURE, REQUIRE_PERSON_UPDATE_FEATURE, WEB_LOGIN_FEATURE

Fields inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

AUTO_CREATE_TABLES_FEATURE, res

Constructor Summary

Constructors

Constructor and Description
PersonFactory()
PersonFactory(uk.ac.ed.epcc.webapp.AppContext ctx)
PersonFactory(uk.ac.ed.epcc.webapp.AppContext ctx, java.lang.String table)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowSelfRegister()
<I> boolean	compatible(PropExpression<I> expr) Check if the expression is compatible with this class.
boolean	compatible(RecordSelector sel) Is the RecordSelector compatible with this class.
java.lang.StringBuilder	endParse() Complete a batch parse.
P	find(PropertyMap template)
P	findByName(java.lang.String name)
P	findByWebName(java.lang.String name)
protected AccessorMap<P>	getAccessorMap()
uk.ac.ed.epcc.webapp.model.data.DataCache<java.lang.String,P>	getDataCache()
uk.ac.ed.epcc.webapp.jdbc.table.TableSpecification	getDefaultTableSpecification(uk.ac.ed.epcc.webapp.AppContext c, java.lang.String table)
PropExpressionMap	getDerivedProperties() Get a set of derived properties (defined as a PropExpressionMap) that should be implemented by the record.
<R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<P>	getFilter(PropExpression<R> expr, uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition match, R value) get a filter based on comparing a PropExpression to a value.
protected uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<P>	getFilter(RecordSelector selector) Get a filter from a RecordSelector
PropertyFinder	getFinder() Produce a PropertyFinder that can find any of the PropertyTags that can be specified for the objects generated by this type.
PropertyMap	getGlobals(java.util.Map<java.lang.String,java.lang.Object> params) extract global properties from post parameters.
uk.ac.ed.epcc.webapp.model.data.forms.inputs.DataObjectItemInput<P>	getInput(RecordSelector sel)
java.util.Iterator<P>	getIterator(RecordSelector sel) Get an Iterator over selected records.
java.util.Iterator<P>	getIterator(RecordSelector sel, int skip, int count) Get an Iterator over selected records.
<R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<P>	getNullFilter(PropExpression<R> expr, boolean is_null) get a filter that checks null status of an expression.
protected java.util.List<uk.ac.ed.epcc.webapp.jdbc.filter.OrderClause>	getOrder()
<I> uk.ac.ed.epcc.webapp.jdbc.filter.OrderFilter<P>	getOrderFilter(boolean descending, PropExpression<I> expr)
PropertyContainerParser	getParser() get the PropertyContainerParser used for the initial parse stage
uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<P>	getPeriodFilter(uk.ac.ed.epcc.webapp.time.Period period, PropExpression<java.util.Date> start, PropExpression<java.util.Date> end, OverlapType type, long cutoff) Generate an overlap filter
java.util.Set<PropertyContainerPolicy>	getPolicies() Get a set of PropertyContainerPolicy to be applied to the property stream.
long	getRecordCount(RecordSelector selector) get the number of records matching the selector
<R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<P>	getRelationFilter(PropExpression<R> left, uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition match, PropExpression<R> right) get a filter that compares two expressions.
<R> uk.ac.ed.epcc.webapp.jdbc.expr.SQLExpression<R>	getSQLExpression(PropExpression<R> exp)
java.lang.String	getTableTransitionID()
uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionRegistry	getTableTransitionRegistry()
java.lang.Class<? super P>	getTarget()
<PT> java.util.Set<PT>	getValues(PropertyTag<PT> tag, RecordSelector selector) Gets the distinct property values for the set of records identified by the RecordSelector
<X> boolean	hasProperty(PropertyTag<X> tag) Check if the specified property is defined.
P	make(PropertyContainer value) Returns an uncommitted object updated to match the input container.
protected uk.ac.ed.epcc.webapp.model.data.DataObject	makeBDO(uk.ac.ed.epcc.webapp.model.data.Repository.Record res)
P	makeByName(java.lang.String name)
P	makeFromWebName(java.lang.String name)
P	makeFromWebName(java.lang.String name, boolean forceCreate)
protected boolean	makeOnUpload() Control if new records should be made when seen in an parse
protected PersonFactory.PersonTableRegistry	makeTableRegistry()
java.util.Map<java.lang.String,java.lang.Boolean>	makeToggleMap()
java.lang.String	normaliseName(java.lang.String name)
boolean	parse(DerivedPropertyMap map, java.lang.String currentLine) Parse a text line into a DerivedPropertyMap.
void	release()
void	resetStructure()
protected void	setStaticAccessors(MultiFinder finder, AccessorMap<P> map2) Extension point to allow programmatic modifications to the AccessorMap in sub-classes
java.util.Iterator<java.lang.String>	splitRecords(java.lang.String update) split update text into a series of lines.
void	startParse(PropertyMap defaults) Start a batch parse.

Methods inherited from class uk.ac.ed.epcc.webapp.session.ExtAuthAppUserFactory

allowWebLogin, getFormUpdate, getSignupFormCreator

Methods inherited from class uk.ac.ed.epcc.webapp.session.AppUserFactory

addUpdateNotes, buildUpdateForm, findByEmail, findByEmail, getCreateValidator, getDefaults, getFormCreator, getRequiredPages, getRoleFilter, getRoleInput, getSelectors, getSupress, isRegisteredUsername, postAutoTableCreateSetup, postCreateTableSetup

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

all, allowPreSelect, canCreate, canUpdate, customiseForm, equals, exists, find, find, find, find, find, getAllIterator, getComposite, getComposites, getConfigTag, getContext, getCount, getIndex, getInput, getInput, getIterator, getLogger, getMaxIdentifierLength, getNullable, getOptional, getProperty, getReferenced, getReferenceFieldType, getResult, getSelectFilter, getTag, getTranslations, getUniqueIdName, hashCode, isMine, isMine, isMyReference, isValid, makeBDO, makeObject, makeRecord, makeReference, makeReference, makeSet, OrderBy, restrictDefaultInput, setContext, setContext, setContextWithMake, setProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.ac.ed.epcc.webapp.Contexed

getContext

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

getTag

Field Detail

DISABLE_CREATEUSERS_FEATURE

public static final java.lang.String DISABLE_CREATEUSERS_FEATURE

See Also:

Constant Field Values

SELF_REGISTER_FEATURE

public static final java.lang.String SELF_REGISTER_FEATURE

See Also:

Constant Field Values

WEBNAME_PROP

public static final PropertyTag<java.lang.String> WEBNAME_PROP

EMAIL_PROP

public static final PropertyTag<java.lang.String> EMAIL_PROP

SIGNUP_PROP

public static final PropertyTag<java.util.Date> SIGNUP_PROP

IS_ME_PROP

public static final PropertyTag<java.lang.Boolean> IS_ME_PROP

Constructor Detail

PersonFactory

public PersonFactory()

PersonFactory

public PersonFactory(uk.ac.ed.epcc.webapp.AppContext ctx,
             java.lang.String table)

PersonFactory

public PersonFactory(uk.ac.ed.epcc.webapp.AppContext ctx)

Method Detail

normaliseName

public java.lang.String normaliseName(java.lang.String name)

findByWebName

public P findByWebName(java.lang.String name)
                               throws uk.ac.ed.epcc.webapp.jdbc.exception.DataException

Overrides:

findByWebName in class uk.ac.ed.epcc.webapp.session.AppUserFactory<P extends Person>

Throws:

uk.ac.ed.epcc.webapp.jdbc.exception.DataException

findByName

public P findByName(java.lang.String name)

Specified by:

findByName in interface uk.ac.ed.epcc.webapp.model.NameFinder<P extends Person>

Specified by:

findByName in interface uk.ac.ed.epcc.webapp.model.ParseFactory<P extends Person>

getDataCache

public uk.ac.ed.epcc.webapp.model.data.DataCache<java.lang.String,P> getDataCache()

Specified by:

getDataCache in interface uk.ac.ed.epcc.webapp.model.NameFinder<P extends Person>

makeByName

public P makeByName(java.lang.String name)
                            throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

Specified by:

makeByName in interface uk.ac.ed.epcc.webapp.model.NameFinder<P extends Person>

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

makeFromWebName

public P makeFromWebName(java.lang.String name)

Overrides:

makeFromWebName in class uk.ac.ed.epcc.webapp.session.AppUserFactory<P extends Person>

makeFromWebName

public P makeFromWebName(java.lang.String name,
                boolean forceCreate)

allowSelfRegister

public boolean allowSelfRegister()

Overrides:

allowSelfRegister in class uk.ac.ed.epcc.webapp.session.ExtAuthAppUserFactory<P extends Person>

makeBDO

protected uk.ac.ed.epcc.webapp.model.data.DataObject makeBDO(uk.ac.ed.epcc.webapp.model.data.Repository.Record res)
                                                      throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

Overrides:

makeBDO in class uk.ac.ed.epcc.webapp.session.ExtAuthAppUserFactory<P extends Person>

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

makeToggleMap

public java.util.Map<java.lang.String,java.lang.Boolean> makeToggleMap()

Overrides:

makeToggleMap in class uk.ac.ed.epcc.webapp.session.AppUserFactory<P extends Person>

getOrder

protected java.util.List<uk.ac.ed.epcc.webapp.jdbc.filter.OrderClause> getOrder()

Overrides:

getOrder in class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory<P extends Person>

setStaticAccessors

protected void setStaticAccessors(MultiFinder finder,
                      AccessorMap<P> map2)

Extension point to allow programmatic modifications to the AccessorMap in sub-classes

Parameters:

finder -

map2 -

getFinder

public PropertyFinder getFinder()

Description copied from interface: PropertyTargetFactory

Produce a PropertyFinder that can find any of the PropertyTags that can be specified for the objects generated by this type. The PropertyFinder may also contain additional PropertyTags as well.

Specified by:

getFinder in interface PropertyContainerParseTarget<P extends Person>

Specified by:

getFinder in interface PropertyTargetFactory

Returns:

PropertyFinder

hasProperty

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

Description copied from interface: PropertyTargetFactory

Check if the specified property is defined. All properties that return true MUST be in the set returned by the getFinder call but this test can be more stringent and can omit a property if none of the produced objects can generate the specified property.

Specified by:

hasProperty in interface PropertyTargetFactory

Returns:

boolean

getAccessorMap

protected AccessorMap<P> getAccessorMap()

getTableTransitionRegistry

public final uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionRegistry getTableTransitionRegistry()

Specified by:

getTableTransitionRegistry in interface uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget

makeTableRegistry

protected PersonFactory.PersonTableRegistry makeTableRegistry()

resetStructure

public void resetStructure()

Specified by:

resetStructure in interface uk.ac.ed.epcc.webapp.jdbc.table.TableStructureTransitionTarget

getTableTransitionID

public java.lang.String getTableTransitionID()

Specified by:

getTableTransitionID in interface uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget

getGlobals

public PropertyMap getGlobals(java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: ClassificationParseTarget

extract global properties from post parameters.

Specified by:

getGlobals in interface ClassificationParseTarget<P extends Person>

Returns:

PropertyMap

makeOnUpload

protected boolean makeOnUpload()

Control if new records should be made when seen in an parse

Returns:

make

public P make(PropertyContainer value)
                      throws AccountingParseException

Description copied from interface: ClassificationParseTarget

Returns an uncommitted object updated to match the input container. This is either a new object or an existing object selected using the key properties.

Specified by:

make in interface ClassificationParseTarget<P extends Person>

Throws:

AccountingParseException

Returns:

new or existing object

endParse

public java.lang.StringBuilder endParse()

Description copied from interface: PropertyContainerParseTarget

Complete a batch parse.

Specified by:

endParse in interface PropertyContainerParseTarget<P extends Person>

Returns:

StringBuilder containing any status report

parse

public boolean parse(DerivedPropertyMap map,
            java.lang.String currentLine)
              throws AccountingParseException

Description copied from interface: PropertyContainerParseTarget

Parse a text line into a DerivedPropertyMap. This will add derived definitions as well as terminal data values.

Specified by:

parse in interface PropertyContainerParseTarget<P extends Person>

Throws:

AccountingParseException

Parameters:

map - DerivedPropertyMap to be populated

Returns:

true if ok false if this line should be skipped without error

splitRecords

public java.util.Iterator<java.lang.String> splitRecords(java.lang.String update)
                                                  throws AccountingParseException

Description copied from interface: PropertyContainerParseTarget

split update text into a series of lines.

Specified by:

splitRecords in interface PropertyContainerParseTarget<P extends Person>

Throws:

AccountingParseException

Returns:

Iterator

startParse

public void startParse(PropertyMap defaults)
                throws java.lang.Exception

Description copied from interface: PropertyContainerParseTarget

Start a batch parse. This allocates any temporary state. 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 PropertyContainerParseTarget<P extends Person>

Throws:

java.lang.Exception

Parameters:

defaults - PropertyMap of default global properties

getParser

public PropertyContainerParser getParser()

Description copied from interface: PlugInOwner

get the PropertyContainerParser used for the initial parse stage

Specified by:

getParser in interface PlugInOwner

Returns:

PropertyContainerParser

getPolicies

public java.util.Set<PropertyContainerPolicy> getPolicies()

Description copied from interface: PlugInOwner

Get a set of PropertyContainerPolicy to be applied to the property stream.

Specified by:

getPolicies in interface PlugInOwner

Returns:

Set of policies

getDerivedProperties

public PropExpressionMap getDerivedProperties()

Description copied from interface: PlugInOwner

Get a set of derived properties (defined as a PropExpressionMap) that should be implemented by the record.

Specified by:

getDerivedProperties in interface PlugInOwner

Returns:

PropExpressionMap

getTarget

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

Specified by:

getTarget in interface uk.ac.ed.epcc.webapp.model.data.reference.IndexedProducer<P extends Person>

Specified by:

getTarget in interface uk.ac.ed.epcc.webapp.Targetted<P extends Person>

Overrides:

getTarget in class uk.ac.ed.epcc.webapp.session.ExtAuthAppUserFactory<P extends Person>

find

public P find(PropertyMap template)
                      throws uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException,
                             uk.ac.ed.epcc.webapp.jdbc.exception.DataException

Throws:

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

uk.ac.ed.epcc.webapp.jdbc.exception.DataException

getFilter

public <R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<P> getFilter(PropExpression<R> expr,
                                                           uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition match,
                                                           R value)
                                                                        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<P extends Person>

Throws:

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

Type Parameters:

R - type of prop-expression

Parameters:

expr - expression to match

match - kind of match

value - to math against

Returns:

SQLFilter

getNullFilter

public <R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<P> getNullFilter(PropExpression<R> 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<P extends Person>

Throws:

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

Type Parameters:

R - type of prop-expression

Parameters:

expr - expression to match

is_null - match if null when true

Returns:

Filter

getPeriodFilter

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

Description copied from interface: ExpressionFilterTarget

Generate an overlap filter

Specified by:

getPeriodFilter in interface ExpressionFilterTarget<P extends Person>

Throws:

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

Parameters:

period - Period to overlap

start - start property

end - end property

type - OverlapType

cutoff - maximum length of records zero if not known

Returns:

Filter

getOrderFilter

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

Specified by:

getOrderFilter in interface ExpressionFilterTarget<P extends Person>

Throws:

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

getSQLExpression

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

Specified by:

getSQLExpression in interface ExpressionTargetFactory<P extends Person>

Throws:

InvalidSQLPropertyException

getDefaultTableSpecification

public uk.ac.ed.epcc.webapp.jdbc.table.TableSpecification getDefaultTableSpecification(uk.ac.ed.epcc.webapp.AppContext c,
                                                                              java.lang.String table)

Overrides:

getDefaultTableSpecification in class uk.ac.ed.epcc.webapp.session.AppUserFactory<P extends Person>

compatible

public <I> boolean compatible(PropExpression<I> expr)

Description copied from interface: ExpressionTargetGenerator

Check if the expression is compatible with this class. A false value indicates no record can ever evaluate the expression. For example if it includes properties that are not generated by the class.

Specified by:

compatible in interface ExpressionTargetGenerator<P extends Person>

Returns:

boolean

getRelationFilter

public <R> uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<P> 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<P extends Person>

Throws:

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

Returns:

Filter

getFilter

protected uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter<P> getFilter(RecordSelector selector)
                                                                           throws uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Get a filter from a RecordSelector

Throws:

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

Parameters:

selector -

Returns:

compatible

public final boolean compatible(RecordSelector sel)

Description copied from interface: PropertyTargetGenerator

Is the RecordSelector compatible with this class. This method will return false if it the selector is fundamentally incompatible with the properties supported by the class and no records can match the selector. It does NOT check if any matching records exist.

Specified by:

compatible in interface PropertyTargetGenerator<P extends Person>

Returns:

boolean

getIterator

public final java.util.Iterator<P> getIterator(RecordSelector sel)
                                                       throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                                                              uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Description copied from interface: PropertyTargetGenerator

Get an Iterator over selected records.

Specified by:

getIterator in interface PropertyTargetGenerator<P extends Person>

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

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

Parameters:

sel - RecordSelector to select data

Returns:

Iterator over selected records

getIterator

public final java.util.Iterator<P> getIterator(RecordSelector sel,
                                int skip,
                                int count)
                                                       throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                                                              uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Description copied from interface: PropertyTargetGenerator

Get an Iterator over selected records.

Specified by:

getIterator in interface PropertyTargetGenerator<P extends Person>

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

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

Parameters:

sel - RecordSelector to select data

skip - Number of initial records in sequence to skip

count - MAximum number of records to return

Returns:

Iterator over selected records

getRecordCount

public final long getRecordCount(RecordSelector selector)
                          throws java.lang.Exception

Description copied from interface: PropertyTargetGenerator

get the number of records matching the selector

Specified by:

getRecordCount in interface PropertyTargetGenerator<P extends Person>

Throws:

java.lang.Exception

Returns:

number o matches

getValues

public final <PT> java.util.Set<PT> getValues(PropertyTag<PT> tag,
                               RecordSelector selector)
                                  throws uk.ac.ed.epcc.webapp.jdbc.exception.DataException,
                                         InvalidPropertyException,
                                         uk.ac.ed.epcc.webapp.jdbc.expr.CannotFilterException

Description copied from interface: PropertyTargetGenerator

Gets the distinct property values for the set of records identified by the RecordSelector

Specified by:

getValues in interface PropertyTargetGenerator<P extends Person>

Throws:

uk.ac.ed.epcc.webapp.jdbc.exception.DataException

InvalidPropertyException

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

Parameters:

tag - the data_tag

selector - the selector

Returns:

Set of property values

getInput

public uk.ac.ed.epcc.webapp.model.data.forms.inputs.DataObjectItemInput<P> getInput(RecordSelector sel)
                                                                                            throws java.lang.Exception

Specified by:

getInput in interface FilterSelector<uk.ac.ed.epcc.webapp.model.data.forms.inputs.DataObjectItemInput<P extends Person>>

Throws:

java.lang.Exception

release

public void release()

Overrides:

release in class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory<P extends Person>