org.apache.isis.core.runtime.snapshot

Class XmlSnapshot

java.lang.Object

org.apache.isis.core.runtime.snapshot.XmlSnapshot

All Implemented Interfaces:

org.apache.isis.applib.services.xmlsnapshot.XmlSnapshotService.Snapshot

public class XmlSnapshot
extends Object
implements org.apache.isis.applib.services.xmlsnapshot.XmlSnapshotService.Snapshot

Traverses object graph from specified root, so that an XML representation of the graph can be returned.

Initially designed to allow snapshots to be easily created.

Typical use:

 XmlSnapshot snapshot = new XmlSnapshot(customer); // where customer is a
 // reference to an
 // ObjectAdapter
 Element customerAsXml = snapshot.toXml(); // returns customer's fields, titles
 // of simple references, number of
 // items in collections
 snapshot.include("placeOfBirth"); // navigates to another object represented by
 // simple reference "placeOfBirth"
 snapshot.include("orders/product"); // navigates to all <tt>Order</tt>s of
 // <tt>Customer</tt>, and from them for
 // their <tt>Product</tt>s
 

Constructor Summary

Constructors

Constructor and Description
XmlSnapshot(ObjectAdapter rootAdapter, OidMarshaller oidMarshaller) Start a snapshot at the root object, using own namespace manager.
XmlSnapshot(ObjectAdapter rootAdapter, XmlSchema schema, OidMarshaller oidMarshaller) Start a snapshot at the root object, using supplied namespace manager.

Method Summary

Methods

Modifier and Type	Method and Description
ObjectAdapter	getObject()
XmlSchema	getSchema()
String	getSchemaLocationFileName() The name of the xsi:schemaLocation in the XML document.
Document	getXmlDocument()
String	getXmlDocumentAsString()
Element	getXmlElement() The root element of getXmlDocument().
Document	getXsdDocument()
String	getXsdDocumentAsString()
Element	getXsdElement() The root element of getXsdDocument().
void	include(String path)
void	include(String path, String annotation)

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlSnapshot

public XmlSnapshot(ObjectAdapter rootAdapter,
           OidMarshaller oidMarshaller)

Start a snapshot at the root object, using own namespace manager.

Parameters:

oidMarshaller - TODO

XmlSnapshot

public XmlSnapshot(ObjectAdapter rootAdapter,
           XmlSchema schema,
           OidMarshaller oidMarshaller)

Start a snapshot at the root object, using supplied namespace manager.

Parameters:

oidMarshaller - TODO

Method Detail

getObject

public ObjectAdapter getObject()

getSchema

public XmlSchema getSchema()

getSchemaLocationFileName

public String getSchemaLocationFileName()

The name of the xsi:schemaLocation in the XML document. Taken from the fullyQualifiedClassName (which also is used as the basis for the targetNamespace. Populated in appendXml(ObjectAdapter).

getXmlDocument

public Document getXmlDocument()

Specified by:

getXmlDocument in interface org.apache.isis.applib.services.xmlsnapshot.XmlSnapshotService.Snapshot

getXmlElement

public Element getXmlElement()

The root element of getXmlDocument(). Returns null until the snapshot has actually been built.

getXsdDocument

public Document getXsdDocument()

Specified by:

getXsdDocument in interface org.apache.isis.applib.services.xmlsnapshot.XmlSnapshotService.Snapshot

getXsdElement

public Element getXsdElement()

The root element of getXsdDocument(). Returns null until the snapshot has actually been built.

include

public void include(String path)

include

public void include(String path,
           String annotation)

getXmlDocumentAsString

public String getXmlDocumentAsString()

Specified by:

getXmlDocumentAsString in interface org.apache.isis.applib.services.xmlsnapshot.XmlSnapshotService.Snapshot

getXsdDocumentAsString

public String getXsdDocumentAsString()

Specified by:

getXsdDocumentAsString in interface org.apache.isis.applib.services.xmlsnapshot.XmlSnapshotService.Snapshot