org.plasma.sdo

Interface PlasmaDataGraph

All Superinterfaces:

DataGraph, Serializable

All Known Implementing Classes:

CoreDataGraph

public interface PlasmaDataGraph
extends DataGraph

Implementation specific extensions to SDO data graph API.

A data graph is used to package a graph of data objects along with their metadata, that is, data describing the data. A data graph also contains a change summary which is used to record changes made to the objects in the graph.

Method Summary

Modifier and Type	Method and Description
void	accept(PlasmaDataGraphEventVisitor visitor) Begin breadth-first traversal of this DataGraph, the given visitor receiving various events for each graph node traversed.
void	accept(PlasmaDataGraphVisitor visitor) Begin breadth-first traversal of this DataGraph, the given visitor receiving "visit" events for each graph node traversed.
void	acceptDepthFirst(PlasmaDataGraphVisitor visitor) Begin depth-first traversal of this DataGraph, the given visitor receiving "visit" events for each graph node traversed.
String	asXml() Traverses, serializes and returns the data graph formatted as XML.
String	dump() Traverses, serializes and returns the data graph in an internal text format useful for debugging.
String	dumpDepthFirst() Traverses the data graph depth first, serializing and returning the data graph in an internal text format useful for debugging.
Object	getId() Returns an object to be used and managed by client Data Access Services as an identifier for a Data Graph.
String	getPath(DataObject dataObject) Calculates and returns the path to the given Data Object relative to the Data Graph root.
UUID	getUUID() Returns the UUID for this data graph, which is the same UUID used for the root Data Object.
String	getUUIDAsString() Returns the UUID for this data graph, which is the same UUID used for the root Data Object, as a character string.
DataObject	removeRootObject() Detaches and returns the root data object of this data graph.
void	setId(Object id) Sets an object to be used and managed by client Data Access Services as an identifier for a Data Graph.

Methods inherited from interface commonj.sdo.DataGraph

createRootObject, createRootObject, getChangeSummary, getRootObject, getType

Method Detail

getUUID

UUID getUUID()

Returns the UUID for this data graph, which is the same UUID used for the root Data Object.

Returns:

the UUID for this data graph, which is the same UUID used for the root Data Object.

getUUIDAsString

String getUUIDAsString()

Returns the UUID for this data graph, which is the same UUID used for the root Data Object, as a character string.

Returns:

the UUID for this data graph, which is the same UUID used for the root Data Object, as a character string.

setId

void setId(Object id)

Sets an object to be used and managed by client Data Access Services as an identifier for a Data Graph.

Parameters:

id - the identifier

getId

Object getId()

Returns an object to be used and managed by client Data Access Services as an identifier for a Data Graph.

Returns:

the identifier

removeRootObject

DataObject removeRootObject()

Detaches and returns the root data object of this data graph.

Returns:

the root data object.

See Also:

DataObject.getDataGraph()

getPath

String getPath(DataObject dataObject)

Calculates and returns the path to the given Data Object relative to the Data Graph root.

Parameters:

dataObject - the target Data Object

Returns:

the path to the given Data Object relative to the Data Graph root.

accept

void accept(PlasmaDataGraphVisitor visitor)

Begin breadth-first traversal of this DataGraph, the given visitor receiving "visit" events for each graph node traversed.

Parameters:

visitor - the graph visitor receiving traversal events

See Also:

DataGraph, DataObject, PlasmaDataGraph, PlasmaDataObject, PlasmaDataGraphVisitor.visit()

acceptDepthFirst

void acceptDepthFirst(PlasmaDataGraphVisitor visitor)

Begin depth-first traversal of this DataGraph, the given visitor receiving "visit" events for each graph node traversed.

Parameters:

visitor - the graph visitor receiving traversal events

See Also:

DataGraph, DataObject, PlasmaDataGraph, PlasmaDataObject, PlasmaDataGraphVisitor.visit()

accept

void accept(PlasmaDataGraphEventVisitor visitor)

Begin breadth-first traversal of this DataGraph, the given visitor receiving various events for each graph node traversed.

Parameters:

visitor - the graph visitor receiving traversal events

See Also:

DataGraph, DataObject, PlasmaDataGraph, PlasmaDataObject, PlasmaDataGraphEventVisitor.start(), PlasmaDataGraphEventVisitor.end()

asXml

String asXml()
      throws IOException

Traverses, serializes and returns the data graph formatted as XML.

Returns:

the data graph formatted as XML

Throws:

IOException

dump

String dump()

Traverses, serializes and returns the data graph in an internal text format useful for debugging.

Returns:

the data graph in an internal text format useful for debugging

dumpDepthFirst

String dumpDepthFirst()

Traverses the data graph depth first, serializing and returning the data graph in an internal text format useful for debugging.

Returns:

the data graph in an internal text format useful for debugging