com.progress.open4gl

Class ProDataObjectMetaData

java.lang.Object

com.progress.open4gl.dynamicapi.MetaDataBase

com.progress.open4gl.dynamicapi.DataObjectMetaData

com.progress.open4gl.ProDataObjectMetaData

All Implemented Interfaces:

java.io.Serializable

public class ProDataObjectMetaData
extends DataObjectMetaData

Allows client to access as well as specify the schema for ProDataObject (temp-table) within a ProDataGraph. It represents a temp-table within a 4GL ProDataSet.

See Also:

Serialized Form

Field Summary

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

m_bufferName, m_flag, m_noSchemaMarshal, m_numFields, m_numIndexes, m_rsmd, m_tableErrorString

Constructor Summary

Constructors

Constructor and Description
ProDataObjectMetaData(java.lang.String tableName, int numFields, boolean bimageFlag, int numIndexes, java.lang.String multiIxCols, java.lang.String xmlNamespace, java.lang.String xmlPrefix) Creates ProDataObjectMetaData (table definition) with specified data.

Method Summary

Modifier and Type	Method and Description
void	addFieldSchemaInfoToClass(commonj.sdo.Type tableType, ProDataGraphMetaData dgmd)
static ProDataObjectMetaData	buildTableFromXML(org.w3c.dom.Element tableElement)
boolean	getBImageFlag()
int	getExtent(int field)
int	getFieldCount()
java.lang.String	getFieldInitialValue(int field)
java.lang.String	getFieldLabel(int field)
java.lang.String	getFieldName(int field)
boolean	getNoSchemaMarshal()
protected int	getNumRefs()
int	getProType(int field)
protected java.lang.String	getTableErrorString()
java.lang.String	getTableName()
int	getUserOrder(int field)
int	getXMLMapping(int field)
protected void	incrNumRefs()
void	setFieldInitialValue(int field, java.lang.String initValue)
void	setFieldLabel(int field, java.lang.String label)
void	setFieldMetaData(int fieldNum, java.lang.String name, int extent, int proType, int userOrder, int xmlMapping) Sets the MetaData for a field of the input ProDataObject.
void	setNoSchemaMarshal(boolean noSchemaMarshal) If flag is set to true, when table's data is marshaled to AppServer, it is sent without schema info (suppresses index descriptions and all field info)
protected void	setTableErrorString(java.lang.String errStr)
protected void	writeAnnotationXML(org.w3c.dom.Document document, org.w3c.dom.Element appInfoElement, ProDataGraphMetaData dgmd)
protected void	writeXML(org.w3c.dom.Document document, org.w3c.dom.Element sequenceElement)
protected void	writeXMLForNonUniqueIndexes(org.w3c.dom.Document document, org.w3c.dom.Element appInfoElement, ProDataGraphMetaData dgmd)
protected void	writeXMLForUniqueIndexes(org.w3c.dom.Document document, org.w3c.dom.Element outerElement)

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

buildIndexesFromXML, findIndex, getColumnCount, getColumnExtent, getFieldExtent, getFieldIndex, getFlag, getFlag, getIndexes, getMultiIndexCols, getNumIndexes, getPrimeUniqueName, getProColumnType, getProFieldType, getResultSetMetaData, hasTableError, print, setFieldDesc, setFieldDesc, setFieldDesc, setFlag, setMultiIndexCols, setNumIndexes, setPrimeUniqueName, validate, validateFld

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

getTypeCode

Methods inherited from class java.lang.Object

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

Constructor Detail

ProDataObjectMetaData

public ProDataObjectMetaData(java.lang.String tableName,
                             int numFields,
                             boolean bimageFlag,
                             int numIndexes,
                             java.lang.String multiIxCols,
                             java.lang.String xmlNamespace,
                             java.lang.String xmlPrefix)

Creates ProDataObjectMetaData (table definition) with specified data.

Parameters:

numFields - Number of fields

bimageFlag - True if BEFORE-TABLE defined in 4GL (for table), else False

tableName - Table name in 4GL

xmlNamespace - Namespace for XML Serialization

xmlPrefix - Prefix for XML Serialization

Method Detail

setFieldMetaData

public void setFieldMetaData(int fieldNum,
                             java.lang.String name,
                             int extent,
                             int proType,
                             int userOrder,
                             int xmlMapping)
                      throws ProDataException

