uk.ac.ed.epcc.webapp.model.log

Class LogFactory<T extends LogFactory.Entry,O extends Indexed>

java.lang.Object

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

uk.ac.ed.epcc.webapp.model.log.LogFactory<T,O>

Type Parameters:

T - Type of log Entry

O - Type of owning object

All Implemented Interfaces:

Contexed, ContextCached, FormCreatorProducer, FormUpdateProducer<T>, FilterMatcher<T>, TypeConverter<T,java.lang.Number>, DataObjectSelector<T>, Selector<DataObjectItemInput<T>>, Owner<T>, IndexedProducer<T>, Tagged, Targetted<T>

public abstract class LogFactory<T extends LogFactory.Entry,O extends Indexed>
extends DataObjectFactory<T>

general log Entry class. Consists of a series of date-stamped entries of mutable class. Each entry has an operator who added the entry and a integer tag that references an object that implements Indexed and an Owning object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LogFactory.DateFilter Filter LogItems by date
class	LogFactory.EditItemTransition
static class	LogFactory.Entry<L extends Indexed,F extends LogFactory,O extends DataObject> Base class for a log entry
static class	LogFactory.EntryKey
static class	LogFactory.ItemAction<T extends LogFactory.Entry>
class	LogFactory.ItemDateFilter Filter items by owner, type and date range
static class	LogFactory.ItemType<E extends LogFactory.Entry> superclass for the type objects in sub-classes
class	LogFactory.TransitionProvider
class	LogFactory.TypeFilter<L extends Indexed> Filter item by type, date range and link reference

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

DataObjectFactory.AbstractDataObjectInput, DataObjectFactory.AbstractFinder<X>, DataObjectFactory.DataObjectAcceptFilter, DataObjectFactory.DataObjectInput, DataObjectFactory.DataObjectIntegerInput, DataObjectFactory.DestAcceptFilter<T extends DataObject>, DataObjectFactory.FilterAdapter, DataObjectFactory.FilterCounter, DataObjectFactory.FilterExists, DataObjectFactory.FilterIterator, DataObjectFactory.FilterSelector, DataObjectFactory.FilterSet, DataObjectFactory.Finder, DataObjectFactory.MakeRemoteFilterVisitor<R extends DataObject>, DataObjectFactory.MatchFilter, DataObjectFactory.ReferencedAdapter<I extends Indexed>, DataObjectFactory.ReferenceIterator<I extends Indexed>, DataObjectFactory.SortingDataObjectInput, DataObjectFactory.TimeAcceptFilter<T extends DataObject>, DataObjectFactory.TimeFilter

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DATE
static LogFactory.EntryKey	EDIT_ITEM
protected static java.lang.String	LINK_ID
protected static java.lang.String	OPERATOR_ID
protected LogOwner<O>	owner_factory
protected static java.lang.String	OWNER_ID
protected LogFactory.ItemType<T>	use_type
protected AppUserFactory<?>	user_factory

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

AUTO_CREATE_TABLES_FEATURE, COMPOSITES_SUFFIX, REJECT_MULTIPLE_RESULT_FEATURE, res

Constructor Summary

Constructors

Constructor and Description
LogFactory(LogOwner<O> fac, java.lang.String table, AppUserFactory<?> uf)

Method Summary

