be.re.repo
Interface XMLStorageDelta

All Superinterfaces:

StorageDelta

public interface XMLStorageDelta
extends StorageDelta

The interface for storage implementations that wish to store XML document versions in a delta file.

Author:

Werner Donné

Method Summary

void	read(String vcr, String version, String systemId, InputStream delta, XMLEventWriter out, XMLResolver entityResolver, boolean expand, String mimeType, Context context)
XMLEventReader	read(String vcr, String version, String systemId, InputStream delta, XMLResolver entityResolver, boolean expand, String mimeType, Context context)
void	write(String vcr, String version, XMLEventReader in, InputStream deltaIn, OutputStream deltaOut, String mimeType, Context context)

Methods inherited from interface be.re.repo.StorageDelta

canDeleteIntermediate, delete

Method Detail

read

void read(String vcr,
          String version,
          String systemId,
          InputStream delta,
          XMLEventWriter out,
          XMLResolver entityResolver,
          boolean expand,
          String mimeType,
          Context context)
          throws IOException,
                 XMLStreamException

Parameters:

vcr - the local path of the VCR.

version - the local path of the version.

systemId - can be used to resolve relative URLs.

delta - the inputstream of the delta.

out - the XML-stream into which the result should be written.

entityResolver - a StAX entity resolver.

expand - whether XML-entities and XInclude elements should be expanded in the result.

mimeType - the MIME type of the document.

context - the repository context.

Throws:

IOException

XMLStreamException

read

XMLEventReader read(String vcr,
                    String version,
                    String systemId,
                    InputStream delta,
                    XMLResolver entityResolver,
                    boolean expand,
                    String mimeType,
                    Context context)
                    throws IOException,
                           XMLStreamException

Parameters:

vcr - the local path of the VCR.

version - the local path of the version.

systemId - can be used to resolve relative URLs.

delta - the inputstream of the delta.

entityResolver - a StAX entity resolver.

expand - whether XML-entities and XInclude elements should be expanded in the result.

mimeType - the MIME type of the document.

context - the repository context.

Returns:

The XML-stream from which the result is read.

Throws:

IOException

XMLStreamException

write

void write(String vcr,
           String version,
           XMLEventReader in,
           InputStream deltaIn,
           OutputStream deltaOut,
           String mimeType,
           Context context)
           throws IOException,
                  XMLStreamException

Parameters:

vcr - the local path of the VCR.

version - the local path of the version.

in - the new XML-stream of the version.

deltaIn - the input stream of the current delta.

deltaOut - the outputstream of the updated delta.

mimeType - the MIME type of the document.

context - the repository context.

Throws:

IOException

XMLStreamException