Sets the MetaData for a field of the input ProDataObject.

Parameters:

fieldNum - 1-based field number of the field to set schema for

name - Field's name

extent - Field's extent. If field is not an array field, this should be 0.

proType - Field's data type - one of the PRO_XXX constants supplied by com.progress.open4gl.Parameter.

Throws:

ProDataException

getTableName

public java.lang.String getTableName()

Returns:

Table name

getBImageFlag

public boolean getBImageFlag()

Returns:

BeforeImage value (4GL Table BEFORE-TABLE attribute). If true, table is updateable.

getFieldCount

public int getFieldCount()

Overrides:

getFieldCount in class DataObjectMetaData

Returns:

Number of fields

getNoSchemaMarshal

public boolean getNoSchemaMarshal()

Returns:

True if the table data will not be marshaled with schema info to the AppServer, else it returns False.

setNoSchemaMarshal

public void setNoSchemaMarshal(boolean noSchemaMarshal)

If flag is set to true, when table's data is marshaled to AppServer, it is sent without schema info (suppresses index descriptions and all field info)

Parameters:

noSchemaMarshal - flag

getUserOrder

public int getUserOrder(int field)

Overrides:

getUserOrder in class DataObjectMetaData

Parameters:

field - 0-based field index

Returns:

User order position of specified field

getXMLMapping

public int getXMLMapping(int field)

Overrides:

getXMLMapping in class DataObjectMetaData

getProType

public int getProType(int field)
               throws ProDataException

Parameters:

field - 0-based field index

Returns:

Field's data type (found in com.progress.open4gl.Parameter) for specified field

Throws:

ProDataException

getExtent

public int getExtent(int field)
              throws ProDataException

Parameters:

field - 0-based field index

Returns:

Extent value for specified field. If not an array field, returns 0.

Throws:

ProDataException

getFieldName

public java.lang.String getFieldName(int field)
                              throws ProDataException

Overrides:

getFieldName in class DataObjectMetaData

Parameters:

field - 0-based field index

Returns:

Field's name

Throws:

ProDataException

getFieldLabel

public java.lang.String getFieldLabel(int field)
                               throws ProDataException

Overrides:

getFieldLabel in class DataObjectMetaData

Throws:

ProDataException

setFieldLabel

public void setFieldLabel(int field,
                          java.lang.String label)
                   throws ProDataException

Overrides:

setFieldLabel in class DataObjectMetaData

Throws:

ProDataException

getFieldInitialValue

public java.lang.String getFieldInitialValue(int field)
                                      throws ProDataException

Overrides:

getFieldInitialValue in class DataObjectMetaData

Throws:

ProDataException

setFieldInitialValue

public void setFieldInitialValue(int field,
                                 java.lang.String initValue)
                          throws ProDataException

Overrides:

setFieldInitialValue in class DataObjectMetaData

Throws:

ProDataException

getTableErrorString

protected java.lang.String getTableErrorString()

setTableErrorString

protected void setTableErrorString(java.lang.String errStr)

getNumRefs

protected int getNumRefs()

incrNumRefs

protected void incrNumRefs()

addFieldSchemaInfoToClass

public void addFieldSchemaInfoToClass(commonj.sdo.Type tableType,
                                      ProDataGraphMetaData dgmd)
                               throws ProDataException

Throws:

ProDataException

writeXML

protected void writeXML(org.w3c.dom.Document document,
                        org.w3c.dom.Element sequenceElement)
                 throws ProDataException

Throws:

ProDataException

writeXMLForUniqueIndexes

protected void writeXMLForUniqueIndexes(org.w3c.dom.Document document,
                                        org.w3c.dom.Element outerElement)

writeAnnotationXML

protected void writeAnnotationXML(org.w3c.dom.Document document,
                                  org.w3c.dom.Element appInfoElement,
                                  ProDataGraphMetaData dgmd)

writeXMLForNonUniqueIndexes

protected void writeXMLForNonUniqueIndexes(org.w3c.dom.Document document,
                                           org.w3c.dom.Element appInfoElement,
                                           ProDataGraphMetaData dgmd)

buildTableFromXML

public static ProDataObjectMetaData buildTableFromXML(org.w3c.dom.Element tableElement)
                                               throws ProDataException

Throws:

ProDataException