Modifier and Type	Method and Description
T	find(LogFactory.ItemType.ItemValue v, int link, boolean allow_null) Find and item only by what it points to.
T	find(O owner, LogFactory.ItemType.ItemValue v, int link, boolean allow_null) find an item by owner and value
protected TableSpecification	getDefaultTableSpecification(AppContext c, LogOwner<O> fac, AppUserFactory<?> uf, java.lang.String homeTable)
SQLFilter<T>	getItemFilter(LogFactory.ItemType.ItemValue<T> v)
protected SQLAndFilter<T>	getItemFilter(LogFactory.ItemType.ItemValue v, int link) get a SQL filter to items that point to a particular target.
protected SQLAndFilter<T>	getItemFilter(O q, LogFactory.ItemType.ItemValue v, int link)
protected LogFactory.ItemType<T>	getItemType() Get the final LogFactory.ItemType to use for this class.
CloseableIterator<T>	getLog(O q)
protected java.util.List<OrderClause>	getOrder()
protected LogOwner<O>	getOwnerFactory()
ReferenceFilter<T,O>	getOwnerFilter(O q)
java.util.Set<O>	getOwners(LogFactory.ItemType.ItemValue v, int link) get all owners that reference a particular owner from their log.
protected java.util.Map<java.lang.String,TableSpecification>	getPrereqTables()
protected abstract LogFactory.ItemType<T>	getStaticItemType() Get the most specific non-dynamic LogFactory.ItemType sub-classes override this to generate a statically configured type.
java.lang.Class<T>	getTarget() Get a bound on the type of object produced by this factory for run-time checking.
LogTransitionProvider	getTransitionProvider()
protected T	makeBDO(Repository.Record res) Construct a new Blank DataObject of the correct Class This method takes a Record as an argument.
protected void	observeComposite(Composite c) Observer Composites as they are registered.
void	purge(O q) purge all entries for an owner.
void	purgeOrphan() purge all orphan entries.
protected void	setupItems(AppContext c, java.lang.String table) create LogItem tables that don't have factories.

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

all, allowPreSelect, canCreate, canUpdate, checkComposite, convertToDestinationFilter, customiseForm, equals, exists, find, find, find, find, find, getAllIterator, getComposite, getComposites, getComposites, getConfigTag, getContext, getCount, getDefaultRelationshipFilter, getDefaults, getDefaultTableSpecification, getDestFilter, getExcludeFilter, getFieldConstraints, getFieldHelp, getFilter, getFilter, getFilter, getFinalSelectFilter, getFinalTableSpecification, getFindFilter, getFormCreator, getFormUpdate, getID, getIndex, getInput, getInput, getInput, getLogger, getMaxIdentifierLength, getNullable, getOptional, getProperty, getReferenced, getReferenceFieldType, getReferenceFieldType, getRemoteFilter, getRemoteSQLFilter, getResult, getResult, getSelectFilter, getSelector, getSelector, getSelectors, getSupress, getTableSpecification, getTableStructureContributers, getTag, getTranslations, getUniqueIdName, hasComposite, hashCode, isMine, isMine, isMyReference, isValid, makeBDO, makeObject, makeRecord, makeReference, makeReference, matches, narrowSelector, narrowSelector, OrderBy, postCreateTableSetup, postSetContext, release, restrictDefaultInput, setComposites, setContext, setContext, setContextWithMake, setProperty, toString, updateTable

Methods inherited from class java.lang.Object

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

Field Detail

EDIT_ITEM

public static final LogFactory.EntryKey EDIT_ITEM

OWNER_ID

protected static final java.lang.String OWNER_ID

See Also:

Constant Field Values

LINK_ID

protected static final java.lang.String LINK_ID

See Also:

Constant Field Values

OPERATOR_ID

protected static final java.lang.String OPERATOR_ID

See Also:

Constant Field Values

DATE

protected static final java.lang.String DATE

See Also:

Constant Field Values

owner_factory

protected final LogOwner<O extends Indexed> owner_factory

user_factory

protected final AppUserFactory<?> user_factory

use_type

protected final LogFactory.ItemType<T extends LogFactory.Entry> use_type

Constructor Detail

LogFactory

public LogFactory(LogOwner<O> fac,
                  java.lang.String table,
                  AppUserFactory<?> uf)

Method Detail

setupItems

protected void setupItems(AppContext c,
                          java.lang.String table)

create LogItem tables that don't have factories.

Parameters:

c -

table -

observeComposite

protected void observeComposite(Composite c)

Description copied from class: DataObjectFactory

Observer Composites as they are registered. Note that as this can be called during factory construction no assumptions can be made about factory attribute state. The Composite.preRegister() method needs to be used to set attribute state that is going to be used by this method.

Overrides:

observeComposite in class DataObjectFactory<T extends LogFactory.Entry>

getPrereqTables

