Package org.dellroad.stuff.pobj

Class PersistentFileTransaction

java.lang.Object

org.dellroad.stuff.pobj.PersistentFileTransaction

public class PersistentFileTransaction
extends Object

Represents an open "transaction" on a PersistentObject's persistent file.

This class is used by PersistentObjectSchemaUpdater and would normally not be used directly.

Constructor Summary

Constructors

Constructor	Description
PersistentFileTransaction(Source source)	Constructor.
PersistentFileTransaction(Source source, TransformerFactory transformerFactory)	Constructor.

Method Summary

Modifier and Type	Method	Description
Document	getData()	Get the current XML data.
String	getSystemId()	Get the system ID of the original source input.
List<String>	getUpdates()	Get the updates list associated with this transaction.
void	setData(Document data)	Change the current XML data.
String	toString()
void	transform(Transformer transformer)	Apply an XSLT transform to the current XML object in this transaction.

Methods inherited from class java.lang.Object

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

Constructor Details

PersistentFileTransaction

public PersistentFileTransaction(Source source)
                          throws IOException,
XMLStreamException

Constructor.

Parameters:

source - XML input

Throws:

PersistentObjectException - if no updates are found

IllegalArgumentException - if source is null

XMLStreamException - if XML parsing fails

IOException - if an I/O error occurs

PersistentFileTransaction

public PersistentFileTransaction(Source source,
 TransformerFactory transformerFactory)
                          throws IOException,
XMLStreamException

Constructor.

Parameters:

source - XML input

transformerFactory - transformer factory, or null for platform default

Throws:

PersistentObjectException - if no updates are found

IllegalArgumentException - if source is null

XMLStreamException - if XML parsing fails

IOException - if an I/O error occurs

Method Details

getData

public Document getData()

Get the current XML data. Does not include the XML update list.

During a schema update the caller may modify the document in place, or invoke setData(org.w3c.dom.Document) to completely replace it.

Returns:

XML data

setData

public void setData(Document data)

Change the current XML data.

This would be invoked by a schema update if it wanted to completely replace the XML document, rather than just modifying it in place.

Parameters:

data - new XML data; does not include the XML update list

getSystemId

public String getSystemId()

Get the system ID of the original source input.

Returns:

XML system ID

getUpdates

public List<String> getUpdates()

Get the updates list associated with this transaction.

Returns:

list of updates

transform

public void transform(Transformer transformer)
               throws TransformerException

Apply an XSLT transform to the current XML object in this transaction.

This is an alternative to modifying the DOM, when XSL is a simpler way to perform the update.

Parameters:

transformer - XSLT transformer

Throws:

IllegalStateException - if the current root object is null

PersistentObjectException - if an error occurs

TransformerException - if the transformation fails

toString

public String toString()

Overrides:

toString in class Object