Package de.wwu.scdh.annotation.selection.resource

Class MappedDOMResource

java.lang.Object

de.wwu.scdh.annotation.selection.resource.DOMResource

de.wwu.scdh.annotation.selection.resource.MappedDOMResource

All Implemented Interfaces:

MappedResource<net.sf.saxon.s9api.XdmNode,net.sf.saxon.s9api.XdmValue,net.sf.saxon.s9api.XdmNode,net.sf.saxon.s9api.XdmNode>, Resource<net.sf.saxon.s9api.XdmNode>, S9ApiResource<net.sf.saxon.s9api.XdmNode>

public class MappedDOMResource
extends DOMResource
implements MappedResource<net.sf.saxon.s9api.XdmNode,net.sf.saxon.s9api.XdmValue,net.sf.saxon.s9api.XdmNode,net.sf.saxon.s9api.XdmNode>

A MappedResource mapping two DOMResources to each other. The mapping is based on attributes and text node wrappers, that are in libtrace.xsl and its internal replacements.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<net.sf.saxon.s9api.XdmNode,List<net.sf.saxon.s9api.XdmNode>>	forwardMap
static final String	ID_XPATH
protected Map<String,net.sf.saxon.s9api.XdmNode>	idToPreimageNode
protected Map<net.sf.saxon.s9api.XdmNode,net.sf.saxon.s9api.XdmNode>	reverseMap
static final String	TRACKING_ATTRIBUTE
static final String	TRACKING_NAMESPACE
static final String	TRACKING_PREFIX
static final String	TRACKING_XPATH

Constructor Summary

Constructors

Constructor	Description
MappedDOMResource(DOMResource preimage)	Make a MappedDOMResource from a DOMResource which is used as the preimage.
MappedDOMResource(URI uri, net.sf.saxon.s9api.XdmNode document, net.sf.saxon.s9api.Processor processor)	Create a new MappedDOMResource.

Method Summary

Modifier and Type	Method	Description
List<net.sf.saxon.s9api.XdmNode>	getCorrespondingInImage(net.sf.saxon.s9api.XdmNode preimageNode)	For a given part in the preimage, this returns the corresponding part in the image.
Optional<net.sf.saxon.s9api.XdmNode>	getCorrespondingInPreimage(net.sf.saxon.s9api.XdmNode imageNode)	For a given part in the image, this returns the corresponding part in the preimage.
XdmValueResource	getImage()	Returns the image.
URL	getMappingResource()	Return an URL to a stylesheet for mapping;
protected static Optional<String>	getNodeTrace(net.sf.saxon.s9api.XdmNode node, String xpath)	Get the node ID of the given node.
protected void	leaveTraces()	Prepare mapping writing node identifiers into DOM level 3 user data and setting up idToPreimageNode.
protected void	readTraces()	Make the mappings forwardMap and reverseMap by iterating over the items in the image, i.e., its contents, and read the DOM level 3 user data in there.
void	setImage(XdmValueResource image)	Set the image DOMResource.

Methods inherited from class de.wwu.scdh.annotation.selection.resource.DOMResource

fromHTML, fromHTML, fromXML, fromXML, fromXMLwithXerces, fromXMLwithXerces, getContents, getProcessor, getUri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.wwu.scdh.annotation.selection.Resource

getContents, getUri

Field Details

TRACKING_NAMESPACE

public static final String TRACKING_NAMESPACE

See Also:

• Constant Field Values

TRACKING_PREFIX

public static final String TRACKING_PREFIX

See Also:

• Constant Field Values

TRACKING_ATTRIBUTE

public static final String TRACKING_ATTRIBUTE

See Also:

• Constant Field Values

TRACKING_XPATH

public static final String TRACKING_XPATH

See Also:

• Constant Field Values

ID_XPATH

public static final String ID_XPATH

See Also:

• Constant Field Values

idToPreimageNode

protected Map<String,net.sf.saxon.s9api.XdmNode> idToPreimageNode

forwardMap

protected Map<net.sf.saxon.s9api.XdmNode,List<net.sf.saxon.s9api.XdmNode>> forwardMap

reverseMap

protected Map<net.sf.saxon.s9api.XdmNode,net.sf.saxon.s9api.XdmNode> reverseMap

Constructor Details

MappedDOMResource

public MappedDOMResource(DOMResource preimage)
                  throws ResourceException

Make a MappedDOMResource from a DOMResource which is used as the preimage.

Throws:

ResourceException

MappedDOMResource

public MappedDOMResource(URI uri,
 net.sf.saxon.s9api.XdmNode document,
 net.sf.saxon.s9api.Processor processor)
                  throws ResourceException

Create a new MappedDOMResource.

Parameters:

uri - a URI identifying the resource

document - the document node (root node)

processor - a Saxon Processor that was used by the document builder

Throws:

ResourceException

Method Details

setImage

public void setImage(XdmValueResource image)
              throws ResourceException

Set the image DOMResource.

Throws:

ResourceException

getImage

public XdmValueResource getImage()

Returns the image.

Specified by:

getImage in interface MappedResource<net.sf.saxon.s9api.XdmNode,net.sf.saxon.s9api.XdmValue,net.sf.saxon.s9api.XdmNode,net.sf.saxon.s9api.XdmNode>

leaveTraces

protected void leaveTraces()
                    throws ResourceException

Prepare mapping writing node identifiers into DOM level 3 user data and setting up idToPreimageNode.

Throws:

ResourceException

readTraces

protected void readTraces()
                   throws ResourceException

Make the mappings forwardMap and reverseMap by iterating over the items in the image, i.e., its contents, and read the DOM level 3 user data in there.

Throws:

ResourceException

getCorrespondingInPreimage

public Optional<net.sf.saxon.s9api.XdmNode> getCorrespondingInPreimage(net.sf.saxon.s9api.XdmNode imageNode)

For a given part in the image, this returns the corresponding part in the preimage.

Specified by:

getCorrespondingInPreimage in interface MappedResource<net.sf.saxon.s9api.XdmNode,net.sf.saxon.s9api.XdmValue,net.sf.saxon.s9api.XdmNode,net.sf.saxon.s9api.XdmNode>

getCorrespondingInImage

public List<net.sf.saxon.s9api.XdmNode> getCorrespondingInImage(net.sf.saxon.s9api.XdmNode preimageNode)

For a given part in the preimage, this returns the corresponding part in the image. Since the image may contain multiple copies of the same part of the preimage, a list of parts is returned.

Specified by:

getCorrespondingInImage in interface MappedResource<net.sf.saxon.s9api.XdmNode,net.sf.saxon.s9api.XdmValue,net.sf.saxon.s9api.XdmNode,net.sf.saxon.s9api.XdmNode>

getNodeTrace

protected static Optional<String> getNodeTrace(net.sf.saxon.s9api.XdmNode node,
 String xpath)
                                        throws ResourceException

Get the node ID of the given node.

Throws:

ResourceException

getMappingResource

public URL getMappingResource()

Return an URL to a stylesheet for mapping;