uk.ac.ed.epcc.webapp.model

Class TextFileOverlay<T extends TextFileOverlay.TextFile>

java.lang.Object

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

uk.ac.ed.epcc.webapp.model.TextFileOverlay<T>

Type Parameters:

T -

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>

Direct Known Subclasses:

XMLOverlay

public class TextFileOverlay<T extends TextFileOverlay.TextFile>
extends DataObjectFactory<T>

TextFileOverlay represents a DB overlay above the local file-system intended to allow overrides of file contents to be stored in the database. Resources are indexed by two strings group-name and file-name the combination of which should be unique.

For the file-system representation of a resource the parent directory is located by using the group name as a configuration parameter. (Non absolute directory paths are relative to the application root. Multiple search directories can be specified as a comma seperated list

When a resource is requested it is first looked up in the database. If it does not exist (or the contents are null) then the file-system resource is retrieved. otherwise the DB contents are retrieved.

All lookups cause a DB entry with null contents will be created to register that resource for form updates. The update form always populates with the value a lookup would return but it only stores a value if this differs from the file-system value.

The create method is used to create database only entries. For example to add entries to a location within the application war-file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TextFileOverlay.ExistsValidator Check we are only creating a new entry and one where no matching file already exists.
static class	TextFileOverlay.TextFile
class	TextFileOverlay.TextFileCreator Create a database only TextFile object
class	TextFileOverlay.TextFileDiffAction
static class	TextFileOverlay.TextFileRevertAction
static class	TextFileOverlay.TextFileUpdateAction
class	TextFileOverlay.TextFileUpdator

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	GROUP
protected static java.lang.String	NAME
protected static java.lang.String	TEXT

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
TextFileOverlay(AppContext c)
TextFileOverlay(AppContext c, java.lang.String table)

Method Summary

Modifier and Type	Method and Description
FilterResult<T>	allbyGroup(java.lang.String groupName)
TextFileOverlay.TextFile	find(java.lang.String group, java.lang.String name)
java.net.URL	getBaseURL()
protected TableSpecification	getDefaultTableSpecification(AppContext c, java.lang.String table) Get the default table specification if the table is to be created.
FormCreator	getFormCreator(AppContext c) Create a default FormCreator for the target object The form may be customised according to the requesting AppUser
FormUpdate<T>	getFormUpdate(AppContext c) produce a FormUpdate for the target type appropriate for the requesting user
protected java.lang.String	getInitialCreateText() Generates initial text to use when creating.
protected java.util.List<OrderClause>	getOrder()
protected static java.io.InputStream	getResourceStream(AppContext conn, java.lang.String group, java.lang.String name)
protected java.util.Map<java.lang.String,Selector>	getSelectors() Get a Map of selectors to use for forms of this type.
protected static java.lang.String	getStringFromStream(AppContext conn, java.io.InputStream stream)
java.lang.Class<T>	getTarget() Get a bound on the type of object produced by this factory for run-time checking.
protected T	makeBDO(Repository.Record res) Construct a new Blank DataObject of the correct Class This method takes a Record as an argument.
void	setBaseURL(java.net.URL base)
protected java.lang.String[]	splitNormalised(java.lang.String input) Normalise and split input.

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, getDestFilter, getExcludeFilter, getFieldConstraints, getFieldHelp, getFilter, getFilter, getFilter, getFinalSelectFilter, getFinalTableSpecification, getFindFilter, getID, getIndex, getInput, getInput, getInput, getLogger, getMaxIdentifierLength, getNullable, getOptional, getProperty, getReferenced, getReferenceFieldType, getReferenceFieldType, getRemoteFilter, getRemoteSQLFilter, getResult, getResult, getSelectFilter, getSelector, getSelector, getSupress, getTableSpecification, getTableStructureContributers, getTag, getTranslations, getUniqueIdName, hasComposite, hashCode, isMine, isMine, isMyReference, isValid, makeBDO, makeObject, makeRecord, makeReference, makeReference, matches, narrowSelector, narrowSelector, observeComposite, 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

GROUP

protected static final java.lang.String GROUP

See Also:

Constant Field Values

NAME

protected static final java.lang.String NAME

See Also:

Constant Field Values

TEXT

protected static final java.lang.String TEXT

See Also:

Constant Field Values

Constructor Detail

TextFileOverlay

public TextFileOverlay(AppContext c,
                       java.lang.String table)

TextFileOverlay

public TextFileOverlay(AppContext c)

Method Detail

getStringFromStream

protected static java.lang.String getStringFromStream(AppContext conn,
                                                      java.io.InputStream stream)
                                               throws java.io.IOException

Throws:

java.io.IOException

getResourceStream

protected static java.io.InputStream getResourceStream(AppContext conn,
                                                       java.lang.String group,
                                                       java.lang.String name)

find

public TextFileOverlay.TextFile find(java.lang.String group,
                                     java.lang.String name)
                              throws DataFault

Throws:

DataFault

makeBDO

protected 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 TextFileOverlay.TextFile>

Parameters:

res - Record to create object from

Returns:

new object of correct class.

Throws:

DataFault

setBaseURL

public void setBaseURL(java.net.URL base)

getBaseURL

public java.net.URL getBaseURL()

splitNormalised

protected java.lang.String[] splitNormalised(java.lang.String input)

Normalise and split input. Used for diff operations.

Parameters:

input -

Returns:

getFormUpdate

public FormUpdate<T> getFormUpdate(AppContext c)

Description copied from interface: FormUpdateProducer

produce a FormUpdate for the target type appropriate for the requesting user

Specified by:

getFormUpdate in interface FormUpdateProducer<T extends TextFileOverlay.TextFile>

Overrides:

getFormUpdate in class DataObjectFactory<T extends TextFileOverlay.TextFile>

Parameters:

c - AppContext

Returns:

FormUpdate or null

getDefaultTableSpecification

protected TableSpecification getDefaultTableSpecification(AppContext c,
                                                          java.lang.String table)

Description copied from class: DataObjectFactory

Get the default table specification if the table is to be created. A null result means that a default specification is not available and the table will not be created.

Overrides:

getDefaultTableSpecification in class DataObjectFactory<T extends TextFileOverlay.TextFile>

Parameters:

c - AppContext

table - String table name.

Returns:

null or TableSpecification

allbyGroup

public FilterResult<T> allbyGroup(java.lang.String groupName)
                           throws DataFault

Throws:

DataFault

getInitialCreateText

protected java.lang.String getInitialCreateText()

Generates initial text to use when creating.

Returns:

getFormCreator

public FormCreator getFormCreator(AppContext c)

Description copied from interface: FormCreatorProducer

Create a default FormCreator for the target object The form may be customised according to the requesting AppUser

Specified by:

getFormCreator in interface FormCreatorProducer

Overrides:

getFormCreator in class DataObjectFactory<T extends TextFileOverlay.TextFile>

Parameters:

c - AppContext

Returns:

FormCreator or null;

getSelectors

protected java.util.Map<java.lang.String,Selector> getSelectors()

Description copied from class: DataObjectFactory

Get a Map of selectors to use for forms of this type. This method provides a class specific set of defaults but the specific form classes can override this.

Overrides:

getSelectors in class DataObjectFactory<T extends TextFileOverlay.TextFile>

Returns:

Map

See Also:

DataObjectFormFactory

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 TextFileOverlay.TextFile>

Specified by:

getTarget in interface Targetted<T extends TextFileOverlay.TextFile>

Overrides:

getTarget in class DataObjectFactory<T extends TextFileOverlay.TextFile>

Returns:

Class object for return type

getOrder

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

Overrides:

getOrder in class DataObjectFactory<T extends TextFileOverlay.TextFile>