com.goldencode.p2j.persist

Interface XmlData

All Known Subinterfaces:

Buffer, EmptyBuffer, HandleCommon, TempTable, TempTableBuffer

All Known Implementing Classes:

AbstractTempTable, BufferImpl, DataSet, StaticDataSet, StaticTempTable, TempTableBuilder

public interface XmlData

Interface which defines legacy methods for temp-table and data set member buffers to consume and produce XML data.

Method Summary

Modifier and Type	Method and Description
logical	readXml(SourceData source, character readMode, character schemaLocation, logical overrideDefaultMapping) Implementation of the READ-XML method.
logical	readXml(SourceData source, character readMode, character schemaLocation, logical overrideDefaultMapping, character fieldTypeMapping) Implementation of the READ-XML method.
logical	readXml(SourceData source, character readMode, character schemaLocation, logical overrideDefaultMapping, character fieldTypeMapping, character verifySchemaMode) Implementation of the READ-XML method.
logical	readXmlSchema(SourceData source, logical override) Reads XML Schema from an XML document and uses that schema to either create a schema for a DataSet or TempTable or verify existing schema in a DataSet, TempTable or temp-table Buffer object.
logical	readXmlSchema(SourceData source, logical override, Text mapping) Reads XML Schema from an XML document and uses that schema to either create a schema for a DataSet or TempTable or verify existing schema in a DataSet, TempTable or temp-table Buffer object.
logical	readXmlSchema(SourceData source, logical override, Text mapping, Text verifyMode) Reads XML Schema from an XML document and uses that schema to either create a schema for a DataSet or TempTable or verify existing schema in a DataSet, TempTable or temp-table Buffer object.
logical	writeXml(TargetData target) Implementation of the WRITE-XML method.
logical	writeXml(TargetData target, logical formatted) Implementation of the WRITE-XML method.
logical	writeXml(TargetData target, logical formatted, character encoding) Implementation of the WRITE-XML method.
logical	writeXml(TargetData target, logical formatted, character encoding, character schemaLocation) Implementation of the WRITE-XML method.
logical	writeXml(TargetData target, logical formatted, character encoding, character schemaLocation, logical writeXmlSchema) Implementation of the WRITE-XML method.
logical	writeXml(TargetData target, logical formatted, character encoding, character schemaLocation, logical writeXmlSchema, logical minXmlSchema) Implementation of the WRITE-XML method.
logical	writeXml(TargetData target, logical formatted, character encoding, character schemaLocation, logical writeXmlSchema, logical minXmlSchema, logical writeBeforeImage) Implementation of the WRITE-XML method.
logical	writeXml(TargetData target, logical formatted, character encoding, character schemaLocation, logical writeXmlSchema, logical minXmlSchema, logical writeBeforeImage, logical omitInitialValues) Implementation of the WRITE-XML method.
logical	writeXmlSchema(TargetData target) Writes an XML representation of the definition of a DataSet, TempTable or temp-table Buffer object.
logical	writeXmlSchema(TargetData target, logical formatted) Writes an XML representation of the definition of a DataSet, TempTable or temp-table Buffer object.
logical	writeXmlSchema(TargetData target, logical formatted, Text encoding) Writes an XML representation of the definition of a DataSet, TempTable or temp-table Buffer object.
logical	writeXmlSchema(TargetData target, logical formatted, Text encoding, logical minXmlSchema) Writes an XML representation of the definition of a DataSet, TempTable or temp-table Buffer object.
logical	writeXmlSchema(TargetData target, logical formatted, Text encoding, logical minXmlSchema, logical omitInitVal) Writes an XML representation of the definition of a DataSet, TempTable or temp-table Buffer object.

Method Detail

readXml

logical readXml(SourceData source,
                character readMode,
                character schemaLocation,
                logical overrideDefaultMapping)

Implementation of the READ-XML method. Reads XML data from the specified data source into this object.

Defaults applied:

