com.progress.open4gl

Class ProDataGraph

java.lang.Object

com.progress.open4gl.ProDataGraph

All Implemented Interfaces:

commonj.sdo.DataGraph, java.io.Externalizable, java.io.Serializable, org.eclipse.emf.common.notify.Adapter

public class ProDataGraph
extends java.lang.Object
implements commonj.sdo.DataGraph, org.eclipse.emf.common.notify.Adapter, java.io.Externalizable

Maps to either a 4GL DataSet, DataSet-Handle, Temp-Table, or Table-Handle parameter in a Java client. It implements the Java SDO DataGraph interface. We made a number of changes to the ProDataGraph class to enable java serialization. 1) Previously, this class extended DataGraphImpl. However, because of the way java serialization is implemented in DataGraphImpl, it is not intended to be used as a base class. Rather than extending DataGraphImpl, we instead implement the DataGraph interfaces and have an instance of DataGraphImpl as a member that we delegate to. This allows successful serialization of the DataGraphImpl as it has not been extended. 2) We now provide implementations of readObject() and writeObject() to control the java serialization of this class. 3) Serialization of the ProDataGraphMetaData is done separately from the serialization of the DataGraphImpl. This is because the type information from the metadata is needed to be able to deserialize the DataGraphImpl. As a result, on deserialization, the metadata information is read first, then creation of the types is done with the method createTypesFromMetadata(), and finally the datagraph can be recreated.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.emf.common.notify.Adapter

org.eclipse.emf.common.notify.Adapter.Internal

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	DATASET_TYPE_NAME

Constructor Summary

Constructors

Constructor and Description
ProDataGraph() Default constructor
ProDataGraph(commonj.sdo.DataGraph dg, java.lang.String dgName, ProDataRelationMetaData[] dataRelList) Converts the specified DataGraph object into a ProDataGraph object.
ProDataGraph(ProDataGraph dg) Creates a copy of the specified ProDataGraph object, without the data
ProDataGraph(ProDataGraphMetaData metadata) Creates a ProDataGraph object based on the specified metadata.

Method Summary

Modifier and Type	Method and Description
void	acceptChanges() Clears out the change list in the ProChangeSummary.
void	addProDataObject(int index, ProDataObject dataObj) Adds ProDataObject instance at specified index in its ProDataObject collection within ProDataGraph.
void	addProDataObject(ProDataObject dataObj) Adds ProDataObject instance to end of its ProDataObject collection within ProDataGraph.
ProDataObject	createProDataObject(java.lang.String tableName) Returns a new ProDataObject
commonj.sdo.DataObject	createRootObject(java.lang.String namespaceURI, java.lang.String typeName)
commonj.sdo.DataObject	createRootObject(commonj.sdo.Type type)
commonj.sdo.ChangeSummary	getChangeSummary()
commonj.sdo.DataGraph	getDataGraph()
org.eclipse.emf.ecore.resource.Resource	getDataGraphResource()
ProDataGraphMetaData	getMetaData()
int	getNumTables()
ProChangeSummary	getProChangeSummary()
java.lang.String	getProDataGraphName()
java.util.List<ProDataObject>	getProDataObjects(int tableIdx) Get the list of rows in a table
java.util.List<ProDataObject>	getProDataObjects(java.lang.String tableName) Get the list of rows in a table
org.eclipse.emf.ecore.resource.ResourceSet	getResourceSet()
commonj.sdo.DataObject	getRootObject()
int	getTableIndex(java.lang.String tableName)
java.lang.String[]	getTableNames()
org.eclipse.emf.common.notify.Notifier	getTarget()
commonj.sdo.Type	getType(java.lang.String namespaceURI, java.lang.String typeName)
boolean	hasError()
boolean	isAdapterForType(java.lang.Object type)
void	notifyChanged(org.eclipse.emf.common.notify.Notification message)
void	readExternal(java.io.ObjectInput in) Deserialize a ProDataGraph
void	readFromStream(java.io.InputStream stream) Populate a datagraph from a stream This method is used by BPM
void	readXML(java.lang.String fileName) readXML() copies data from file into a temp file.
void	readXMLUnsafe(java.lang.String fileName) readXMLUnsafe() copies data from file into a temp file.
void	setChildTableReferences() Use this to build ProDataGraph object with data relations.
void	setChildTableReferences(int parentIx) Use this to build ProDataGraph object with data relations.
void	setChildTableReferences(java.lang.String tableName) Use this to build ProDataGraph object with data relations.
void	setResourceSet(org.eclipse.emf.ecore.resource.ResourceSet newResourceSet)
void	setTarget(org.eclipse.emf.common.notify.Notifier target)
void	writeExternal(java.io.ObjectOutput out) Serialize a ProDataGraph
void	writeToStream(java.io.OutputStream stream) Write a representation of the dataset to a stream This method is used by BPM
void	writeXML(java.lang.String fileName) Serialize a ProDataGraph in XML
void	writeXML(java.lang.StringBuilder builder) Serialize a ProDataGraph into XML and sends output to StringBuilder.

