com.goldencode.p2j.util

Class LegacyJavaAppserver

java.lang.Object

com.goldencode.p2j.util.LegacyJavaAppserver

All Implemented Interfaces:

LegacyJavaAppserverApi

Direct Known Subclasses:

LegacyJavaAppserverClient

public class LegacyJavaAppserver
extends java.lang.Object
implements LegacyJavaAppserverApi

The legacy Java Open Client for appserver relies on Tuscany SDO to create an in-memory DataSet. This class provides helper APIs which do not map on Tuscany SDO existing APIs, and also additional APIs to connect to the FWD appserver and perform calls.

This will be extended as more features of Java Open Client are required.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	defaultTrackChanges Flag indicating if the change logging is tracked by default, for all tables created.
private static NanoTimer	JAVA_PARAM Instrumentation for getJavaParameter(int, int, java.lang.Object, java.lang.Object).
private static java.util.Map<java.lang.Integer,java.lang.Class<?>>	legacyTypes Mapping of an integer type to the BaseDataType type.
private boolean	normalizedExtent Flag indicating if the extent fields are normalized or denormalized (expanded).
private static NanoTimer	OUTPUT_PARAM Instrumentation for getOutputParameter(com.goldencode.p2j.util.LegacyJavaAppserverParameter).
private static java.util.Map<java.lang.Integer,java.lang.String>	paramModes Map of integer modes to their string representation in FWD.
private static NanoTimer	TABLE_META Instrumentation for addTableMetaData(commonj.sdo.DataObject, commonj.sdo.DataObject).
private static java.util.Map<java.lang.Class<?>,java.lang.Integer>	types2Legacy Mapping of a BaseDataType type to its numeric type.
private boolean	useSchemaMarshalNone Flag indicating that the temp-table schema can be omitted during serialization, as the temp-table is being built from the OpenClient proxy generated code, which is always compatible with the target's table.

Fields inherited from interface com.goldencode.p2j.util.LegacyJavaAppserverApi

INPUT, INPUT_OUTPUT, OUTPUT, TYPE_BLOB, TYPE_CHARACTER, TYPE_CLOB, TYPE_DATASET, TYPE_DATASET_HANDLE, TYPE_DATE, TYPE_DATETIME, TYPE_DATETIMETZ, TYPE_DECIMAL, TYPE_HANDLE, TYPE_INT64, TYPE_INTEGER, TYPE_LOGICAL, TYPE_LONGCHAR, TYPE_MEMPTR, TYPE_RAW, TYPE_RECID, TYPE_ROWID, TYPE_TABLE, TYPE_TABLE_HANDLE, TYPE_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
LegacyJavaAppserver() Implicit contstructor, initialize a Java-style legacy client (with normalizedExtent set to true).
LegacyJavaAppserver(boolean normalizedExtent) Initialize this client, by specifying the extent mode: normalized (for Java-style) or denormalized (for .NET-style).

Method Summary

Modifier and Type	Method and Description
void	addDataObject(commonj.sdo.DataGraph graph, commonj.sdo.DataObject row) Add the specified row to the graph.
void	addDataObject(commonj.sdo.DataObject tableMetaData, commonj.sdo.DataObject row) Add the specified row to the graph.
void	addRelation(commonj.sdo.DataObject metaData, java.lang.String name, java.lang.String parentBuffer, java.lang.String childBuffer, java.lang.String whereString, boolean active, boolean parentId, java.lang.String pairs, boolean fkeyHidden, boolean recursive, boolean nested, boolean reposition) Add a relation to the graph's metadata.
void	addTableMetaData(commonj.sdo.DataObject metaData, commonj.sdo.DataGraph table) Copy the single table from the provided DataGraph to the given graph metadata (i.e.
void	addTableMetaData(commonj.sdo.DataObject metaData, commonj.sdo.DataObject table) Add the specified table metadata to the graph.
void	beginLogging(java.lang.Object changeSummary) Begin the logging for changes in this object.
commonj.sdo.DataGraph	createDataGraph() Create a new graph to hold a dataset.
commonj.sdo.DataGraph	createDataGraph(java.lang.Object metadata) Create a new metadata object to hold the table details.
commonj.sdo.DataObject	createDataObject(commonj.sdo.DataGraph graph, java.lang.String table) Create a new row for the specified table.
commonj.sdo.DataObject	createDataObject(commonj.sdo.DataObject tableMetaData) Create a new row for the specified table.
private DsTableDefinition	createDsTable(java.util.List<commonj.sdo.DataObject> rows, java.util.List<LegacyFieldMetaData> fields, boolean input, boolean output, boolean before) Create a table definition part of a dataset parameter.
commonj.sdo.DataObject	createGraphMetaData(java.lang.String name) Create a metadata object with the specified name.
java.lang.Object	createMemptr(byte[] value) Create a memptr corresponding instance.
commonj.sdo.DataObject	createObjectMetaData(java.lang.String name, int numFields, boolean b4img, int numIndexes, java.lang.String indexes, java.lang.String xmlns, java.lang.String xmlPrefix) Deprecated.
commonj.sdo.DataObject	createObjectMetaData(java.lang.String name, int numFields, boolean b4img, int numIndexes, java.lang.String indexes, java.lang.String xmlns, java.lang.String xmlPrefix, java.lang.String xmlNodeName, java.lang.String errorString) Create an object with a table metadata.
private void	createOutputTable(commonj.sdo.DataGraph graph, DsTableDefinition dst, boolean reuseMetadata, boolean beforeTable) Create and populate a table from the results received from the request.
private void	createOutputTable(commonj.sdo.DataGraph graph, TableWrapper wrapper, boolean reuseMetadata, boolean beforeTable) Create and populate a table from the results received from the request.
private TableResultSet	createTableResultSet(java.util.List<commonj.sdo.DataObject> rows, java.util.List<LegacyFieldMetaData> fields, boolean input, boolean output, boolean before) Serialize the rows and fields in a TableResultSet, to be sent to the remote side.
private java.lang.Object	defaultJavaType(int type, int extent) Create a default BaseDataType value for this field's type.
void	endLogging(java.lang.Object changeSummary) End the logging for changes in this object.
private java.lang.Object	fromJavaType(java.lang.Object value, int type, int extent, boolean output) Convert the given value to a BaseDataType compatible instance.
java.lang.String	getArgumentModes(LegacyJavaAppserverParameter[] paramArray) Get a string representation of the argument's modes.
java.lang.Object[]	getArguments(LegacyJavaAppserverParameter[] paramArray) Resolve the arguments from the given parameter array.
java.util.List<commonj.sdo.DataObject>	getBeforeObjects(commonj.sdo.DataObject tableMeta) Get the before-table rows for this after-table.
byte[]	getBytes(java.lang.Object outputParameter) Get the bytes from the given output parameter, which is a MemoryBuffer.
java.util.List<commonj.sdo.DataObject>	getChangedDataObjects(java.lang.Object changeSummary) Get all the changed objects in this change summary.
commonj.sdo.DataGraph	getChanges(java.lang.Object changeSummary) Get the changes in this change summary, as a graph.
java.lang.Object	getChangeSummary(commonj.sdo.DataGraph graph) Get the change summary object for this graph.
java.util.List<commonj.sdo.DataObject>	getChildRows(commonj.sdo.DataObject row, java.lang.String relation) Get the child rows for this record.
AppServerHelper	getConnection(BootstrapConfig config, java.lang.String account, java.lang.String appServerName, boolean sessionFree, java.lang.String user, java.lang.String pwd, java.lang.String serverInfo) Create a new FWd connection with the specified configuration.
java.lang.String	getDataGraphName(commonj.sdo.DataObject metadata) Get the graph name from the specified metadata, of type graphmetadata.
java.util.List<commonj.sdo.DataObject>	getDataObjects(commonj.sdo.DataGraph graph, int idx) Get all the records for the table on the specified index, in the graph metadata.
java.util.List<commonj.sdo.DataObject>	getDataObjects(commonj.sdo.DataGraph graph, java.lang.String table) Get all the records for the table with the specified name, in this graph.
java.util.List<commonj.sdo.DataObject>	getDataObjects(commonj.sdo.DataObject tableMeta) Get all the records for the specified table.
int	getFieldCount(commonj.sdo.DataObject row) Get the number of fields for a given row.
java.lang.String	getFieldName(commonj.sdo.DataObject row, int i) Get the name of the field on the given index in the metadata.
LegacyFieldMetaData[]	getFields(commonj.sdo.DataObject row) Get the legacy field metadata from the given row.
int	getFieldType(commonj.sdo.DataObject row, int i) Get the type of the field on the given index in the metadata.
java.lang.String	getGraphName(commonj.sdo.DataObject tableMetadata) Get the data graph name for the given table metadata.
java.util.GregorianCalendar	getGregorianCalendar(commonj.sdo.DataObject row, int idx) Get the row's property on the given index as a GregorianCalendar.
java.util.GregorianCalendar	getGregorianCalendar(commonj.sdo.DataObject row, java.lang.String name) Get the row's property as a GregorianCalendar.
LegacyJavaAppserverParameter	getJavaParameter(int mode, int type, int extent, java.lang.Object pvalue, java.lang.Object metadata) Configure a LegacyJavaAppserverParameter with the given details.
LegacyJavaAppserverParameter	getJavaParameter(int mode, int type, java.lang.Object value, java.lang.Object metadata) Configure a LegacyJavaAppserverParameter with the given details.
private LegacyJavaAppserverParameter	getJavaParameterImpl(int mode, int type, int extent, java.lang.Object pvalue, java.lang.Object metadata) Configure a LegacyJavaAppserverParameter with the given details.
commonj.sdo.DataObject	getMetaData(commonj.sdo.DataGraph graph) Get the metadata object for this graph, from the metadata property of the root object.
java.lang.String	getNamespacePrefix(commonj.sdo.DataObject metadata) Get the namespace prefix from the given metadata.
java.lang.String	getNamespaceURI(commonj.sdo.DataObject metadata) Get the namespace URI from the given metadata.
int	getNumTables(commonj.sdo.DataGraph graph) Get the number of tables for a graph.
int	getNumTables(commonj.sdo.DataObject metaData) Get the number of tables for a graph metadata.
java.lang.Object	getOutputParameter(LegacyJavaAppserverParameter param) Determine the output parameter value.
java.lang.Object	getOutputParameter(LegacyJavaAppserverParameter[] paramArray, int i) Determine the output parameter value on the given index.
private java.lang.Object	getOutputParameterImpl(LegacyJavaAppserverParameter param) Determine the output parameter value.
LegacyRelationMetaData	getRelation(commonj.sdo.DataGraph graph, java.lang.String name) Get the relation metadata with the given name.
LegacyRelationMetaData	getRelation(commonj.sdo.DataObject metaData, java.lang.String name) Get the relation metadata with the given name.
LegacyRelationMetaData[]	getRelations(commonj.sdo.DataGraph graph) Get the all relation metadata from the given graph.
LegacyRelationMetaData[]	getRelations(commonj.sdo.DataObject metaData) Get the all relation metadata from the given graph.
private java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getSignature(java.util.List<PropertyDefinition> properties) Get the signature of a table based on the properties list
int	getTableFieldCount(commonj.sdo.DataObject tableMeta) Get the number of fields for the specified table meta.
java.lang.String[]	getTableFieldNames(commonj.sdo.DataObject tableMeta) Get the field names for the specified table meta.
LegacyFieldMetaData[]	getTableFields(commonj.sdo.DataObject tableMetadata) Get the legacy field metadata from the given table's metadata.
int	getTableFieldType(commonj.sdo.DataObject tableMeta, int fieldIndex) Get the field type.
int	getTableFieldType(commonj.sdo.DataObject tableMetadata, java.lang.String fieldName) Get the field type.
int	getTableIndex(commonj.sdo.DataGraph graph, java.lang.String name) Get the table index for a given table name and data graph.
int	getTableIndex(commonj.sdo.DataObject value) Get the table index for a given row or table metadata.
int	getTableIndex(commonj.sdo.DataObject metadata, java.lang.String name) Get the table index for a given table name and data graph metadata.
java.util.List<commonj.sdo.DataObject>	getTableMetaData(commonj.sdo.DataGraph graph) Get the metadata list for all tables.
commonj.sdo.DataObject	getTableMetaData(commonj.sdo.DataGraph graph, java.lang.String table) Get the metadata for the specified table.
commonj.sdo.DataObject	getTableMetaData(commonj.sdo.DataObject metaData, int i) Get the metadata for the table registered on the given index in the graph.
java.lang.String	getTableName(commonj.sdo.DataObject value) Get the table name for a given row or table metadata.
java.lang.String[]	getTableNames(commonj.sdo.DataGraph graph) Get all table names from the given graph.
java.lang.String	getXmlNodeName(commonj.sdo.DataObject metadata) Get the XML node-name from the given metadata.
boolean	isCreated(java.lang.Object changeSummary, commonj.sdo.DataObject object) Check if the given object is newly created.
boolean	isDeleted(java.lang.Object changeSummary, commonj.sdo.DataObject object) Check if the given object has been deleted.
boolean	isMemptr(java.lang.Object outputParameter) Check if the given parameter is a memptr.
boolean	isTableField(commonj.sdo.DataObject tableMetadata, java.lang.String fieldName) Check if this table has a field defined with that name.
void	postProcessArguments(java.lang.Object paramArray, java.lang.Object[] args) Postprocess these arguments - this includes copying state back to the LegacyJavaAppserverParameter instance, for OUTPUT parameters.
java.util.List<commonj.sdo.DataObject>	selectRows(commonj.sdo.DataObject tableMetadata, java.lang.String[] fields, java.lang.Object[] values) Retrieve all rows which have an exact match for the specified fields.
void	setDefaultTrackChanges(boolean trackChanges) Set the defaultTrackChanges flag.
void	setFieldMetaData(commonj.sdo.DataObject metaData, int idx, java.lang.String name, int extent, int type, int order, int xmlMapping) Add a new new field with the specified configuration.
void	setGregorianCalendar(commonj.sdo.DataObject row, int idx, java.util.GregorianCalendar date) Set the field's property on the given index from the GregorianCalendar instance.
void	setNamespacePrefix(commonj.sdo.DataObject metadata, java.lang.String xmlPrefix) Set the namespace prefix for the given metadata.
void	setNamespaceURI(commonj.sdo.DataObject metadata, java.lang.String xmlns) Set the namespace URI for the given metadata.
void	setNormalizedExtent(boolean normalizedExtent) Set the normalizedExtent flag.
void	setXmlNodeName(commonj.sdo.DataObject metadata, java.lang.String xmlNodeName) Set the XML node-name for the given metadata.
private java.lang.Object	toJavaValue(java.lang.Object arg, int type, boolean field, int extent) Convert a BaseDataType instance to a Java value.
void	useSchemaMarshalNone() Mark this connection to not serialize the temp-table schema, as the source and destination always match, for OpenClient proxy calls.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.util.LegacyJavaAppserverApi

blob, character, clob, dataset, datasetHandle, date, datetime, datetimetz, decimal, handle, input, inputOutput, int64, integer, logical, longchar, memptr, output, raw, recid, rowid, table, tableHandle, unknown

Field Detail

TABLE_META

private static final NanoTimer TABLE_META

Instrumentation for addTableMetaData(commonj.sdo.DataObject, commonj.sdo.DataObject).

JAVA_PARAM

private static final NanoTimer JAVA_PARAM

Instrumentation for getJavaParameter(int, int, java.lang.Object, java.lang.Object).

OUTPUT_PARAM

private static final NanoTimer OUTPUT_PARAM

Instrumentation for getOutputParameter(com.goldencode.p2j.util.LegacyJavaAppserverParameter).

legacyTypes

private static final java.util.Map<java.lang.Integer,java.lang.Class<?>> legacyTypes

Mapping of an integer type to the BaseDataType type.

types2Legacy

private static final java.util.Map<java.lang.Class<?>,java.lang.Integer> types2Legacy

Mapping of a BaseDataType type to its numeric type.

paramModes

private static final java.util.Map<java.lang.Integer,java.lang.String> paramModes

Map of integer modes to their string representation in FWD.

defaultTrackChanges

private boolean defaultTrackChanges

Flag indicating if the change logging is tracked by default, for all tables created.

normalizedExtent

private boolean normalizedExtent

Flag indicating if the extent fields are normalized or denormalized (expanded).

useSchemaMarshalNone

private boolean useSchemaMarshalNone

Flag indicating that the temp-table schema can be omitted during serialization, as the temp-table is being built from the OpenClient proxy generated code, which is always compatible with the target's table.

Constructor Detail

LegacyJavaAppserver

public LegacyJavaAppserver()

Implicit contstructor, initialize a Java-style legacy client (with normalizedExtent set to true).

LegacyJavaAppserver

public LegacyJavaAppserver(boolean normalizedExtent)

Initialize this client, by specifying the extent mode: normalized (for Java-style) or denormalized (for .NET-style).

Parameters:

normalizedExtent - The extent mode.

Method Detail

useSchemaMarshalNone

public void useSchemaMarshalNone()

Mark this connection to not serialize the temp-table schema, as the source and destination always match, for OpenClient proxy calls.

setNormalizedExtent

public void setNormalizedExtent(boolean normalizedExtent)

Set the normalizedExtent flag.

Parameters:

normalizedExtent - The extent mode.

setDefaultTrackChanges

public void setDefaultTrackChanges(boolean trackChanges)

Set the defaultTrackChanges flag.

Parameters:

trackChanges - true if all tables need to beginLogging(java.lang.Object).

getDataObjects

public java.util.List<commonj.sdo.DataObject> getDataObjects(commonj.sdo.DataGraph graph,
                                                             int idx)

Get all the records for the table on the specified index, in the graph metadata.

Specified by:

getDataObjects in interface LegacyJavaAppserverApi

Parameters:

graph - The graph.

idx - The table index.

Returns:

The list of rows.

getDataObjects

public java.util.List<commonj.sdo.DataObject> getDataObjects(commonj.sdo.DataGraph graph,
                                                             java.lang.String table)

Get all the records for the table with the specified name, in this graph.

Specified by:

getDataObjects in interface LegacyJavaAppserverApi

Parameters:

graph - The graph.

table - The table name.

Returns:

The list of rows.

getDataObjects

public java.util.List<commonj.sdo.DataObject> getDataObjects(commonj.sdo.DataObject tableMeta)

Get all the records for the specified table.

Specified by:

getDataObjects in interface LegacyJavaAppserverApi

Parameters:

tableMeta - The table metadata.

Returns:

The list of rows.

getBeforeObjects

public java.util.List<commonj.sdo.DataObject> getBeforeObjects(commonj.sdo.DataObject tableMeta)

Get the before-table rows for this after-table.

Specified by:

getBeforeObjects in interface LegacyJavaAppserverApi

Parameters:

tableMeta - The after-table metadata.

Returns:

The list of before-table rows.

getChildRows

public java.util.List<commonj.sdo.DataObject> getChildRows(commonj.sdo.DataObject row,
                                                           java.lang.String relation)

Get the child rows for this record.

Specified by:

getChildRows in interface LegacyJavaAppserverApi

Parameters:

row - The row.

relation - The child relation.

Returns:

The child rows.

getGregorianCalendar

public java.util.GregorianCalendar getGregorianCalendar(commonj.sdo.DataObject row,
                                                        int idx)

Get the row's property on the given index as a GregorianCalendar.

Specified by:

getGregorianCalendar in interface LegacyJavaAppserverApi

Parameters:

row - The row.

idx - The property index.

Returns:

The calendar instance.

setGregorianCalendar

public void setGregorianCalendar(commonj.sdo.DataObject row,
                                 int idx,
                                 java.util.GregorianCalendar date)

Set the field's property on the given index from the GregorianCalendar instance.

Specified by:

setGregorianCalendar in interface LegacyJavaAppserverApi

Parameters:

row - The row.

idx - The property index.

date - The property's value.

getGregorianCalendar

public java.util.GregorianCalendar getGregorianCalendar(commonj.sdo.DataObject row,
                                                        java.lang.String name)

Get the row's property as a GregorianCalendar.

Specified by:

getGregorianCalendar in interface LegacyJavaAppserverApi

Parameters:

row - The row.

name - The property name.

Returns:

The calendar instance.

createDataGraph

public commonj.sdo.DataGraph createDataGraph()

Create a new graph to hold a dataset. It holds just the root graph node.

Specified by:

createDataGraph in interface LegacyJavaAppserverApi

Returns:

A graph with no metadata.

createDataGraph

public commonj.sdo.DataGraph createDataGraph(java.lang.Object metadata)

Create a new metadata object to hold the table details.

Specified by:

createDataGraph in interface LegacyJavaAppserverApi

Parameters:

metadata - The root graph node.

Returns:

The graph metadata object.

createDataObject

public commonj.sdo.DataObject createDataObject(commonj.sdo.DataGraph graph,
                                               java.lang.String table)

Create a new row for the specified table. This row is not attached to the table - use addDataObject(commonj.sdo.DataGraph, commonj.sdo.DataObject) to add it.

Specified by:

createDataObject in interface LegacyJavaAppserverApi

Parameters:

graph - The graph.

table - The table name.

Returns:

A new, empty, row.

createDataObject

public commonj.sdo.DataObject createDataObject(commonj.sdo.DataObject tableMetaData)

Create a new row for the specified table. This row is not attached to the table - use addDataObject(DataObject, DataObject) to add it.

Specified by:

createDataObject in interface LegacyJavaAppserverApi

Parameters:

tableMetaData - The table metadata.

Returns:

The new row.

addDataObject

public void addDataObject(commonj.sdo.DataGraph graph,
                          commonj.sdo.DataObject row)

Add the specified row to the graph.

Specified by:

addDataObject in interface LegacyJavaAppserverApi

Parameters:

graph - The field's

row - The row to add to the table.

addDataObject

public void addDataObject(commonj.sdo.DataObject tableMetaData,
                          commonj.sdo.DataObject row)

Add the specified row to the graph.

Specified by:

addDataObject in interface LegacyJavaAppserverApi

Parameters:

tableMetaData - The table metadata.

row - The row to add to the table.

getTableName

public java.lang.String getTableName(commonj.sdo.DataObject value)

Get the table name for a given row or table metadata.

Specified by:

getTableName in interface LegacyJavaAppserverApi

Parameters:

value - The table row or table metadata.

Returns:

The table name.

getTableIndex

public int getTableIndex(commonj.sdo.DataObject value)

Get the table index for a given row or table metadata.

Specified by:

getTableIndex in interface LegacyJavaAppserverApi

Parameters:

value - The table row or table metadata.

Returns:

The table index, 0-based.

Throws:

java.lang.NullPointerException - If the row is not attached to a table.

getTableIndex

public int getTableIndex(commonj.sdo.DataGraph graph,
                         java.lang.String name)

Get the table index for a given table name and data graph.

Specified by:

getTableIndex in interface LegacyJavaAppserverApi

Parameters:

graph - The data graph.

name - The table name.

Returns:

The table index, 0-based.

Throws:

java.lang.IllegalArgumentException - If the table is not part of this graph.

getTableIndex

public int getTableIndex(commonj.sdo.DataObject metadata,
                         java.lang.String name)

Get the table index for a given table name and data graph metadata.

Specified by:

getTableIndex in interface LegacyJavaAppserverApi

Parameters:

metadata - The graph metadata.

name - The table name.

Returns:

The table index, 0-based.

Throws:

java.lang.IllegalArgumentException - If the table is not part of this graph.

getGraphName

public java.lang.String getGraphName(commonj.sdo.DataObject tableMetadata)

Get the data graph name for the given table metadata.

Specified by:

getGraphName in interface LegacyJavaAppserverApi

Parameters:

tableMetadata - The table metadata.

Returns:

The data graph name or null if the table is not part of a graph.

getTableFields

public LegacyFieldMetaData[] getTableFields(commonj.sdo.DataObject tableMetadata)

Get the legacy field metadata from the given table's metadata.

Specified by:

getTableFields in interface LegacyJavaAppserverApi

Parameters:

tableMetadata - The table metadata.

Returns:

The metadata for all the table's fields, in their definition order.

getFields

public LegacyFieldMetaData[] getFields(commonj.sdo.DataObject row)

Get the legacy field metadata from the given row.

Specified by:

getFields in interface LegacyJavaAppserverApi

Parameters:

row - The row.

Returns:

The metadata for all the table's fields, in their definition order.

getFieldCount

public int getFieldCount(commonj.sdo.DataObject row)

Get the number of fields for a given row.

Specified by:

getFieldCount in interface LegacyJavaAppserverApi

Parameters:

row - The table row.

Returns:

The number of fields as specified in the table metadata.

getTableFieldNames

public java.lang.String[] getTableFieldNames(commonj.sdo.DataObject tableMeta)

Get the field names for the specified table meta.

Specified by:

getTableFieldNames in interface LegacyJavaAppserverApi

Parameters:

tableMeta - The table metadata.

Returns:

The field names.

getTableFieldCount

public int getTableFieldCount(commonj.sdo.DataObject tableMeta)

Get the number of fields for the specified table meta.

Specified by:

getTableFieldCount in interface LegacyJavaAppserverApi

Parameters:

tableMeta - The table metadata.

Returns:

The field count.

getFieldName

public java.lang.String getFieldName(commonj.sdo.DataObject row,
                                     int i)

Get the name of the field on the given index in the metadata.

Specified by:

getFieldName in interface LegacyJavaAppserverApi

Parameters:

row - The table row. Must be attached to a table.

i - The field index.

Returns:

The field's name.

getFieldType

public int getFieldType(commonj.sdo.DataObject row,
                        int i)

Get the type of the field on the given index in the metadata.

Specified by:

getFieldType in interface LegacyJavaAppserverApi

Parameters:

row - The table row. Must be attached to a table.

i - The field index.

Returns:

The field's type.

isTableField

public boolean isTableField(commonj.sdo.DataObject tableMetadata,
                            java.lang.String fieldName)

Check if this table has a field defined with that name.

Specified by:

isTableField in interface LegacyJavaAppserverApi

Parameters:

tableMetadata - The table metadata.

fieldName - The field name.

Returns:

true if there is a field defined with this name.

getTableFieldType

public int getTableFieldType(commonj.sdo.DataObject tableMetadata,
                             java.lang.String fieldName)

Get the field type.

Specified by:

getTableFieldType in interface LegacyJavaAppserverApi

Parameters:

tableMetadata - The table metadata.

fieldName - The field name.

Returns:

The field type.

getTableFieldType

public int getTableFieldType(commonj.sdo.DataObject tableMeta,
                             int fieldIndex)

Get the field type.

Specified by:

getTableFieldType in interface LegacyJavaAppserverApi

Parameters:

tableMeta - The table metadata.

fieldIndex - The field index.

Returns:

See above.

getTableNames

public java.lang.String[] getTableNames(commonj.sdo.DataGraph graph)

Get all table names from the given graph.

Specified by:

getTableNames in interface LegacyJavaAppserverApi

Parameters:

graph - The graph.

Returns:

See above.

getNumTables

public int getNumTables(commonj.sdo.DataGraph graph)

Get the number of tables for a graph.

Specified by:

getNumTables in interface LegacyJavaAppserverApi

Parameters:

graph - The graph.

Returns:

See above.

getNumTables

public int getNumTables(commonj.sdo.DataObject metaData)

Get the number of tables for a graph metadata.

Specified by:

getNumTables in interface LegacyJavaAppserverApi

Parameters:

metaData - The graph metadata.

Returns:

See above.

getMetaData

public commonj.sdo.DataObject getMetaData(commonj.sdo.DataGraph graph)

Get the metadata object for this graph, from the metadata property of the root object.

Specified by:

getMetaData in interface LegacyJavaAppserverApi

Parameters:

graph - The graph.

Returns:

The metadata object.

getTableMetaData

public commonj.sdo.DataObject getTableMetaData(commonj.sdo.DataObject metaData,
                                               int i)

Get the metadata for the table registered on the given index in the graph.

Specified by:

getTableMetaData in interface LegacyJavaAppserverApi

Parameters:

metaData - The graph metadata.

i - The table index.

Returns:

The table metadata.

getTableMetaData

public commonj.sdo.DataObject getTableMetaData(commonj.sdo.DataGraph graph,
                                               java.lang.String table)

Get the metadata for the specified table.

Specified by:

getTableMetaData in interface LegacyJavaAppserverApi

Parameters:

graph - The graph.

table - The table name.

Returns:

The table metadata or null if the table is not part of this graph.

getTableMetaData

public java.util.List<commonj.sdo.DataObject> getTableMetaData(commonj.sdo.DataGraph graph)

Get the metadata list for all tables.

Specified by:

getTableMetaData in interface LegacyJavaAppserverApi

Parameters:

graph - The graph.

Returns:

The metadata for all tables.

createObjectMetaData

@Deprecated
public commonj.sdo.DataObject createObjectMetaData(java.lang.String name,
                                                               int numFields,
                                                               boolean b4img,
                                                               int numIndexes,
                                                               java.lang.String indexes,
                                                               java.lang.String xmlns,
                                                               java.lang.String xmlPrefix)

Deprecated.

Create an object with a table metadata. This object will have the tablemetadata type and is not attached to the graph.

Specified by:

createObjectMetaData in interface LegacyJavaAppserverApi

Parameters:

name - The table's name.

numFields - The number of fields.

b4img - Flag indicating if the table has a BEFORE-IMAGE.

numIndexes - The number of indexes.

indexes - The index specification (TODO: not validated/implemented at this time).

xmlns - The XML namespace (TODO: not validated/implemented at this time).

xmlPrefix - The XML prefix (TODO: not validated/implemented at this time).

Returns:

An object with the table metadata.

createObjectMetaData

public commonj.sdo.DataObject createObjectMetaData(java.lang.String name,
                                                   int numFields,
                                                   boolean b4img,
                                                   int numIndexes,
                                                   java.lang.String indexes,
                                                   java.lang.String xmlns,
                                                   java.lang.String xmlPrefix,
                                                   java.lang.String xmlNodeName,
                                                   java.lang.String errorString)

Create an object with a table metadata. This object will have the tablemetadata type and is not attached to the graph.

Specified by:

createObjectMetaData in interface LegacyJavaAppserverApi

Parameters:

name - The table's name.

numFields - The number of fields.

b4img - Flag indicating if the table has a BEFORE-IMAGE.

numIndexes - The number of indexes.

indexes - The index specification (TODO: not validated/implemented at this time).

xmlns - The XML namespace (TODO: not validated/implemented at this time).

xmlPrefix - The XML prefix (TODO: not validated/implemented at this time).

xmlNodeName - The XML node name (TODO: not validated/implemented at this time).

errorString - The table's ERROR-STRING attribute (TODO: not validated/implemented at this time).

Returns:

An object with the table metadata.

setFieldMetaData

public void setFieldMetaData(commonj.sdo.DataObject metaData,
                             int idx,
                             java.lang.String name,
                             int extent,
                             int type,
                             int order,
                             int xmlMapping)

Add a new new field with the specified configuration.

Specified by:

setFieldMetaData in interface LegacyJavaAppserverApi

Parameters:

metaData - The table metadata, of type tablemetadata. The field will be added to the fields property.

idx - The field's index in the metadata.

name - The field's name.

extent - The field's extent.

type - The legacy type (numeric value based on LegacyJavaAppserver constants.

order - The field's order.

xmlMapping - The field's mapping.

createGraphMetaData

public commonj.sdo.DataObject createGraphMetaData(java.lang.String name)

Create a metadata object with the specified name.

Specified by:

createGraphMetaData in interface LegacyJavaAppserverApi

Parameters:

name - The graph name.

Returns:

The metadata object. Will be attached to a graph via createDataGraph(Object).

addTableMetaData

public void addTableMetaData(commonj.sdo.DataObject metaData,
                             commonj.sdo.DataObject table)

Add the specified table metadata to the graph. This will create a custom type based on the configured fields, so that each row will be created with this type.

Specified by:

addTableMetaData in interface LegacyJavaAppserverApi

Parameters:

metaData - The graph metadata.

table - The table metadata.

addTableMetaData

public void addTableMetaData(commonj.sdo.DataObject metaData,
                             commonj.sdo.DataGraph table)

Copy the single table from the provided DataGraph to the given graph metadata (i.e. attach a table to a data-set).

Specified by:

addTableMetaData in interface LegacyJavaAppserverApi

Parameters:

metaData - The graph metadata.

table - The table representation, in a createDataGraph() format.

getDataGraphName

public java.lang.String getDataGraphName(commonj.sdo.DataObject metadata)

Get the graph name from the specified metadata, of type graphmetadata.

Specified by:

getDataGraphName in interface LegacyJavaAppserverApi

Parameters:

metadata - The metadata.

Returns:

The graph name.

getNamespaceURI

public java.lang.String getNamespaceURI(commonj.sdo.DataObject metadata)

Get the namespace URI from the given metadata.

Specified by:

getNamespaceURI in interface LegacyJavaAppserverApi

Parameters:

metadata - The graph or table metadata.

Returns:

See above.

setNamespaceURI

public void setNamespaceURI(commonj.sdo.DataObject metadata,
                            java.lang.String xmlns)

Set the namespace URI for the given metadata.

Specified by:

setNamespaceURI in interface LegacyJavaAppserverApi

Parameters:

metadata - The graph or table metadata.

xmlns - The namespace URI.

getNamespacePrefix

public java.lang.String getNamespacePrefix(commonj.sdo.DataObject metadata)

Get the namespace prefix from the given metadata.

Specified by:

getNamespacePrefix in interface LegacyJavaAppserverApi

Parameters:

metadata - The graph or table metadata.

Returns:

See above.

setNamespacePrefix

public void setNamespacePrefix(commonj.sdo.DataObject metadata,
                               java.lang.String xmlPrefix)

Set the namespace prefix for the given metadata.

Specified by:

setNamespacePrefix in interface LegacyJavaAppserverApi

Parameters:

metadata - The graph or table metadata.

xmlPrefix - The namespace prefix.

getXmlNodeName

public java.lang.String getXmlNodeName(commonj.sdo.DataObject metadata)

Get the XML node-name from the given metadata.

Specified by:

getXmlNodeName in interface LegacyJavaAppserverApi

Parameters:

metadata - The graph or table metadata.

Returns:

See above.

setXmlNodeName

public void setXmlNodeName(commonj.sdo.DataObject metadata,
                           java.lang.String xmlNodeName)

Set the XML node-name for the given metadata.

Specified by:

setXmlNodeName in interface LegacyJavaAppserverApi

Parameters:

metadata - The graph or table metadata.

xmlNodeName - The XML node name.

getJavaParameter

public LegacyJavaAppserverParameter getJavaParameter(int mode,
                                                     int type,
                                                     java.lang.Object value,
                                                     java.lang.Object metadata)

Configure a LegacyJavaAppserverParameter with the given details.

Specified by:

getJavaParameter in interface LegacyJavaAppserverApi

Parameters:

mode - The parameter mode.

type - The parameter type.

value - The parameter value.

metadata - The parameter metadata (in case of DataSet).

Returns:

A new parameter instance.

getJavaParameter

public LegacyJavaAppserverParameter getJavaParameter(int mode,
                                                     int type,
                                                     int extent,
                                                     java.lang.Object pvalue,
                                                     java.lang.Object metadata)

Configure a LegacyJavaAppserverParameter with the given details.

Specified by:

getJavaParameter in interface LegacyJavaAppserverApi

Parameters:

mode - The parameter mode.

type - The parameter type.

extent - The parameter's extent.

pvalue - The parameter value.

metadata - The parameter metadata (in case of DataSet).

Returns:

A new parameter instance.

getJavaParameterImpl

private LegacyJavaAppserverParameter getJavaParameterImpl(int mode,
                                                          int type,
                                                          int extent,
                                                          java.lang.Object pvalue,
                                                          java.lang.Object metadata)

Configure a LegacyJavaAppserverParameter with the given details.

Parameters:

mode - The parameter mode.

type - The parameter type.

extent - The parameter's extent.

pvalue - The parameter value.

metadata - The parameter metadata (in case of DataSet).

Returns:

A new parameter instance.

getOutputParameter

public java.lang.Object getOutputParameter(LegacyJavaAppserverParameter param)

Determine the output parameter value.

Specified by:

getOutputParameter in interface LegacyJavaAppserverApi

Parameters:

param - The parameter as received from the remote side.

Returns:

The parameter's output value.

getOutputParameterImpl

private java.lang.Object getOutputParameterImpl(LegacyJavaAppserverParameter param)

Determine the output parameter value.

Parameters:

param - The parameter as received from the remote side.

Returns:

The parameter's output value.

getOutputParameter

public java.lang.Object getOutputParameter(LegacyJavaAppserverParameter[] paramArray,
                                           int i)

Determine the output parameter value on the given index.

Specified by:

getOutputParameter in interface LegacyJavaAppserverApi

Parameters:

paramArray - The parameter array.

i - The parameter's index.

Returns:

The parameter's output value.

getArgumentModes

public java.lang.String getArgumentModes(LegacyJavaAppserverParameter[] paramArray)

Get a string representation of the argument's modes.

Specified by:

getArgumentModes in interface LegacyJavaAppserverApi

Parameters:

paramArray - The parameter array.

Returns:

The parameter modes.

getArguments

public java.lang.Object[] getArguments(LegacyJavaAppserverParameter[] paramArray)

Resolve the arguments from the given parameter array.

Specified by:

getArguments in interface LegacyJavaAppserverApi

Parameters:

paramArray - The parameter array.

Returns:

The arguments.

createMemptr

public java.lang.Object createMemptr(byte[] value)

Create a memptr corresponding instance.

Specified by:

createMemptr in interface LegacyJavaAppserverApi

Parameters:

value - The bytes.

Returns:

A MemoryBuffer.

isMemptr

public boolean isMemptr(java.lang.Object outputParameter)

Check if the given parameter is a memptr.

Specified by:

isMemptr in interface LegacyJavaAppserverApi

Parameters:

outputParameter - The parameter.

Returns:

true if the value is a MemoryBuffer.

getBytes

public byte[] getBytes(java.lang.Object outputParameter)

Get the bytes from the given output parameter, which is a MemoryBuffer.

Specified by:

getBytes in interface LegacyJavaAppserverApi

Parameters:

outputParameter - The output parameter.

Returns:

See above.

getConnection

public AppServerHelper getConnection(BootstrapConfig config,
                                     java.lang.String account,
                                     java.lang.String appServerName,
                                     boolean sessionFree,
                                     java.lang.String user,
                                     java.lang.String pwd,
                                     java.lang.String serverInfo)
                              throws NumberedException

Create a new FWd connection with the specified configuration.

Specified by:

getConnection in interface LegacyJavaAppserverApi

Parameters:

config - The configuration for the FWD server connection.

account - The FWD account to authenticate on the remote side.

appServerName - The name of the appserver to which the connection will be established.

sessionFree - true to indicate a session-free operating mode, false to indicate a session-managed operating mode.

user - The username passed to the appserver's connect procedure.

pwd - The password passed to the appserver's connect procedure.

serverInfo - The info passed to the appserver's connect procedure.

Returns:

The helper with the connection result (which was established or not).

Throws:

NumberedException - If there are connection problems.

postProcessArguments

public void postProcessArguments(java.lang.Object paramArray,
                                 java.lang.Object[] args)

Postprocess these arguments - this includes copying state back to the LegacyJavaAppserverParameter instance, for OUTPUT parameters.

Specified by:

postProcessArguments in interface LegacyJavaAppserverApi

Parameters:

paramArray - The parameter array.

args - The returned arguments.

getChanges

public commonj.sdo.DataGraph getChanges(java.lang.Object changeSummary)

Get the changes in this change summary, as a graph.

Specified by:

getChanges in interface LegacyJavaAppserverApi

Parameters:

changeSummary - The change summary.

Returns:

See above.

endLogging

public void endLogging(java.lang.Object changeSummary)

End the logging for changes in this object.

Specified by:

endLogging in interface LegacyJavaAppserverApi

Parameters:

changeSummary - The change summary.

beginLogging

public void beginLogging(java.lang.Object changeSummary)

Begin the logging for changes in this object.

Specified by:

beginLogging in interface LegacyJavaAppserverApi

Parameters:

changeSummary - The change summary.

getChangeSummary

public java.lang.Object getChangeSummary(commonj.sdo.DataGraph graph)

Get the change summary object for this graph.

Specified by:

getChangeSummary in interface LegacyJavaAppserverApi

Parameters:

graph - The graph.

Returns:

See above.

isDeleted

public boolean isDeleted(java.lang.Object changeSummary,
                         commonj.sdo.DataObject object)

Check if the given object has been deleted.

Specified by:

isDeleted in interface LegacyJavaAppserverApi

Parameters:

changeSummary - The change summary.

object - The object.

Returns:

See above.

isCreated

public boolean isCreated(java.lang.Object changeSummary,
                         commonj.sdo.DataObject object)

Check if the given object is newly created.

Specified by:

isCreated in interface LegacyJavaAppserverApi

Parameters:

changeSummary - The change summary.

object - The object.

Returns:

See above.

getChangedDataObjects

public java.util.List<commonj.sdo.DataObject> getChangedDataObjects(java.lang.Object changeSummary)

Get all the changed objects in this change summary.

Specified by:

getChangedDataObjects in interface LegacyJavaAppserverApi

Parameters:

changeSummary - The change summary.

Returns:

See above.

selectRows

public java.util.List<commonj.sdo.DataObject> selectRows(commonj.sdo.DataObject tableMetadata,
                                                         java.lang.String[] fields,
                                                         java.lang.Object[] values)

Retrieve all rows which have an exact match for the specified fields.

Specified by:

selectRows in interface LegacyJavaAppserverApi

Parameters:

tableMetadata - The table metadata.

fields - The field list.

values - The values to be matched.

Returns:

See above.

addRelation

public void addRelation(commonj.sdo.DataObject metaData,
                        java.lang.String name,
                        java.lang.String parentBuffer,
                        java.lang.String childBuffer,
                        java.lang.String whereString,
                        boolean active,
                        boolean parentId,
                        java.lang.String pairs,
                        boolean fkeyHidden,
                        boolean recursive,
                        boolean nested,
                        boolean reposition)

Add a relation to the graph's metadata.

Specified by:

addRelation in interface LegacyJavaAppserverApi

Parameters:

metaData - The graph metadata.

name - The relation name.

parentBuffer - The parent buffer.

childBuffer - The child buffer.

whereString - The where string.

active - Flag indicating if this relation is active.

parentId - Flag indicating if parent-id is used.

pairs - The field pairs, in parent, child format.

fkeyHidden - Flag indicating if fkey-hidden is used.

recursive - Flag indicating if recursive is used.

nested - Flag indicating if nested is used.

reposition - Flag indicating if reposition is used.

getRelation

public LegacyRelationMetaData getRelation(commonj.sdo.DataGraph graph,
                                          java.lang.String name)

Get the relation metadata with the given name.

Specified by:

getRelation in interface LegacyJavaAppserverApi

Parameters:

graph - The data graph.

name - The relation name.

Returns:

The relation metadata, or null if it does not exist.

getRelation

public LegacyRelationMetaData getRelation(commonj.sdo.DataObject metaData,
                                          java.lang.String name)

Get the relation metadata with the given name.

Specified by:

getRelation in interface LegacyJavaAppserverApi

Parameters:

metaData - The graph metadata.

name - The relation name.

Returns:

The relation metadata, or null if it does not exist.

getRelations

public LegacyRelationMetaData[] getRelations(commonj.sdo.DataGraph graph)

Get the all relation metadata from the given graph.

Specified by:

getRelations in interface LegacyJavaAppserverApi

Parameters:

graph - The data graph.

Returns:

The relations metadata.

getRelations

public LegacyRelationMetaData[] getRelations(commonj.sdo.DataObject metaData)

Get the all relation metadata from the given graph.

Specified by:

getRelations in interface LegacyJavaAppserverApi

Parameters:

metaData - The graph metadata.

Returns:

The relations metadata.

createOutputTable

private void createOutputTable(commonj.sdo.DataGraph graph,
                               TableWrapper wrapper,
                               boolean reuseMetadata,
                               boolean beforeTable)

Create and populate a table from the results received from the request.

If defaultTrackChanges is set, then logging is enabled for all rows.

Parameters:

graph - The graph where to add the table.

wrapper - The table data.

reuseMetadata - Flag indicating if the table already exists in the graph.

beforeTable - Flag indicating if this is a before table.

createOutputTable

private void createOutputTable(commonj.sdo.DataGraph graph,
                               DsTableDefinition dst,
                               boolean reuseMetadata,
                               boolean beforeTable)

Create and populate a table from the results received from the request.

If defaultTrackChanges is set, then logging is enabled for all rows.

Parameters:

graph - The graph where to add the table.

dst - The table data.

reuseMetadata - Flag indicating if the table already exists in the graph.

beforeTable - Flag indicating if this is a before table.

defaultJavaType

private java.lang.Object defaultJavaType(int type,
                                         int extent)

Create a default BaseDataType value for this field's type.

Parameters:

type - The field's type.

extent - The field's extent.

Returns:

The default BDT type for this field.

fromJavaType

private java.lang.Object fromJavaType(java.lang.Object value,
                                      int type,
                                      int extent,
                                      boolean output)

Convert the given value to a BaseDataType compatible instance.

Parameters:

value - The Java value.

type - The value's type.

extent - The extent value.

output - Flag indicating OUTPUT mode.

Returns:

See above.

toJavaValue

private java.lang.Object toJavaValue(java.lang.Object arg,
                                     int type,
                                     boolean field,
                                     int extent)

Convert a BaseDataType instance to a Java value.

Parameters:

arg - The value.

type - The value's type.

field - Flag indicating that this call is for a field value.

extent - The extent value.

Returns:

See above.

createDsTable

private DsTableDefinition createDsTable(java.util.List<commonj.sdo.DataObject> rows,
                                        java.util.List<LegacyFieldMetaData> fields,
                                        boolean input,
                                        boolean output,
                                        boolean before)

Create a table definition part of a dataset parameter.

Parameters:

rows - The table rows.

fields - The table fields.

input - Flag indicating if this parameter is in input or input-output mode.

output - Flag indicating if this parameter is in output or input-output mode.

before - Flag indicating if this table is a before-table.

Returns:

A DsTableDefinition instance with the specified metadata and records.

createTableResultSet

private TableResultSet createTableResultSet(java.util.List<commonj.sdo.DataObject> rows,
                                            java.util.List<LegacyFieldMetaData> fields,
                                            boolean input,
                                            boolean output,
                                            boolean before)

Serialize the rows and fields in a TableResultSet, to be sent to the remote side.

Parameters:

rows - The rows.

fields - The fields.

input - Flag indicating INPUT mode.

output - Flag indicating OUTPUT mode.

Returns:

The wrapped rows.

getSignature

private java.util.List<java.util.Map<java.lang.String,java.lang.String>> getSignature(java.util.List<PropertyDefinition> properties)

Get the signature of a table based on the properties list

Parameters:

properties - The properties of the table

Returns:

A list containing each field with its type and extent