• Default field type mappings
• LOOSE schema verification mode

Parameters:

source - Data source.

readMode - Mode in which data is read into buffer. Must evaluate to APPEND, EMPTY, MERGE, or REPLACE.

schemaLocation - Name of an external XML schema file, or empty string or unknown value to use the xsi:noNamespaceSchemaLocation value set in the XML data, if any.

overrideDefaultMapping - True to override the default string-to-binary data type mappings when creating a temp-table schema from an XML schema.

Returns:

True if the operation completed successfully, else false.

readXml

logical readXml(SourceData source,
                character readMode,
                character schemaLocation,
                logical overrideDefaultMapping,
                character fieldTypeMapping)

Implementation of the READ-XML method. Reads XML data from the specified data source into this object.

Defaults applied:

• LOOSE schema verification mode

Parameters:

source - Data source.

readMode - Mode in which data is read into buffer. Must evaluate to APPEND, EMPTY, MERGE, or REPLACE.

schemaLocation - Name of an external XML schema file, or empty string or unknown value to use the xsi:noNamespaceSchemaLocation value set in the XML data, if any.

overrideDefaultMapping - True to override the default string-to-binary data type mappings when creating a temp-table schema from an XML schema.

fieldTypeMapping - Comma-delimited list of field name and data type name pairs to use to override data type mappings of specific fields. Specify unknown value to use default mappings.

Returns:

True if the operation completed successfully, else false.

readXml

logical readXml(SourceData source,
                character readMode,
                character schemaLocation,
                logical overrideDefaultMapping,
                character fieldTypeMapping,
                character verifySchemaMode)

Implementation of the READ-XML method. Reads XML data from the specified data source into this object.

Parameters:

source - Data source.

readMode - Mode in which data is read into buffer. Must evaluate to APPEND, EMPTY, MERGE, or REPLACE.

schemaLocation - Name of an external XML schema file, or empty string or unknown value to use the xsi:noNamespaceSchemaLocation value set in the XML data, if any.

overrideDefaultMapping - True to override the default string-to-binary data type mappings when creating a temp-table schema from an XML schema.

fieldTypeMapping - Comma-delimited list of field name and data type name pairs to use to override data type mappings of specific fields. Specify unknown value to use default mappings.

verifySchemaMode - Schema verification mode. Must evaluate to IGNORE, LOOSE, or STRICT. Default is LOOSE.

Returns:

True if the operation completed successfully, else false.

writeXml

logical writeXml(TargetData target)

Implementation of the WRITE-XML method. Writes XML data from this object into the specified data target.

Defaults applied:

• Unformatted text
• UTF-8 encoding
• xsi:noNamespaceSchemaLocation=?
• No XML schema written
• No before-image data written
• Do not omit temp-table fields which contain their initial values

Parameters:

target - Data target.

Returns:

True if the operation completed successfully, else false.

writeXml

logical writeXml(TargetData target,
                 logical formatted)

Implementation of the WRITE-XML method. Writes XML data from this object into the specified data target.

Defaults applied:

• UTF-8 encoding
• xsi:noNamespaceSchemaLocation=?
• No XML schema written
• No before-image data written
• Do not omit temp-table fields which contain their initial values

Parameters:

target - Data target.

formatted - True to format the XML to make it more readable; false to write it as unformatted text. Unknown value is treated as false.

Returns:

True if the operation completed successfully, else false.

writeXml

logical writeXml(TargetData target,
                 logical formatted,
                 character encoding)

Implementation of the WRITE-XML method. Writes XML data from this object into the specified data target.

Defaults applied:

• xsi:noNamespaceSchemaLocation=?
• No XML schema written
• No before-image data written
• Do not omit temp-table fields which contain their initial values

Parameters:

target - Data target.

formatted - True to format the XML to make it more readable; false to write it as unformatted text. Unknown value is treated as false.

encoding - Name of the character encoding to use.

Returns:

True if the operation completed successfully, else false.

writeXml