Methods inherited from class java.lang.Object

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

Field Detail

DATASET_TYPE_NAME

protected final transient java.lang.String DATASET_TYPE_NAME

See Also:

Constant Field Values

Constructor Detail

ProDataGraph

public ProDataGraph()

Default constructor

ProDataGraph

public ProDataGraph(ProDataGraphMetaData metadata)
             throws ProDataException

Creates a ProDataGraph object based on the specified metadata.

Parameters:

metadata - metadata used to create ProDataGraph

Throws:

ProDataException

ProDataGraph

public ProDataGraph(commonj.sdo.DataGraph dg,
                    java.lang.String dgName,
                    ProDataRelationMetaData[] dataRelList)
             throws java.lang.Exception,
                    ProDataException,
                    Open4GLException

Converts the specified DataGraph object into a ProDataGraph object. In the DataGraph's DataObject hierarchy, if a parent-child relationship exists between 2 DataObjects (or temp-tables), a ProDataRelationMetaData object must be provided in the ProDataRelationMetaData array that describes that relationship.

Parameters:

dg - Input DataGraph object

dgName - Name for newly created ProDataGraph

dataRelList - List of parent-child relationships

Throws:

java.lang.Exception

ProDataException

Open4GLException

ProDataGraph

public ProDataGraph(ProDataGraph dg)
             throws ProDataException,
                    java.lang.Exception,
                    Open4GLException

Creates a copy of the specified ProDataGraph object, without the data

Parameters:

dg - ProDataGraph object to copy

Throws:

ProDataException

java.lang.Exception

Open4GLException

Method Detail

getProChangeSummary

public ProChangeSummary getProChangeSummary()

Returns:

ProChangeSummary object associated with this ProDataGraph.

getProDataGraphName

public java.lang.String getProDataGraphName()

Returns:

Name of ProDataGraph

getNumTables

public int getNumTables()

Returns:

The number of ProDataObject collections (temp-tables) in this ProDataGraph object.

getMetaData

public ProDataGraphMetaData getMetaData()

Returns:

The ProDataGraphMetaData object

acceptChanges

public void acceptChanges()

Clears out the change list in the ProChangeSummary. Same behavior as the ChangeSummary.beginLogging().

hasError

public boolean hasError()

Returns:

True if AppServer returned error message for ProDataGraph, else False - returned from AppServer.

createProDataObject

public ProDataObject createProDataObject(java.lang.String tableName)
                                  throws Open4GLException

Returns a new ProDataObject

Parameters:

tableName - Specified table within the ProDataGraph

Returns:

Newly created ProDataObject instance (row) for tableName.

Throws:

Open4GLException

addProDataObject

public void addProDataObject(ProDataObject dataObj)
                      throws Open4GLException

Adds ProDataObject instance to end of its ProDataObject collection within ProDataGraph.

Parameters:

dataObj - ProDataObject to add

Throws:

Open4GLException

addProDataObject

public void addProDataObject(int index,
                             ProDataObject dataObj)
                      throws Open4GLException

Adds ProDataObject instance at specified index in its ProDataObject collection within ProDataGraph.

Parameters:

index - 0-based location

dataObj - ProDataObject to add

Throws:

Open4GLException

getProDataObjects

public java.util.List<ProDataObject> getProDataObjects(int tableIdx)
                                                throws java.lang.Exception

Get the list of rows in a table

Parameters:

tableIdx - 0-based table index within ProDataGraph

Returns:

List of ProDataObject objects (instance data) for the specified tableIdx

Throws:

java.lang.Exception

getProDataObjects

public java.util.List<ProDataObject> getProDataObjects(java.lang.String tableName)
                                                throws java.lang.Exception,
                                                       Open4GLException

Get the list of rows in a table

Parameters:

tableName -

Returns:

List of ProDataObject objects (instance data) for specified tableName

Throws:

java.lang.Exception

Open4GLException

getTableIndex

public int getTableIndex(java.lang.String tableName)
                  throws Open4GLException

Parameters:

tableName -

Returns:

Throws:

Open4GLException

getTableNames

public java.lang.String[] getTableNames()

Returns:

String array of the table names of the ProDataObject collections in this ProDataGraph object.

setChildTableReferences

public void setChildTableReferences()
                             throws java.lang.Exception

Use this to build ProDataGraph object with data relations. It creates all the references (or relationship info) for each ProDataRelationMetaData. Once done, ProDataObject methods getChildRows() and getParentRow() can be used.

Throws:

java.lang.Exception

setChildTableReferences

