com.goldencode.p2j.util

Class DataSetSDOHelper

java.lang.Object

com.goldencode.p2j.util.DataSetSDOHelper

class DataSetSDOHelper
extends java.lang.Object

Defines APIs to load DATASETs as Tuscany SDO. This allows compatibility with the legacy Java Open client.

The DataSet is constructed as a DataGraph, for which the metadata has the following structure (each graph node is a DataObject):

• the root object has a graph type, with two properties:
  1. scope, which holds the HelperContext used to build the metadata.
  2. metadata, having the custom graphmetadata type.
• graphmetadata defines the details about the tables and relations, in these properties:
  1. scope, which helps the HelperContext used to build the metadata
  2. name, a String with the DataSet name
  3. xmlns, a String with the XML namespace.
  4. xmlPrefix, a String with the XML prefix.
  5. xmlNodeName, a String with the XML node name.
  6. idSequence, the internal record ID sequence
  7. tables, a list of tablemetadata holding the defined tables
  8. relations, a list of LegacyRelationMetaData holding the defined relations
• tablemetadata defines the details about a table:
  1. idx, an int with the table index in the datagraph's table list.
  2. name, a String with the legacy table name.
  3. numFields, an int with the number of defined fields.
  4. b4img, a boolean flag identifying if a table as a BEFORE-IMAGE.
  5. numIndexes, an int identifying the number of defined indexes.
  6. indexes, a String with the index definitions.
  7. xmlns, a String with the XML namespace.
  8. xmlPrefix, a String with the XML prefix.
  9. xmlNodeName, a String with the XML node name.
  10. errorString, a String with the table's ERROR-STRING attribute value.
  11. tabletype, a Type defining this table (used to add rows to the table). This type MUST extend the baserowtype, so that the rows know their container.
  12. fields, a list with the field definitions, of LegacyFieldMetaData type.
  13. rows, a list with the table's rows (they have as type a custom type build based on the table'sfields. The base type is baserowtype, an empty type.
  14. beforeRows, a list with the before-table's rows, with the same record type as the rows list. These are created/managed only when logging is enabled.
  15. normalizedExtent, flag indicating if the extent fields are kept in a single field (normalized, as for Java clients) or denormalized, with individual fields for each index (as for .NET clients).
• LegacyRelationMetaData defines the details about a relation:
  1. name, a String with the relation name.
  2. parentBuffer, a String with the name of the parent table.
  3. childBuffer, a String with the name of the child table.
  4. whereString, a String with the WHERE clause of this relation.
  5. active, a Boolean with the relation's active state.
  6. parentId, a Boolean with the parent-id state.
  7. pairs, a String with parent, child field pairs, comma delimited.
  8. fkeyHidden, a Boolean with the FOREIGN-KEY-HIDDEN status.
  9. recursive, a Boolean with the recursive status.
  10. nested, a Boolean with the NESTED status.
  11. reposition, a Boolean with Rthe REPOSITION status.
• LegacyFieldMetaData defines the details about a field:
  1. idx, an int with the field's position in the table's fields
  2. name, a String with the legacy field name; indexed for denormalized extent.
  3. extent, an int with the field's extent.
  4. extentIndex, an int with the extent field's index, for denormalized extent.
  5. extentField, the legacy name of the extent field (non-indexed).
  6. type, a BaseDataType class with the field's type.
  7. legacytype, an int with the field's type, as specified by LegacyJavaAppserver constants.
  8. order, an int with the fields order.
  9. xmlMapping, a int with the XML name describing this field.

TODO: The XML related metadata is NOT used now in LegacyJavaAppserver.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DENORMALIZED_PREFIX A prefix added to denormalized extent fields.
private static java.lang.String	FWD_TABLE_TYPE_SUFFIX The suffix for a table row.
static java.lang.String	FWD_URI The URI for the custom types.
private static CentralLogger	LOG Logger
private static boolean	mergeTables Flag indicating the response will be merged, instead of being replaced in the dataset.
static java.lang.String	SDO_API_URI The URI for defining known types (as int, String, etc).
private static boolean	unknownValuesForFields Flag indicating any unset field will return null, instead of its default value (like 0 and false for Java native types).