logical writeXml(TargetData target,
                 logical formatted,
                 character encoding,
                 character schemaLocation)

Implementation of the WRITE-XML method. Writes XML data from this object into the specified data target.

Defaults applied:

• No XML schema written
• No before-image data written
• Do not omit temp-table fields which contain their initial values

Parameters:

target - Data target.

formatted - True to format the XML to make it more readable; false to write it as unformatted text. Unknown value is treated as false.

encoding - Name of the character encoding to use.

schemaLocation - Name of an external XML schema file, or empty string or unknown value to set the xsi:noNamespaceSchemaLocation to empty string or unknown value.

Returns:

True if the operation completed successfully, else false.

writeXml

logical writeXml(TargetData target,
                 logical formatted,
                 character encoding,
                 character schemaLocation,
                 logical writeXmlSchema)

Implementation of the WRITE-XML method. Writes XML data from this object into the specified data target.

Defaults applied:

• No before-image data written
• Do not omit temp-table fields which contain their initial values

Parameters:

target - Data target.

formatted - True to format the XML to make it more readable; false to write it as unformatted text. Unknown value is treated as false.

encoding - Name of the character encoding to use.

schemaLocation - Name of an external XML schema file, or empty string or unknown value to set the xsi:noNamespaceSchemaLocation to empty string or unknown value.

writeXmlSchema - True to write XML schema information, else false.

Returns:

True if the operation completed successfully, else false.

writeXml

logical writeXml(TargetData target,
                 logical formatted,
                 character encoding,
                 character schemaLocation,
                 logical writeXmlSchema,
                 logical minXmlSchema)

Implementation of the WRITE-XML method. Writes XML data from this object into the specified data target.

Defaults applied:

• No before-image data written
• Do not omit temp-table fields which contain their initial values

Parameters:

target - Data target.

formatted - True to format the XML to make it more readable; false to write it as unformatted text. Unknown value is treated as false.

encoding - Name of the character encoding to use.

schemaLocation - Name of an external XML schema file, or empty string or unknown value to set the xsi:noNamespaceSchemaLocation to empty string or unknown value.

writeXmlSchema - True to write XML schema information, else false.

minXmlSchema - True to write minimal XML schema information, else false. Must be false if writeXmlSchema is false.

Returns:

True if the operation completed successfully, else false.

writeXml

logical writeXml(TargetData target,
                 logical formatted,
                 character encoding,
                 character schemaLocation,
                 logical writeXmlSchema,
                 logical minXmlSchema,
                 logical writeBeforeImage)

Implementation of the WRITE-XML method. Writes XML data from this object into the specified data target.

Defaults applied:

• Do not omit temp-table fields which contain their initial values

Parameters:

target - Data target.

formatted - True to format the XML to make it more readable; false to write it as unformatted text. Unknown value is treated as false.

encoding - Name of the character encoding to use.

schemaLocation - Name of an external XML schema file, or empty string or unknown value to set the xsi:noNamespaceSchemaLocation to empty string or unknown value.

writeXmlSchema - True to write XML schema information, else false.

minXmlSchema - True to write minimal XML schema information, else false. Must be false if writeXmlSchema is false.

writeBeforeImage - True to write before-image data and error information, else false.

Returns:

True if the operation completed successfully, else false.

writeXml

logical writeXml(TargetData target,
                 logical formatted,
                 character encoding,
                 character schemaLocation,
                 logical writeXmlSchema,
                 logical minXmlSchema,
                 logical writeBeforeImage,
                 logical omitInitialValues)

Implementation of the WRITE-XML method. Writes XML data from this object into the specified data target.

Parameters:

target - Data target.

formatted - True to format the XML to make it more readable; false to write it as unformatted text. Unknown value is treated as false.

encoding - Name of the character encoding to use.

schemaLocation - Name of an external XML schema file, or empty string or unknown value to set the xsi:noNamespaceSchemaLocation to empty string or unknown value.