public void setChildTableReferences(java.lang.String tableName)
                             throws Open4GLException,
                                    java.lang.Exception

Use this to build ProDataGraph object with data relations. It creates all the references (or relationship info) for each ProDataRelationMetaData where tableName is parent table. Once done, ProDataObject methods getChildRows() and getParentRow() can be used.

Parameters:

tableName - the parent's table name

Throws:

Open4GLException

java.lang.Exception

setChildTableReferences

public void setChildTableReferences(int parentIx)
                             throws Open4GLException,
                                    java.lang.Exception

Use this to build ProDataGraph object with data relations. It creates all the references (or relationship info) for each ProDataRelationMetaData where the specified table is parent table. Once this is done, ProDataObject methods getChildRows() and getParentRow() can be used.

Parameters:

parentIx - 0-based parent table index

Throws:

Open4GLException

java.lang.Exception

getDataGraph

public commonj.sdo.DataGraph getDataGraph()

Returns:

getResourceSet

public org.eclipse.emf.ecore.resource.ResourceSet getResourceSet()

Returns:

setResourceSet

public void setResourceSet(org.eclipse.emf.ecore.resource.ResourceSet newResourceSet)

Parameters:

newResourceSet -

getDataGraphResource

public org.eclipse.emf.ecore.resource.Resource getDataGraphResource()

Returns:

getTarget

public org.eclipse.emf.common.notify.Notifier getTarget()

Specified by:

getTarget in interface org.eclipse.emf.common.notify.Adapter

isAdapterForType

public boolean isAdapterForType(java.lang.Object type)

Specified by:

isAdapterForType in interface org.eclipse.emf.common.notify.Adapter

notifyChanged

public void notifyChanged(org.eclipse.emf.common.notify.Notification message)

Specified by:

notifyChanged in interface org.eclipse.emf.common.notify.Adapter

setTarget

public void setTarget(org.eclipse.emf.common.notify.Notifier target)

Specified by:

setTarget in interface org.eclipse.emf.common.notify.Adapter

createRootObject

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

Specified by:

createRootObject in interface commonj.sdo.DataGraph

createRootObject

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

Specified by:

createRootObject in interface commonj.sdo.DataGraph

getChangeSummary

public commonj.sdo.ChangeSummary getChangeSummary()

Specified by:

getChangeSummary in interface commonj.sdo.DataGraph

getType

public commonj.sdo.Type getType(java.lang.String namespaceURI,
                                java.lang.String typeName)

Specified by:

getType in interface commonj.sdo.DataGraph

getRootObject

public commonj.sdo.DataObject getRootObject()

Specified by:

getRootObject in interface commonj.sdo.DataGraph

writeXML

public void writeXML(java.lang.String fileName)
              throws ProDataException,
                     java.io.IOException

Serialize a ProDataGraph in XML

Parameters:

fileName -

Throws:

java.io.IOException - Writes the ProDataGraph's data into a temp file. Then creates the file specified by fileName and merges into it the contents of the temp file along with the schema

ProDataException

writeXML

public void writeXML(java.lang.StringBuilder builder)
              throws ProDataException,
                     java.io.IOException

Serialize a ProDataGraph into XML and sends output to StringBuilder.

Throws:

ProDataException

java.io.IOException

readXMLUnsafe

public void readXMLUnsafe(java.lang.String fileName)
                   throws java.io.FileNotFoundException,
                          ProDataException,
                          java.io.IOException

readXMLUnsafe() copies data from file into a temp file. This is so that we can comment out the schema element after we read it. We do this because SDOUtil.loadDataGraph() throws an exception when it encounters the schema element. This perform an unsafe read of the XML document potentially exposing the user to exploits. This allows external DTD and external schema. Don't use this, this is here as a backdoor in case you absolutely are relying on external schema elements.

Throws:

java.io.FileNotFoundException

ProDataException

java.io.IOException

readXML

public void readXML(java.lang.String fileName)
             throws java.io.FileNotFoundException,
                    ProDataException,
                    java.io.IOException

readXML() copies data from file into a temp file. This is so that we can comment out the schema element after we read it. We do this because SDOUtil.loadDataGraph() throws an exception when it encounters the schema element.

Throws:

java.io.FileNotFoundException

ProDataException

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException

Deserialize a ProDataGraph

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in -

Throws:

java.io.IOException

readFromStream

public void readFromStream(java.io.InputStream stream)
                    throws java.io.IOException

Populate a datagraph from a stream This method is used by BPM

Parameters:

stream -

Throws:

java.io.IOException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Serialize a ProDataGraph

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out -

Throws:

java.io.IOException

writeToStream

public void writeToStream(java.io.OutputStream stream)
                   throws java.io.IOException

Write a representation of the dataset to a stream This method is used by BPM

Parameters:

stream -

Throws:

java.io.IOException