Constructor Summary

Constructors

Constructor and Description
DataSetSDOHelper()

Method Summary

Modifier and Type	Method and Description
(package private) static void	addBeforeObject(commonj.sdo.DataGraph graph, commonj.sdo.DataObject row) Add a new before-table row.
static void	addDataObject(commonj.sdo.DataGraph graph, commonj.sdo.DataObject row) Add the specified row to the graph.
static void	addDataObject(commonj.sdo.DataObject tableMetaData, commonj.sdo.DataObject row) Add the specified row to the graph.
protected static commonj.sdo.DataObject	addPropertyDescription(commonj.sdo.DataObject containerType, java.lang.Object propertyType, java.lang.String propertyName) Create a new property for the specified type.
static 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.
static void	addTableMetaData(commonj.sdo.DataObject metaData, commonj.sdo.DataObject table) Add the specified table metadata to the graph.
static void	beginLogging(commonj.sdo.DataGraph graph) Begin the logging for changes in this graph.
(package private) static java.lang.String	buildDenormalizedFieldName(java.lang.String fname, int idx) Compute the denormalized field name.
static void	clearAllRows(commonj.sdo.DataObject metadata) Clear the rows in the entire dataset.
private static void	createBeforeRow(FWDDataObjectType record, int state) Create a before-table row with the specified state.
static commonj.sdo.DataGraph	createDataGraph() Create a new graph to hold a dataset.
static commonj.sdo.DataGraph	createDataGraph(commonj.sdo.DataObject metadata) Create a new metadata object to hold the table details.
static commonj.sdo.DataObject	createDataObject(commonj.sdo.DataGraph graph, java.lang.String table) Create a new row for the specified table.
static commonj.sdo.DataObject	createDataObject(commonj.sdo.DataObject tableMetaData) Create a new row for the specified table.
static commonj.sdo.DataObject	createGraphMetaData(commonj.sdo.DataObject ori) Create a metadata object identical with the given metadata (except tables).
static commonj.sdo.DataObject	createGraphMetaData(java.lang.String name) Create a metadata object with the specified name.
static commonj.sdo.DataObject	createGraphMetaData(java.lang.String name, java.lang.String xmlns, java.lang.String xmlPrefix, java.lang.String xmlNodeName) Create a metadata object with the specified details.
static void	createGraphMetaDataTypes(commonj.sdo.helper.HelperContext scope) Create the metadata types.
private static commonj.sdo.helper.HelperContext	createHelperContext() Create a new HelperContext instance.
static commonj.sdo.DataObject	createTableMetaData(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, boolean normalizedExtent) Create an object with a table metadata.
protected static commonj.sdo.DataObject	createTypeDescription(commonj.sdo.helper.HelperContext scope, java.lang.String uri, java.lang.String name) Create a new type description.
static void	endLogging(commonj.sdo.DataGraph graph) End the logging for changes in this graph.
static java.util.List<commonj.sdo.DataObject>	getBeforeObjects(commonj.sdo.DataGraph graph, java.lang.String name) Get the before-table rows for the specified after-table.
static java.util.List<commonj.sdo.DataObject>	getBeforeObjects(commonj.sdo.DataObject table) Get the before-table rows for this after-table.
static java.util.List<commonj.sdo.DataObject>	getChildRows(commonj.sdo.DataObject row, java.lang.String relation) Get the child rows for this record.
static java.lang.String	getDataGraphName(commonj.sdo.DataObject metadata) Get the graph name from the specified metadata, of type graphmetadata.
static 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.
static java.util.List<commonj.sdo.DataObject>	getDataObjects(commonj.sdo.DataGraph graph, java.lang.String name) Get all the records for the table with the given name, in the graph metadata.
static java.util.List<commonj.sdo.DataObject>	getDataObjects(commonj.sdo.DataObject table) Get all the records for this table.
static java.util.List<commonj.sdo.DataObject>	getDataObjects(commonj.sdo.DataObject graphMeta, java.lang.String name) Get all the records for the table with the given name, in the graph metadata.
static int	getFieldCount(commonj.sdo.DataObject row) Get the number of fields for a given row.
private static java.lang.String	getFieldListKey(java.util.List<LegacyFieldMetaData> fields) Get the key associated with a field list.
static java.util.List<LegacyFieldMetaData>	getFieldMetaData(commonj.sdo.DataObject tableMeta) Get the metadata for all fields in the specified table.
static LegacyFieldMetaData	getFieldMetaData(commonj.sdo.DataObject tableMeta, java.lang.String fname, boolean forceNormalizedFields) Get the field metadata for the specified property.
static LegacyFieldMetaData	getFieldMetaData(commonj.sdo.DataObject tableMeta, java.lang.String fname, boolean forceNormalizedFields, boolean failNotFound) Get the field metadata for the specified property.
static java.lang.String	getFieldName(commonj.sdo.DataObject row, int i) Get the name of the field on the given index in the metadata.
static int	getFieldType(commonj.sdo.DataObject row, int i) Get the type of the field on the given index in the metadata.
static java.lang.String	getGraphName(commonj.sdo.DataObject tableMetadata) Get the data graph name for the given table metadata.
static commonj.sdo.DataObject	getMetaData(commonj.sdo.DataGraph graph) Get the metadata object for this graph, from the metadata property of the root object.
private static long	getNextId(commonj.sdo.DataGraph graph) Get next internal record ID for this graph.
private static long	getNextId(commonj.sdo.DataObject graphMeta) Get next internal record ID for this graph.
static int	getNumTables(commonj.sdo.DataObject metadata) Get the number of tables for a graph metadata.
static LegacyRelationMetaData	getRelation(commonj.sdo.DataGraph graph, java.lang.String name) Get the relation metadata with the given name.
static LegacyRelationMetaData	getRelation(commonj.sdo.DataObject metaData, java.lang.String name) Get the relation metadata with the given name.
static LegacyRelationMetaData[]	getRelations(commonj.sdo.DataGraph graph) Get the all relation metadata from the given graph.
static LegacyRelationMetaData[]	getRelations(commonj.sdo.DataObject metaData) Get the all relation metadata from the given graph.
static int	getTableFieldCount(commonj.sdo.DataObject tableMeta) Get the number of fields for the specified table meta.
static java.lang.String[]	getTableFieldNames(commonj.sdo.DataObject tableMeta) Get the field names for the specified table meta.
static int	getTableFieldType(commonj.sdo.DataObject tableMetadata, int fieldIndex) Get the field type.
static int	getTableFieldType(commonj.sdo.DataObject tableMetadata, java.lang.String fieldName) Get the field type.
static int	getTableIndex(commonj.sdo.DataGraph graph, java.lang.String name) Get the table index for a given table name and data graph.
static int	getTableIndex(commonj.sdo.DataObject value) Get the table index for a given row or table metadata.
static int	getTableIndex(commonj.sdo.DataObject metadata, java.lang.String name) Get the table index for a given table name and data graph metadata.
static java.util.List<commonj.sdo.DataObject>	getTableMetaData(commonj.sdo.DataGraph graph) Get the metadata list for all tables.
static commonj.sdo.DataObject	getTableMetaData(commonj.sdo.DataGraph graph, java.lang.String table) Get the metadata for the specified table.
static commonj.sdo.DataObject	getTableMetaData(commonj.sdo.DataObject metaData, int i) Get the metadata for the table registered on the given index in the graph.
static commonj.sdo.DataObject	getTableMetaData(commonj.sdo.DataObject metaData, java.lang.String name) Get the metadata for the table registered with the given name in the graph.
static java.lang.String	getTableName(commonj.sdo.DataObject value) Get the table name for a given row or table metadata.
static java.lang.String[]	getTableNames(commonj.sdo.DataGraph graph) Get all table names from the given graph.
static java.lang.String[]	getTableNames(commonj.sdo.DataObject metadata) Get all table names from the given graph metadata.
static void	initGraphMetaData(commonj.sdo.DataObject metadata, java.lang.String name, java.lang.String xmlns, java.lang.String xmlPrefix, java.lang.String xmlNodeName, java.util.List<java.lang.String> tableNames) Initialize this graph metadata.
static java.util.Map<java.lang.String,java.lang.String>	initGraphMetaData(commonj.sdo.DataObject metadata, java.lang.String name, java.lang.String xmlns, java.lang.String xmlPrefix, java.lang.String xmlNodeName, java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.String>>> tableSignatures) Initialize this graph metadata.
static void	initTableMetaData(commonj.sdo.DataObject tableMeta, 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, boolean normalizedExtent) Initialize the given table metadata.
static boolean	isMergeTables() Get the mergeTables flag.
static boolean	isTableField(commonj.sdo.DataObject tableMetadata, java.lang.String fieldName) Check if this table has a field defined with that name.
static boolean	isUnknownValuesForFields() Get the unknownValuesForFields flag.
(package private) static void	logChanged(FWDDataObjectType record) Mark this record as being changed, in the before-table.
(package private) static void	logCreated(FWDDataObjectType record) Mark this record as being created, in the before-table.
(package private) static void	logDeleted(FWDDataObjectType record) Mark this record as being deleted, in the before-table.
static void	main(java.lang.String[] args) A simple test for the Tuscany SDO APIs.
static 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.
static void	setBeforeRows(commonj.sdo.DataGraph graph, java.lang.String tableName, java.util.List<commonj.sdo.DataObject> rows) Set the before-table rows for the specified table.
static LegacyFieldMetaData	setFieldMetaData(commonj.sdo.DataObject metaData, int idx, java.lang.String name, int extent, java.lang.Class<?> cls, int legacyType, int order, int xmlMapping) Add a new new field with the specified configuration.
static LegacyFieldMetaData	setFieldMetaData(java.util.List<LegacyFieldMetaData> fields, commonj.sdo.DataObject metaData, LegacyFieldMetaData field) Add a new new field with the specified configuration.
static void	setGraphMetaData(commonj.sdo.DataGraph graph, commonj.sdo.DataObject metadata) Set the metadata to the specified graph.
static void	setMergeTables(boolean state) Set the mergeTables flag.
static void	setTableRows(commonj.sdo.DataGraph graph, java.lang.String tableName, java.util.List<commonj.sdo.DataObject> rows) Set the table rows for the specified table.
static void	setUnknownValuesForFields(boolean state) Set the unknownValuesForFields flag.
private static java.lang.String	tableFromType(commonj.sdo.Type type) Compute the table name from the custom type of the table's records.
private static java.lang.String	tableTypeName(java.lang.String table, java.util.List<LegacyFieldMetaData> fields) Construct the custom type to hold records for this table.