protected java.util.Map<java.lang.String,TableSpecification> getPrereqTables()

getDefaultTableSpecification

protected TableSpecification getDefaultTableSpecification(AppContext c,
                                                          LogOwner<O> fac,
                                                          AppUserFactory<?> uf,
                                                          java.lang.String homeTable)

getOwnerFilter

public ReferenceFilter<T,O> getOwnerFilter(O q)

find

public T find(LogFactory.ItemType.ItemValue v,
              int link,
              boolean allow_null)
       throws DataException

Find and item only by what it points to. Only makes sense for a unique target.

Parameters:

v -

link -

allow_null -

Returns:

Entry

Throws:

DataException

find

public T find(O owner,
              LogFactory.ItemType.ItemValue v,
              int link,
              boolean allow_null)
       throws DataException

find an item by owner and value

Parameters:

q -

v -

link -

allow_null -

Returns:

Item

Throws:

DataException

getItemFilter

protected SQLAndFilter<T> getItemFilter(LogFactory.ItemType.ItemValue v,
                                        int link)

get a SQL filter to items that point to a particular target.

Parameters:

v -

link -

Returns:

getItemFilter

protected SQLAndFilter<T> getItemFilter(O q,
                                        LogFactory.ItemType.ItemValue v,
                                        int link)

getOwners

public java.util.Set<O> getOwners(LogFactory.ItemType.ItemValue v,
                                  int link)
                           throws DataException

get all owners that reference a particular owner from their log.

Parameters:

v -

link -

Returns:

Throws:

DataException

getItemType

protected final LogFactory.ItemType<T> getItemType()

Get the final LogFactory.ItemType to use for this class. This can include dynamic additions.

Returns:

getStaticItemType

protected abstract LogFactory.ItemType<T> getStaticItemType()

Get the most specific non-dynamic LogFactory.ItemType sub-classes override this to generate a statically configured type. which is then used to create a per-instance version including dynamic additions.

Returns:

makeBDO

protected final T makeBDO(Repository.Record res)
                   throws DataFault

Description copied from class: DataObjectFactory

Construct a new Blank DataObject of the correct Class This method takes a Record as an argument. This allows the factory to either create different sub-classes depending on a value in the record or to produce objects from different Repositories/tables. We keep the return type as DataObject instead of making it generic as this helps with legacy compatibility a little bit (problem is if we have another generic sub-type between us and a legacy sub-class

Specified by:

makeBDO in class DataObjectFactory<T extends LogFactory.Entry>

Parameters:

res - Record to create object from

Returns:

new object of correct class.

Throws:

DataFault

purge

public final void purge(O q)
                 throws DataFault

purge all entries for an owner.

Parameters:

q -

Throws:

DataFault

purgeOrphan

public final void purgeOrphan()
                       throws DataFault

purge all orphan entries. Only works if the LogOwner is a DataObjectFactory.

Throws:

DataFault

getLog

public CloseableIterator<T> getLog(O q)
                            throws DataFault

Throws:

DataFault

getOwnerFactory

protected final LogOwner<O> getOwnerFactory()

getOrder

protected java.util.List<OrderClause> getOrder()

Overrides:

getOrder in class DataObjectFactory<T extends LogFactory.Entry>

getTransitionProvider

public LogTransitionProvider getTransitionProvider()

getTarget

public java.lang.Class<T> getTarget()

Description copied from class: DataObjectFactory

Get a bound on the type of object produced by this factory for run-time checking. This implements IndexedProducer.getTarget(). Normally this method should be overridden each time we make a sub-class that narrows the produced type. However checks should still pass if the super-type method is retained.

Specified by:

getTarget in interface IndexedProducer<T extends LogFactory.Entry>

Specified by:

getTarget in interface Targetted<T extends LogFactory.Entry>

Overrides:

getTarget in class DataObjectFactory<T extends LogFactory.Entry>

Returns:

Class object for return type

getItemFilter

public SQLFilter<T> getItemFilter(LogFactory.ItemType.ItemValue<T> v)

Parameters:

v -

Returns: