com.progress.open4gl

Class ProDataRelationMetaData

java.lang.Object

com.progress.open4gl.dynamicapi.DataRelationMetaData

com.progress.open4gl.ProDataRelationMetaData

All Implemented Interfaces:

java.io.Serializable

public class ProDataRelationMetaData
extends DataRelationMetaData

Schema info that defines the relationship between parent and child ProDataObjects within a ProDataGraph. It maps to a DataRelation object in the 4GL DataSet. It names the fields in the parent and child ProDataObjects that form their primary-foreign key relationship.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.progress.open4gl.dynamicapi.DataRelationMetaData

m_ChildIx, m_ChildMetaData, m_ChildRef, m_ChildRefColIdx, m_ExtendedProperties, m_Flag, m_LinkName, m_NumPairs, m_PairsArray, m_PairsIdxArray, m_PairsList, m_ParentIx, m_ParentMetaData, m_ParentRef, m_ParentRefColIdx, m_ParentRows

Constructor Summary

Constructors

Constructor and Description
ProDataRelationMetaData()
ProDataRelationMetaData(ProDataRelationMetaData mdata)
ProDataRelationMetaData(java.lang.String linkname, int parentIx, int childIx, int numPairs, java.lang.String pairsList) Creates ProDataRelationMetaData object
ProDataRelationMetaData(java.lang.String linkname, int parentIx, int childIx, int numPairs, java.lang.String pairsList, int flag, java.lang.String extendedProperties)
ProDataRelationMetaData(java.lang.String linkname, ProDataObjectMetaData parentMetaData, ProDataObjectMetaData childMetaData) Creates ProDataRelationMetaData object

Method Summary

Modifier and Type	Method and Description
void	addSchemaInfoToClass(commonj.sdo.Type[] typeList, ProDataGraphMetaData dgMetaData)
protected void	fillChildRelations(java.util.List<ProDataObject> parentDOList, java.util.List<ProDataObject> childDOList)
int[]	getChildColumns()
protected int	getChildIx()
protected int	getChildRefColIdx()
protected java.lang.String	getExtendedProperties()
protected int	getNumPairs()
int[]	getParentColumns()
protected int	getParentIx()
protected int	getParentRefColIdx()
java.lang.String	getRelationName()
protected boolean	hasLoadedChildren(ProDataObject pdo)
protected void	setChildIx(int value)
void	setColumns(int[] pColIdx, int[] cColIdx) Specifies mulitple indexes for the parent and child ProDataObjects that forms primary-foreign key relationship.
void	setColumns(int pColIdx, int cColIdx) Specifies the index for the parent ProDataObject and child ProDataObject that forms primary-foreign key relationship.
protected void	setExtendedProperties(java.lang.String value)
protected void	setHasLoadedChildren(ProDataObject pdo)
protected void	setNumPairs(int value)
protected void	setParentIx(int value)
protected void	setRelationName(java.lang.String value)
protected void	writeKeyRefXML(org.w3c.dom.Document document, org.w3c.dom.Element outerElement, java.lang.String uniqueIndexName)
protected void	writeRelationXML(org.w3c.dom.Document document, org.w3c.dom.Element appInfoElement)

Methods inherited from class com.progress.open4gl.dynamicapi.DataRelationMetaData

fillChildRelation, getChildFieldList, getChildRef, getChildTable, getFlag, getPair, getPair, getPairIdx, getPairsList, getParentFieldList, getParentRef, getParentTable, isReposition, setFlag, setPairsIndexInfo, setPairsList, setTableIxs, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ProDataRelationMetaData

public ProDataRelationMetaData()

ProDataRelationMetaData

public ProDataRelationMetaData(java.lang.String linkname,
                               ProDataObjectMetaData parentMetaData,
                               ProDataObjectMetaData childMetaData)

Creates ProDataRelationMetaData object

Parameters:

linkname -

parentMetaData - Represents parent ProDataObject

childMetaData - Represents child ProDataObject

ProDataRelationMetaData

public ProDataRelationMetaData(java.lang.String linkname,
                               int parentIx,
                               int childIx,
                               int numPairs,
                               java.lang.String pairsList)

Creates ProDataRelationMetaData object

Parameters:

childIx - 0-based child table index

parentIx - 0-based parent table index

numPairs - Number of column pairs that represent relationship

pairsList - Comma-separated string of all the column pairs where the parent's column name is followed by its matching child's column name.

linkname - Name of Data Relation

ProDataRelationMetaData

public ProDataRelationMetaData(java.lang.String linkname,
                               int parentIx,
                               int childIx,
                               int numPairs,
                               java.lang.String pairsList,
                               int flag,
                               java.lang.String extendedProperties)

ProDataRelationMetaData

public ProDataRelationMetaData(ProDataRelationMetaData mdata)

Method Detail

addSchemaInfoToClass

public void addSchemaInfoToClass(commonj.sdo.Type[] typeList,
                                 ProDataGraphMetaData dgMetaData)

setColumns

public void setColumns(int pColIdx,
                       int cColIdx)
                throws ProDataException

Specifies the index for the parent ProDataObject and child ProDataObject that forms primary-foreign key relationship.

Parameters:

pColIdx - 0-based parent property index

cColIdx - 0-based child property index

Throws:

ProDataException

setColumns

public void setColumns(int[] pColIdx,
                       int[] cColIdx)
                throws ProDataException

Specifies mulitple indexes for the parent and child ProDataObjects that forms primary-foreign key relationship.

Parameters:

pColIdx - Array of 0-based parent property indexes

cColIdx - Array of 0-based child property indexes

Throws:

ProDataException

getParentColumns

public int[] getParentColumns()
                       throws ProDataException

Returns:

The indexes of the parent's columns

Throws:

ProDataException

getChildColumns

public int[] getChildColumns()
                      throws ProDataException

Returns:

The indexes of the child's columns

Throws:

ProDataException

getNumPairs

protected int getNumPairs()

setNumPairs

protected void setNumPairs(int value)

hasLoadedChildren

protected boolean hasLoadedChildren(ProDataObject pdo)

setHasLoadedChildren

protected void setHasLoadedChildren(ProDataObject pdo)

getRelationName

public java.lang.String getRelationName()

Returns:

Data Relation's name

setRelationName

protected void setRelationName(java.lang.String value)

getExtendedProperties

protected java.lang.String getExtendedProperties()

setExtendedProperties

protected void setExtendedProperties(java.lang.String value)

getParentRefColIdx

protected int getParentRefColIdx()

getChildIx

protected int getChildIx()

setChildIx

protected void setChildIx(int value)

getParentIx

protected int getParentIx()

setParentIx

protected void setParentIx(int value)

getChildRefColIdx

protected int getChildRefColIdx()

fillChildRelations

protected void fillChildRelations(java.util.List<ProDataObject> parentDOList,
                                  java.util.List<ProDataObject> childDOList)

Overrides:

fillChildRelations in class DataRelationMetaData

writeRelationXML

protected void writeRelationXML(org.w3c.dom.Document document,
                                org.w3c.dom.Element appInfoElement)

writeKeyRefXML

protected void writeKeyRefXML(org.w3c.dom.Document document,
                              org.w3c.dom.Element outerElement,
                              java.lang.String uniqueIndexName)