Methods inherited from class java.lang.Object

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

Field Detail

FWD_URI

public static final java.lang.String FWD_URI

The URI for the custom types.

See Also:

Constant Field Values

SDO_API_URI

public static final java.lang.String SDO_API_URI

The URI for defining known types (as int, String, etc).

See Also:

Constant Field Values

DENORMALIZED_PREFIX

public static final java.lang.String DENORMALIZED_PREFIX

A prefix added to denormalized extent fields.

See Also:

Constant Field Values

FWD_TABLE_TYPE_SUFFIX

private static final java.lang.String FWD_TABLE_TYPE_SUFFIX

The suffix for a table row.

See Also:

Constant Field Values

LOG

private static final CentralLogger LOG

Logger

unknownValuesForFields

private static volatile boolean unknownValuesForFields

Flag indicating any unset field will return null, instead of its default value (like 0 and false for Java native types).

mergeTables

private static volatile boolean mergeTables

Flag indicating the response will be merged, instead of being replaced in the dataset.

Constructor Detail

DataSetSDOHelper

DataSetSDOHelper()

Method Detail

setUnknownValuesForFields

public static void setUnknownValuesForFields(boolean state)

Set the unknownValuesForFields flag.

Parameters:

state - true to return null if the field is not set.

isUnknownValuesForFields

public static boolean isUnknownValuesForFields()

Get the unknownValuesForFields flag.

Returns:

See above.

setMergeTables

public static void setMergeTables(boolean state)

Set the mergeTables flag.

Parameters:

state - true to merge the response.

isMergeTables

public static boolean isMergeTables()

Get the mergeTables flag.

Returns:

See above.

beginLogging

public static void beginLogging(commonj.sdo.DataGraph graph)

Begin the logging for changes in this graph.

Parameters:

graph - The graph to track changes.

endLogging

public static void endLogging(commonj.sdo.DataGraph graph)

End the logging for changes in this graph.

Parameters:

graph - The graph to track changes.

getDataGraphName

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

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

Parameters:

metadata - The metadata.

Returns:

The graph name.

getMetaData

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

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

Parameters:

graph - The graph.

Returns:

The metadata object.

setFieldMetaData

public static LegacyFieldMetaData setFieldMetaData(java.util.List<LegacyFieldMetaData> fields,
                                                   commonj.sdo.DataObject metaData,
                                                   LegacyFieldMetaData field)

Add a new new field with the specified configuration.

Parameters:

fields - The table's fields list, as retrieved from the DataObject.

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

field - The field meta.

Returns:

The created field metadata.

setFieldMetaData

public static LegacyFieldMetaData setFieldMetaData(commonj.sdo.DataObject metaData,
                                                   int idx,
                                                   java.lang.String name,
                                                   int extent,
                                                   java.lang.Class<?> cls,
                                                   int legacyType,
                                                   int order,
                                                   int xmlMapping)

Add a new new field with the specified configuration.

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.

cls - The fields BaseDataType class.

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

order - The field's order.

xmlMapping - The field's mapping.

Returns:

The created field metadata.

getRelation

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

Get the relation metadata with the given name.

Parameters:

graph - The data graph.

name - The relation name.

Returns:

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

getRelation

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

Get the relation metadata with the given name.

Parameters:

metaData - The graph metadata.

name - The relation name.

Returns:

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

getRelations

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

Get the all relation metadata from the given graph.

Parameters:

graph - The data graph.

Returns:

The relations metadata.

getRelations

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

Get the all relation metadata from the given graph.

Parameters:

metaData - The graph metadata.

Returns:

The relations metadata.

addRelation

public static 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.

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.

createTableMetaData

public static commonj.sdo.DataObject createTableMetaData(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,
                                                         boolean normalizedExtent)

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

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).

normalizedExtent - Flag indicating if the extents are normalized or individual fields will be created for each index.

Returns:

An object with the table metadata.

initTableMetaData

public static void initTableMetaData(commonj.sdo.DataObject tableMeta,
                                     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,
                                     boolean normalizedExtent)

Initialize the given table metadata.

Parameters:

tableMeta - The table's metadata object.

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).

normalizedExtent - Flag indicating if the extents are normalized or individual fields will be created for each index.

addTableMetaData

public static 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.

Parameters:

metaData - The graph metadata.

table - The table metadata.

getFieldMetaData

public static java.util.List<LegacyFieldMetaData> getFieldMetaData(commonj.sdo.DataObject tableMeta)

Get the metadata for all fields in the specified table.

Parameters:

tableMeta - The table metadata.

Returns:

A list of field metadata objects.

getFieldMetaData

public static LegacyFieldMetaData getFieldMetaData(commonj.sdo.DataObject tableMeta,
                                                   java.lang.String fname,
                                                   boolean forceNormalizedFields)

Get the field metadata for the specified property.

Parameters:

tableMeta - The table metadata.

fname - The field name.

forceNormalizedFields - When this flag is set, only normalized extent fields are looked.

Returns:

The found field's metadata.

Throws:

java.lang.IllegalStateException - If the field can't be resolved.

getFieldMetaData

public static LegacyFieldMetaData getFieldMetaData(commonj.sdo.DataObject tableMeta,
                                                   java.lang.String fname,
                                                   boolean forceNormalizedFields,
                                                   boolean failNotFound)

Get the field metadata for the specified property.

Parameters:

tableMeta - The table metadata.

fname - The field name.

forceNormalizedFields - When this flag is set, only normalized extent fields are looked.

failNotFound - Throw an IllegalStateException if the field can't be resolved.

Returns:

The found field's metadata.

Throws:

java.lang.IllegalStateException - If the field can't be resolved and failNotFound flag is set.

getTableMetaData

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

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

Parameters:

metaData - The graph metadata.

i - The table index.

Returns:

The table metadata.

getTableMetaData

public static commonj.sdo.DataObject getTableMetaData(commonj.sdo.DataObject metaData,
                                                      java.lang.String name)

Get the metadata for the table registered with the given name in the graph.

Parameters:

metaData - The graph metadata.

name - The table name.

Returns:

The table metadata.

getTableMetaData

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

Get the metadata for the specified table.

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 static java.util.List<commonj.sdo.DataObject> getTableMetaData(commonj.sdo.DataGraph graph)

Get the metadata list for all tables.

Parameters:

graph - The graph.

Returns:

The metadata for all tables.

createDataGraph

public static commonj.sdo.DataGraph createDataGraph()

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

Returns:

A graph with no metadata.

createDataGraph

public static commonj.sdo.DataGraph createDataGraph(commonj.sdo.DataObject metadata)

Create a new metadata object to hold the table details.

Parameters:

metadata - The root graph node.

Returns:

The graph metadata object.

setGraphMetaData

public static void setGraphMetaData(commonj.sdo.DataGraph graph,
                                    commonj.sdo.DataObject metadata)

Set the metadata to the specified graph.

Parameters:

graph - The graph object.

metadata - The metadata object which will be set to the graph's metadata property.

createGraphMetaData

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

Create a metadata object with the specified name.

Parameters:

name - The graph name.

Returns:

The metadata object. Will be attached to a graph via setGraphMetaData(commonj.sdo.DataGraph, commonj.sdo.DataObject).

createGraphMetaData

public static commonj.sdo.DataObject createGraphMetaData(java.lang.String name,
                                                         java.lang.String xmlns,
                                                         java.lang.String xmlPrefix,
                                                         java.lang.String xmlNodeName)

Create a metadata object with the specified details.

Parameters:

name - The graph name.

xmlns - The namespace URI.

xmlPrefix - The namespace prefix.

xmlNodeName - The XML node-name.

Returns:

The metadata object. Will be attached to a graph via setGraphMetaData(commonj.sdo.DataGraph, commonj.sdo.DataObject).

initGraphMetaData

public static void initGraphMetaData(commonj.sdo.DataObject metadata,
                                     java.lang.String name,
                                     java.lang.String xmlns,
                                     java.lang.String xmlPrefix,
                                     java.lang.String xmlNodeName,
                                     java.util.List<java.lang.String> tableNames)

Initialize this graph metadata.

Parameters:

metadata - The graph metadata.

name - The graph name.

xmlns - The namespace URI.

xmlPrefix - The namespace prefix.

xmlNodeName - The XML node-name.

tableNames - The table names to keep in this metadata. May be null.

initGraphMetaData

public static java.util.Map<java.lang.String,java.lang.String> initGraphMetaData(commonj.sdo.DataObject metadata,
                                                                                 java.lang.String name,
                                                                                 java.lang.String xmlns,
                                                                                 java.lang.String xmlPrefix,
                                                                                 java.lang.String xmlNodeName,
                                                                                 java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.String>>> tableSignatures)

Initialize this graph metadata.

Parameters:

metadata - The graph metadata.

name - The graph name.

xmlns - The namespace URI.

xmlPrefix - The namespace prefix.

xmlNodeName - The XML node-name.

tableSignatures - The table names and signatures to keep in this metadata. May be null.

Returns:

A map with old and new name pairs.

createGraphMetaData

public static commonj.sdo.DataObject createGraphMetaData(commonj.sdo.DataObject ori)

Create a metadata object identical with the given metadata (except tables).

Parameters:

ori - The source metadata.

Returns:

The metadata object. Will be attached to a graph via setGraphMetaData(commonj.sdo.DataGraph, commonj.sdo.DataObject).

createGraphMetaDataTypes

public static void createGraphMetaDataTypes(commonj.sdo.helper.HelperContext scope)

