uk.ac.ed.epcc.webapp.editors.xml

Interface XMLTarget

All Superinterfaces:

Contexed

All Known Implementing Classes:

AbstractXMLTarget, XMLOverlay.TemplateTarget

public interface XMLTarget
extends Contexed

Interface representing the target of XML edit transitions This represents both the Document being edited and a target position in that document. Note that edits may result in changes to the location paths of children/siblings of the edit location so XMLTargets (including child/parent objects) should be discarded and re-aquired after each edit operation.

Method Summary

Modifier and Type	Method and Description
boolean	canView(SessionService<?> sess) Can the current person view this target.
void	commit() commits any change to the document
org.w3c.dom.Document	getDocument() get the Document being edited
XMLTarget	getRootTarget() Get the XMLTarget corresponding to the Document root element.
org.w3c.dom.Node	getTargetNode() Get the Node referenced by the target path.
java.util.LinkedList<java.lang.String>	getTargetPath() Get the target path selected
XMLTargetFactory	getXMLTargetFactory() Get the XMLTargetFactory for this object.

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

getContext

Method Detail

getXMLTargetFactory

XMLTargetFactory getXMLTargetFactory()

Get the XMLTargetFactory for this object.

Returns:

XMLTargetFactory

getDocument

org.w3c.dom.Document getDocument()

get the Document being edited

Returns:

Document

getRootTarget

XMLTarget getRootTarget()

Get the XMLTarget corresponding to the Document root element.

Returns:

XMLTarget

getTargetPath

java.util.LinkedList<java.lang.String> getTargetPath()

Get the target path selected

Returns:

LinkedList

getTargetNode

org.w3c.dom.Node getTargetNode()

Get the Node referenced by the target path.

Returns:

Node

canView

boolean canView(SessionService<?> sess)

Can the current person view this target.

Parameters:

sess -

Returns:

boolean

commit

void commit()
     throws java.lang.Exception

commits any change to the document

Throws:

java.lang.Exception