com.goldencode.p2j.pattern

Class SoapOperationParameter

java.lang.Object

com.goldencode.p2j.pattern.SoapOperationParameter

class SoapOperationParameter
extends java.lang.Object

Definition of a SOAP parameter exported via a .wsm file.

The data is read from the actual 4GL target (external program, internal entry, class or method).

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	beforeTable The before-table name.
(package private) java.util.List<SoapOperationParameter>	datasetTables List of table fields, if this is a DATASET parameter.
(package private) int	extent The extent value (-2 for no extent, -1 for dynamic extent, the extent value otherwise).
(package private) long	mode The parameter mode (a token type).
(package private) java.lang.String	name The legacy parameter name.
(package private) boolean	nillable Flag indicating if this parameter will be returned by the SOAP request, if is unknown.
(package private) java.lang.String	nodeName The name to be used at the XML node (for datasets).
(package private) java.util.List<DataSetRelation>	relations Relation list in case of datasets.
(package private) java.util.Map<java.lang.String,SoapOperationParameter>	tableFields List of table fields, if this is a TABLE parameter.
(package private) java.util.List<Index>	tableIndexes List of indexes for this table.
(package private) long	type The parameter token type.
(package private) boolean	useBeforeImage Flag indicating the 'before-image' must be written.

Constructor Summary

Constructors

Constructor and Description
SoapOperationParameter(java.lang.String name, long type, long mode, boolean nillable) Create a new instance.
SoapOperationParameter(java.lang.String name, long type, long mode, boolean nillable, boolean useBeforeImage) Create a new instance.
SoapOperationParameter(java.lang.String name, long type, long mode, boolean nillable, int extent) Create a new instance.

Method Summary

Modifier and Type	Method and Description
java.util.List<SoapOperationParameter>	getChildTables(SoapOperationParameter parent) Get all the child tables for this parent table.
boolean	isNestedTable(SoapOperationParameter table) Check if this table is nested (via the relations) as a child for another table.
void	loadDataSet(Aast ref, SchemaDictionary dictionary) For a dataset parameter, load its tables, as they appear defined in the schema dictionary.
void	loadTable(Aast ref, SchemaDictionary dictionary, boolean forDataset) For a table parameter, load its fields, as they appear defined in the schema dictionary.
private java.lang.String	readProperty(Aast propAst) Read a property from a schema dict AST.
(package private) void	setNodeName(java.lang.String serializeName, java.lang.String xmlNodeName) Set the nodeName for this parameter from the XML-NODE-NAME and SERIALIZE-NAME attributes.

Methods inherited from class java.lang.Object

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

Field Detail

name

final java.lang.String name

The legacy parameter name.

type

final long type

The parameter token type.

mode

final long mode

The parameter mode (a token type).

nillable

final boolean nillable

Flag indicating if this parameter will be returned by the SOAP request, if is unknown.

extent

final int extent

The extent value (-2 for no extent, -1 for dynamic extent, the extent value otherwise).

useBeforeImage

final boolean useBeforeImage

Flag indicating the 'before-image' must be written.

nodeName

java.lang.String nodeName

The name to be used at the XML node (for datasets).

tableFields

java.util.Map<java.lang.String,SoapOperationParameter> tableFields

List of table fields, if this is a TABLE parameter.

tableIndexes

java.util.List<Index> tableIndexes

List of indexes for this table.

relations

java.util.List<DataSetRelation> relations

Relation list in case of datasets.

datasetTables

java.util.List<SoapOperationParameter> datasetTables

List of table fields, if this is a DATASET parameter.

beforeTable

java.lang.String beforeTable

The before-table name.

Constructor Detail

SoapOperationParameter

public SoapOperationParameter(java.lang.String name,
                              long type,
                              long mode,
                              boolean nillable)

Create a new instance.

Parameters:

name - The legacy parameter name.

type - The parameter token type.

mode - The parameter mode (a token type).

nillable - Flag indicating if this parameter will be returned by the SOAP request, if is unknown.

SoapOperationParameter

public SoapOperationParameter(java.lang.String name,
                              long type,
                              long mode,
                              boolean nillable,
                              boolean useBeforeImage)

Create a new instance.

Parameters:

name - The legacy parameter name.

type - The parameter token type.

mode - The parameter mode (a token type).

nillable - Flag indicating if this parameter will be returned by the SOAP request, if is unknown.

useBeforeImage - Flag indicating if before-image is used for a dataset.

SoapOperationParameter

public SoapOperationParameter(java.lang.String name,
                              long type,
                              long mode,
                              boolean nillable,
                              int extent)

Create a new instance.

Parameters:

name - The legacy parameter name.

type - The parameter token type.

mode - The parameter mode (a token type).

nillable - Flag indicating if this parameter will be returned by the SOAP request, if is unknown.

extent - The extent value (-2 for no extent, -1 for dynamic extent, the extent value otherwise).

Method Detail

loadTable

public void loadTable(Aast ref,
                      SchemaDictionary dictionary,
                      boolean forDataset)

For a table parameter, load its fields, as they appear defined in the schema dictionary.

Parameters:

ref - The parameter definition AST.

dictionary - The schema dictionary.

forDataset - Flag indicating that this table is for a dataset

isNestedTable

public boolean isNestedTable(SoapOperationParameter table)

Check if this table is nested (via the relations) as a child for another table.

Parameters:

table - The table reference.

Returns:

See above.

getChildTables

public java.util.List<SoapOperationParameter> getChildTables(SoapOperationParameter parent)

Get all the child tables for this parent table.

Parameters:

parent - The parent table.

Returns:

The child tables in the relations, for this parent.

loadDataSet

public void loadDataSet(Aast ref,
                        SchemaDictionary dictionary)
                 throws SchemaException

For a dataset parameter, load its tables, as they appear defined in the schema dictionary.

Parameters:

ref - The parameter definition AST.

dictionary - The schema dictionary.

Throws:

SchemaException

setNodeName

void setNodeName(java.lang.String serializeName,
                 java.lang.String xmlNodeName)

Set the nodeName for this parameter from the XML-NODE-NAME and SERIALIZE-NAME attributes.

Parameters:

serializeName - The SERIALIZE-NAME attribute.

xmlNodeName - The XML-NODE-NAME attribute.

readProperty

private java.lang.String readProperty(Aast propAst)

Read a property from a schema dict AST.

Parameters:

propAst - The property AST.

Returns:

The property value.