Create the metadata types.

Parameters:

scope - The helper context where the types will be defined.

clearAllRows

public static void clearAllRows(commonj.sdo.DataObject metadata)

Clear the rows in the entire dataset.

Parameters:

metadata - The metadata for this dataset.

getTableNames

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

Get all table names from the given graph.

Parameters:

graph - The graph.

Returns:

See above.

getTableNames

public static java.lang.String[] getTableNames(commonj.sdo.DataObject metadata)

Get all table names from the given graph metadata.

Parameters:

metadata - The graph metadata.

Returns:

See above.

getNumTables

public static int getNumTables(commonj.sdo.DataObject metadata)

Get the number of tables for a graph metadata.

Parameters:

metadata - The graph metadata.

Returns:

See above.

getTableName

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

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

Parameters:

value - The table row or table metadata.

Returns:

The table name.

getTableIndex

public static int getTableIndex(commonj.sdo.DataObject value)

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

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 static int getTableIndex(commonj.sdo.DataGraph graph,
                                java.lang.String name)

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

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 static int getTableIndex(commonj.sdo.DataObject metadata,
                                java.lang.String name)

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

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 static java.lang.String getGraphName(commonj.sdo.DataObject tableMetadata)

Get the data graph name for the given table metadata.

Parameters:

tableMetadata - The table metadata.

Returns:

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

getFieldCount

public static int getFieldCount(commonj.sdo.DataObject row)

Get the number of fields for a given row.

Parameters:

row - The table row.

Returns:

The number of fields as specified in the table metadata.

getTableFieldCount

public static int getTableFieldCount(commonj.sdo.DataObject tableMeta)

Get the number of fields for the specified table meta.

Parameters:

tableMeta - The table metadata.

Returns:

The field count.

getTableFieldNames

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

Get the field names for the specified table meta.

Parameters:

tableMeta - The table metadata.

Returns:

The field names.

getFieldName

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

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

Parameters:

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

i - The field index.

Returns:

The field's name.

getFieldType

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

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

Parameters:

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

i - The field index.

Returns:

The field's type.

isTableField

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

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

Parameters:

tableMetadata - The table metadata.

fieldName - The field name.

Returns:

true if there is a field defined with this name.

getTableFieldType

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

Get the field type.

Parameters:

tableMetadata - The table metadata.

fieldName - The field name.

Returns:

The field type.

getTableFieldType

public static int getTableFieldType(commonj.sdo.DataObject tableMetadata,
                                    int fieldIndex)

Get the field type.

Parameters:

tableMetadata - The table metadata.

fieldIndex - The field index.

Returns:

See above.

createDataObject

public static 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.

Parameters:

graph - The graph.

table - The table name.

Returns:

A new, empty, row.

createDataObject

public static 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.

Parameters:

tableMetaData - The table metadata.

Returns:

The new row.

setTableRows

public static void setTableRows(commonj.sdo.DataGraph graph,
                                java.lang.String tableName,
                                java.util.List<commonj.sdo.DataObject> rows)

Set the table rows for the specified table.

Parameters:

graph - The graph.

tableName - The table name.

rows - The list of rows.

setBeforeRows

public static void setBeforeRows(commonj.sdo.DataGraph graph,
                                 java.lang.String tableName,
                                 java.util.List<commonj.sdo.DataObject> rows)

Set the before-table rows for the specified table.

Parameters:

graph - The graph.

tableName - The table name.

rows - The list of rows.

addDataObject

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

Add the specified row to the graph.

Parameters:

graph - The graph.

row - The row to add to the table.

addDataObject

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

Add the specified row to the graph.

Parameters:

tableMetaData - The table metadata.

row - The row to add to the table.

getDataObjects

public static 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.

Parameters:

graph - The graph.

idx - The table index.

Returns:

The list of rows.

getDataObjects

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

Get all the records for this table.

Parameters:

table - The table metadata.

Returns:

The list of rows.

getBeforeObjects

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

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

Parameters:

table - The after-table.

Returns:

The list of before-table rows.

getDataObjects

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

Get all the records for the table with the given name, in the graph metadata.

