uk.ac.ed.epcc.webapp.model.xml

Class XMLOverlay<X extends XMLOverlay.XMLFile>

java.lang.Object

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

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

uk.ac.ed.epcc.webapp.model.xml.XMLOverlay<X>

Type Parameters:

X -

All Implemented Interfaces:

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

public class XMLOverlay<X extends XMLOverlay.XMLFile>
extends TextFileOverlay<X>
implements XMLTargetFactory

A TextFileOverlay that validates updates as XML.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	XMLOverlay.TemplateTarget
class	XMLOverlay.XMLEditAction
static class	XMLOverlay.XMLFile
class	XMLOverlay.XMLFileUpdator

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

TextFileOverlay.ExistsValidator, TextFileOverlay.TextFile, TextFileOverlay.TextFileCreator, TextFileOverlay.TextFileDiffAction, TextFileOverlay.TextFileRevertAction, TextFileOverlay.TextFileUpdateAction, 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
static Feature	ACE_EDITOR
static Feature	JQUERY_EDITOR

Fields inherited from class uk.ac.ed.epcc.webapp.model.TextFileOverlay

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

Method Summary

Modifier and Type	Method and Description
boolean	canView(SessionService<?> sess)
XMLTarget	find(java.util.LinkedList<java.lang.String> location) Get the XMLTarget represented by the path.
FormUpdate<X>	getFormUpdate(AppContext c) produce a FormUpdate for the target type appropriate for the requesting user
javax.xml.validation.Schema	getSchema() Get schema to validate against
protected java.util.Map<java.lang.String,Selector>	getSelectors() Get a Map of selectors to use for forms of this type.
java.lang.Class<X>	getTarget() Get a bound on the type of object produced by this factory for run-time checking.
DomVisitor	getValidatingVisitor() Get a DOMVisitor that performs additional (non-schema) validation throwing exceptions that should be added to the schema errors.
protected X	makeBDO(Repository.Record res) Construct a new Blank DataObject of the correct Class This method takes a Record as an argument.
protected java.lang.String[]	splitNormalised(java.lang.String input) Normalise and split input.

Methods inherited from class uk.ac.ed.epcc.webapp.model.TextFileOverlay

allbyGroup, find, getBaseURL, getDefaultTableSpecification, getFormCreator, getInitialCreateText, getOrder, getResourceStream, getStringFromStream, setBaseURL

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

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

getContext

Field Detail

JQUERY_EDITOR

public static final Feature JQUERY_EDITOR

ACE_EDITOR

public static final Feature ACE_EDITOR

Constructor Detail

XMLOverlay

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

XMLOverlay

public XMLOverlay(AppContext c)

Method Detail

getSchema

public javax.xml.validation.Schema getSchema()

Get schema to validate against

Specified by:

getSchema in interface XMLTargetFactory

Returns:

Schema

makeBDO

protected X 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

Overrides:

makeBDO in class TextFileOverlay<X extends XMLOverlay.XMLFile>

Parameters:

res - Record to create object from

Returns:

new object of correct class.

Throws:

DataFault

getTarget

public java.lang.Class<X> 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<X extends XMLOverlay.XMLFile>

Specified by:

getTarget in interface Targetted<X extends XMLOverlay.XMLFile>

Overrides:

getTarget in class TextFileOverlay<X extends XMLOverlay.XMLFile>

Returns:

Class object for return type

canView

public boolean canView(SessionService<?> sess)

find

public XMLTarget find(java.util.LinkedList<java.lang.String> location)

Description copied from interface: XMLTargetFactory

Get the XMLTarget represented by the path.

Specified by:

find in interface XMLTargetFactory

Returns:

XMLTarget

getFormUpdate

public FormUpdate<X> 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<X extends XMLOverlay.XMLFile>

Overrides:

getFormUpdate in class TextFileOverlay<X extends XMLOverlay.XMLFile>

Parameters:

c - AppContext

Returns:

FormUpdate 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 TextFileOverlay<X extends XMLOverlay.XMLFile>

Returns:

Map

See Also:

DataObjectFormFactory

getValidatingVisitor

public DomVisitor getValidatingVisitor()

Description copied from interface: XMLTargetFactory

Get a DOMVisitor that performs additional (non-schema) validation throwing exceptions that should be added to the schema errors.

Specified by:

getValidatingVisitor in interface XMLTargetFactory

Returns:

DOMVisitor or null;

splitNormalised

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

Description copied from class: TextFileOverlay

Normalise and split input. Used for diff operations.

Overrides:

splitNormalised in class TextFileOverlay<X extends XMLOverlay.XMLFile>

Returns: