org.plasma.sdo.core

Class CoreDataGraph

java.lang.Object

org.plasma.sdo.core.CoreDataGraph

All Implemented Interfaces:

commonj.sdo.DataGraph, Serializable, PlasmaDataGraph

public class CoreDataGraph
extends Object
implements PlasmaDataGraph

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CoreDataGraph()
CoreDataGraph(PlasmaDataObject root)

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.
commonj.sdo.DataObject	createRootObject(String namespaceURI, String typeName) Creates a new root data object of the specified type.
commonj.sdo.DataObject	createRootObject(commonj.sdo.Type type) Returns the root data object of this data graph.
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.
commonj.sdo.ChangeSummary	getChangeSummary() Returns the change summary associated with this data graph.
Object	getId() Returns an object to be used and managed by client Data Access Services as an identifier for a Data Graph.
String	getPath(commonj.sdo.DataObject dataObject) Calculates and returns the path relative to the data-graph root for the given data object.
commonj.sdo.DataObject	getRootObject() Returns the root data object of this data graph.
commonj.sdo.Type	getType(String uri, String typeName) Returns the type with the given the URI, or contained by the resource at the given URI, and with the given name.
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.
commonj.sdo.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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreDataGraph

public CoreDataGraph()

CoreDataGraph

public CoreDataGraph(PlasmaDataObject root)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getUUID

public UUID getUUID()

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

Specified by:

getUUID in interface PlasmaDataGraph

Returns:

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

getUUIDAsString

public String getUUIDAsString()

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

Specified by:

getUUIDAsString in interface PlasmaDataGraph

Returns:

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

setId

public void setId(Object id)

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

Specified by:

setId in interface PlasmaDataGraph

Parameters:

id - the identifier

getId

public Object getId()

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

Specified by:

getId in interface PlasmaDataGraph

Returns:

the identifier

createRootObject

public commonj.sdo.DataObject createRootObject(String namespaceURI,
                                               String typeName)

Creates a new root data object of the specified type. An exception is thrown if a root object exists.

Specified by:

createRootObject in interface commonj.sdo.DataGraph

Parameters:

namespaceURI - namespace of the type.

typeName - name of the type.

Returns:

the new root.

Throws:

IllegalStateException - if the root object already exists.

See Also:

createRootObject(Type), getType(String, String)

createRootObject

public commonj.sdo.DataObject createRootObject(commonj.sdo.Type type)

Returns the root data object of this data graph.

Specified by:

createRootObject in interface commonj.sdo.DataGraph

Returns:

the root data object.

See Also:

DataObject.getDataGraph()

getChangeSummary

public commonj.sdo.ChangeSummary getChangeSummary()

Returns the change summary associated with this data graph.

Specified by:

getChangeSummary in interface commonj.sdo.DataGraph

Returns:

the change summary.

See Also:

ChangeSummary.getDataGraph()

getRootObject

public commonj.sdo.DataObject getRootObject()

Returns the root data object of this data graph.

Specified by:

getRootObject in interface commonj.sdo.DataGraph

Returns:

the root data object.

See Also:

DataObject.getDataGraph()

removeRootObject

public commonj.sdo.DataObject removeRootObject()

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

Specified by:

removeRootObject in interface PlasmaDataGraph

Returns:

the root data object.

See Also:

DataObject.getDataGraph()

getType

public commonj.sdo.Type getType(String uri,
                                String typeName)

Returns the type with the given the URI, or contained by the resource at the given URI, and with the given name.

Specified by:

getType in interface commonj.sdo.DataGraph

Parameters:

uri - the namespace URI of a type or the location URI of a resource containing a type.

typeName - name of a type.

Returns:

the type with the corresponding namespace and name.

getPath

public String getPath(commonj.sdo.DataObject dataObject)

Calculates and returns the path relative to the data-graph root for the given data object.

Specified by:

getPath in interface PlasmaDataGraph

Parameters:

dataObject - the target data object

Returns:

the path string

accept

public void accept(PlasmaDataGraphVisitor visitor)

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

Specified by:

accept in interface PlasmaDataGraph

Parameters:

visitor - the graph visitor receiving traversal events

See Also:

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

acceptDepthFirst

public void acceptDepthFirst(PlasmaDataGraphVisitor visitor)

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

Specified by:

acceptDepthFirst in interface PlasmaDataGraph

Parameters:

visitor - the graph visitor receiving traversal events

See Also:

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

accept

public void accept(PlasmaDataGraphEventVisitor visitor)

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

Specified by:

accept in interface PlasmaDataGraph

Parameters:

visitor - the graph visitor receiving traversal events

See Also:

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

dump

public String dump()

Description copied from interface: PlasmaDataGraph

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

Specified by:

dump in interface PlasmaDataGraph

Returns:

the data graph in an internal text format useful for debugging

dumpDepthFirst

public String dumpDepthFirst()

Description copied from interface: PlasmaDataGraph

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

Specified by:

dumpDepthFirst in interface PlasmaDataGraph

Returns:

the data graph in an internal text format useful for debugging

asXml

public String asXml()
             throws IOException

Description copied from interface: PlasmaDataGraph

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

Specified by:

asXml in interface PlasmaDataGraph

Returns:

the data graph formatted as XML

Throws:

IOException