writeXmlSchema - True to write XML schema information, else false.

minXmlSchema - True to write minimal XML schema information, else false. Must be false if writeXmlSchema is false.

writeBeforeImage - True to write before-image data and error information, else false.

omitInitialValues - True to omit data for fields whose values match their initial values.

Returns:

True if the operation completed successfully, else false.

writeXmlSchema

logical writeXmlSchema(TargetData target)

Writes an XML representation of the definition of a DataSet, TempTable or temp-table Buffer object.

Parameters:

target - Data target.

Returns:

true if operation is successful.

writeXmlSchema

logical writeXmlSchema(TargetData target,
                       logical formatted)

Writes an XML representation of the definition of a DataSet, TempTable or temp-table Buffer object.

Parameters:

target - Data target.

formatted - Use true for a more human-readable document.

Returns:

true if operation is successful.

writeXmlSchema

logical writeXmlSchema(TargetData target,
                       logical formatted,
                       Text encoding)

Writes an XML representation of the definition of a DataSet, TempTable or temp-table Buffer object.

Parameters:

target - Data target.

formatted - Use true for a more human-readable document.

encoding - The character encoding. The default is UTF-8.

Returns:

true if operation is successful.

writeXmlSchema

logical writeXmlSchema(TargetData target,
                       logical formatted,
                       Text encoding,
                       logical minXmlSchema)

Writes an XML representation of the definition of a DataSet, TempTable or temp-table Buffer object.

Parameters:

target - Data target.

formatted - Use true for a more human-readable document.

encoding - The character encoding. The default is UTF-8.

minXmlSchema - If true, the minimum amount of schema for the object will be written.

Returns:

true if operation is successful.

writeXmlSchema

logical writeXmlSchema(TargetData target,
                       logical formatted,
                       Text encoding,
                       logical minXmlSchema,
                       logical omitInitVal)

Writes an XML representation of the definition of a DataSet, TempTable or temp-table Buffer object.

Parameters:

target - Data target.

formatted - Use true for a more human-readable document.

encoding - The character encoding. The default is UTF-8.

minXmlSchema - If true, the minimum amount of schema for the object will be written.

omitInitVal - Use true to omit the initial values.

Returns:

true if operation is successful.

readXmlSchema

logical readXmlSchema(SourceData source,
                      logical override)

Reads XML Schema from an XML document and uses that schema to either create a schema for a DataSet or TempTable or verify existing schema in a DataSet, TempTable or temp-table Buffer object.

Parameters:

source - Data source.

override - If true the default mapping between XML Schema string and binary data types and ABL data types when creating an ABL temp-table schema from an XML Schema will be overritten.

Returns:

true if operation is successful.

readXmlSchema

logical readXmlSchema(SourceData source,
                      logical override,
                      Text mapping)

Reads XML Schema from an XML document and uses that schema to either create a schema for a DataSet or TempTable or verify existing schema in a DataSet, TempTable or temp-table Buffer object.

Parameters:

source - Data source.

override - If true the default mapping between XML Schema string and binary data types and ABL data types when creating an ABL temp-table schema from an XML Schema will be overritten.

mapping - A comma-delimited list of field name, data type pairs. This allows to specify the data type for a specific field.

Returns:

true if operation is successful.

readXmlSchema

logical readXmlSchema(SourceData source,
                      logical override,
                      Text mapping,
                      Text verifyMode)

Reads XML Schema from an XML document and uses that schema to either create a schema for a DataSet or TempTable or verify existing schema in a DataSet, TempTable or temp-table Buffer object.

Parameters:

source - Data source.

override - If true the default mapping between XML Schema string and binary data types and ABL data types when creating an ABL temp-table schema from an XML Schema will be overritten.

mapping - A comma-delimited list of field name, data type pairs. This allows to specify the data type for a specific field.

verifyMode - Specifies how the XML will be verified against the schema. Valid values: "LOOSE" or "STRICT".

Returns:

true if operation is successful.