Parameters:

graph - The graph.

name - The table name.

Returns:

The list of rows.

getDataObjects

public static java.util.List<commonj.sdo.DataObject> getDataObjects(commonj.sdo.DataObject graphMeta,
                                                                    java.lang.String name)

Get all the records for the table with the given name, in the graph metadata.

Parameters:

graphMeta - The graph metadata.

name - The table name.

Returns:

The list of rows.

getBeforeObjects

public static java.util.List<commonj.sdo.DataObject> getBeforeObjects(commonj.sdo.DataGraph graph,
                                                                      java.lang.String name)

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

Parameters:

graph - The graph.

name - The table name.

Returns:

The list of before-table rows.

selectRows

public static 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.

Parameters:

tableMetadata - The table metadata.

fields - The field list.

values - The values to be matched.

Returns:

See above.

getChildRows

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

Get the child rows for this record.

Parameters:

row - The row.

relation - The child relation.

Returns:

The child rows.

createTypeDescription

protected static commonj.sdo.DataObject createTypeDescription(commonj.sdo.helper.HelperContext scope,
                                                              java.lang.String uri,
                                                              java.lang.String name)

Create a new type description.

Parameters:

scope - The context.

uri - The type URI.

name - The type name.

Returns:

A new object defining this type.

addPropertyDescription

protected static commonj.sdo.DataObject addPropertyDescription(commonj.sdo.DataObject containerType,
                                                               java.lang.Object propertyType,
                                                               java.lang.String propertyName)

Create a new property for the specified type.

Parameters:

containerType - The object type.

propertyType - The property type.

propertyName - The property name.

Returns:

The created property.

buildDenormalizedFieldName

static java.lang.String buildDenormalizedFieldName(java.lang.String fname,
                                                   int idx)

Compute the denormalized field name. This name will start with the DENORMALIZED_PREFIX and end with the field's index.

Parameters:

fname - The legacy extent field name.

idx - The field's index.

Returns:

See above.

logChanged

static void logChanged(FWDDataObjectType record)

Mark this record as being changed, in the before-table.

Parameters:

record - The changed record.

logDeleted

static void logDeleted(FWDDataObjectType record)

Mark this record as being deleted, in the before-table.

Parameters:

record - The delete record.

logCreated

static void logCreated(FWDDataObjectType record)

Mark this record as being created, in the before-table.

Parameters:

record - The created record.

addBeforeObject

static void addBeforeObject(commonj.sdo.DataGraph graph,
                            commonj.sdo.DataObject row)

Add a new before-table row.

Parameters:

graph - The graph.

row - The row to add.

createBeforeRow

private static void createBeforeRow(FWDDataObjectType record,
                                    int state)

Create a before-table row with the specified state.

Parameters:

record - The after-table row.

state - The record state.

tableTypeName

private static java.lang.String tableTypeName(java.lang.String table,
                                              java.util.List<LegacyFieldMetaData> fields)

Construct the custom type to hold records for this table.

Parameters:

table - The table name.

fields - The table's fields.

Returns:

The custom type name.

getFieldListKey

private static java.lang.String getFieldListKey(java.util.List<LegacyFieldMetaData> fields)

Get the key associated with a field list. This is used to compute the table name.

Parameters:

fields - The field list.

Returns:

The key.

tableFromType

private static java.lang.String tableFromType(commonj.sdo.Type type)

Compute the table name from the custom type of the table's records.

Parameters:

type - The table's record type.

Returns:

The table name.

getNextId

private static long getNextId(commonj.sdo.DataGraph graph)

Get next internal record ID for this graph.

Parameters:

graph - The graph.

Returns:

The next record ID.

getNextId

private static long getNextId(commonj.sdo.DataObject graphMeta)

Get next internal record ID for this graph.

Parameters:

graphMeta - The graph metadata.

Returns:

The next record ID.

createHelperContext

private static commonj.sdo.helper.HelperContext createHelperContext()

Create a new HelperContext instance.

Returns:

See above.

main

public static void main(java.lang.String[] args)

A simple test for the Tuscany SDO APIs.