com.goldencode.p2j.persist.serial

Class XmlExport

java.lang.Object

com.goldencode.p2j.persist.serial.XmlExport

public final class XmlExport
extends java.lang.Object

An implementation of the 4GL WRITE-XML method, which writes the records of a temp-table into an XML stream.

Runtime support is partial at this time; not all modes and features are supported.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlExport.Escaper Implementation of the Interface that defines API for the factories stream writers use for creating "escaping writers".
static class	XmlExport.Fatal Exception to signal immediate end of export.
private static interface	XmlExport.XmlElementWriter Implementations of this interface actively write XML /XSD code.
private static interface	XmlExport.XmlWriter Implementations of this interface actively write XML /XSD code.

Field Summary

Fields

Modifier and Type	Field and Description
private static TempTableSchema.Column	AFTER_ROWID
private static java.lang.String	ATTR_NS_XSI XML namespace attribute
private static java.lang.String	ATTR_XSI_NIL Nil attribute
private java.util.Map<java.lang.String,java.util.List<java.lang.String>>	childByParent Parent -> Child table names for the NESTED relations
private java.util.Set<java.lang.String>	childFields Child fields for the current NESTED relations with FOREIGN-KEY-HIDDEN = true
private java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	childFieldsByChild Child fields for NESTED relations with FOREIGN-KEY-HIDDEN = true per child table name
private int	childRecords Number of child records just read
private static TempTableSchema.Column	DATASOURCE_ROWID
private DataSet	ds The current DataSet, if one is processed.
private java.lang.String	dsName The current DataSet name, if one is processed.
private java.lang.String	encoding Character encoding (not currently used).
private static TempTableSchema.Column	ERROR_FLAG
private static TempTableSchema.Column	ERROR_STRING
private boolean	external Flag indicating that we're creating external schema
private java.util.Map<java.lang.String,java.lang.String>	extSchemas External schemas by NS
private boolean	format Flag indicating whether XML output should be pretty-printed
private boolean	hasChild Current table has childs
private static java.lang.String	INDENT The 4GL output files use a 2-space indentation.
private int	indentLevel The indentation level.
private java.util.Map<java.lang.Integer,org.apache.commons.lang3.tuple.Pair<java.lang.String,TableMapper.LegacyIndexInfo>>	indexes The list of indexes, in order of their buffers.
private java.util.Set<DataRelation>	keyrefs We store here the DataRelations which have promoted to xsd:keyrefs.
private static java.lang.String	lineSep Platform-specific line separator
private static CentralLogger	LOG Logger
private boolean	nested Flag indicating that we're creating schema for the tested table
private static XmlExport.XmlElementWriter	NOOP noop XmlElementWriter
private static java.lang.String	NS_URI Namespace URI for XML schema
private java.lang.String	nsPrefix The current DataSet prefix, if one is processed.
private java.lang.String	nsUri The current DataSet namespace, if one is processed.
private static TempTableSchema.Column	ORIGIN_ROWID
private java.util.Map<java.lang.String,java.lang.String>	parentByChild Child -> Parent table names for the NESTED relations
private java.util.Map<java.lang.String,java.lang.String>	prefixByNs Default prefix for NS by NS
private int	prodataRelationCount Number of DataSet non PARENT-ID-RELATION relations
private java.util.Map<java.lang.String,org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String>>	prodsErrors The map with eventual error strings.
private int	relCount Number of DataSet relations
private java.lang.String	rootNsPrefix The namespace prefix for the currently exported temp-table, which is a root of the nested realtions tree
private java.lang.String	rootNsUri The namespace for the currently exported temp-table, which is a root of the nested realtions tree
private int	rootsWritten Number of dataset/tables root element written
private java.lang.String	rootTableName Root table name (for DATA-SET:WRITE-XML(SCHEMA) with SERIALIZE-HIDDEN = true
private int	rootTableRecordsWritten Number of root table records written
private static TempTableSchema.Column	ROW_STATE
private java.util.Stack<java.lang.Boolean>	savedHasChild Stack of 'hasChild' flag values
private boolean	serializeHidden The value of the DataSet SERIALIZE-HIDDEN attribute
private java.util.Map<java.lang.String,TempTableSchema>	tables The map of DATA-SET tables by legacy names
private java.util.Map<java.lang.String,java.util.List<TempTableSchema>>	tablesByNs The DATA-SET tables grouped by namespace.
private TargetData	target XML data target which normalizes access of various media to an output stream.
private java.lang.String	ttNsPrefix The namespace prefix for the currently exported temp-table, if any.
private java.util.Map<java.lang.String,TableMapper.LegacyIndexInfo>	uidxByUniqueNames Unique names for unique indexes map to their original LegacyIndexInfo objects.
private java.util.Map<TableMapper.LegacyIndexInfo,java.lang.String>	uidxUniqueNames Maps the LegacyIndexInfo objects to unique names for them, if their name is not unique across the dataset.
private javax.xml.stream.XMLStreamWriter	writer XML stream writer
private XmlExport.XmlElementWriter	writeXmlSchema XML schema writer
private java.util.Set<java.lang.String>	writtenSchemas Tables schemas already written
private boolean	xsiWritten xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" was written

Constructor Summary

Constructors

Constructor and Description
XmlExport(TargetData target, boolean formatted, java.lang.String encoding) Constructor which saves the internal data for writing a XML/XSD stream.

Method Summary

Modifier and Type	Method and Description
private void	attrFailure() Report warnings 13065/13093, and finish export.
private java.lang.String	extSchemaName(java.lang.String ns) Get the name of the external schema for the namespace.
private void	indent() Write a soft indent to the XML output stream, if formatting is enabled.
private static boolean	isEmpty(java.lang.String s) Check if the string is empty.
private void	lineBreak() Write a line break to the XML output stream, if formatting is enabled.
private boolean	serializeDsTables(boolean writeBeforeImage, boolean omitInitialValues) Serialize DataSet tables
private int	serializeTempTable(DataRelation relation, TemporaryBuffer buffer, java.lang.String rowName, java.lang.String xmlns, boolean omitInitialValues, boolean includeHidden, boolean includeProds, boolean before) Writes the content of a TEMP-TABLE to serializer.
private boolean	tables(boolean forSchema) Extract tables's data from the DATASET
private boolean	write(XmlExport.XmlWriter code, java.lang.String method, java.lang.String widgetType) The framework for writing a XML file.
private void	writeAnnotation(boolean minSchema) Write DATA-SET schema annotation
private void	writeBeforeBuffer() Write BEFORE-BUFFER data.
private BufferImpl	writeBeforeData(BufferImpl buf, TempRecord dmo) Write before data
private void	writeChildRecords(BufferImpl buf, TempRecord dmo, boolean prodsId, boolean omitInitialValues) Write child records of the current record
private boolean	writeColumnAttrs(TempTableSchema schema, TempTableSchema.Column column, java.util.SortedSet<java.lang.Integer> fields, boolean hasAttributes, boolean defaultValues, boolean minSchema, boolean isDataset) Writes the XML-SCHEMA element or attrubute of a TEMP-TABLE column to XML stream.
private void	writeColumns(Record dmo, java.lang.Iterable<TempTableSchema.Column> columns, boolean hidden, boolean noInit) Write data for the given columns from a single record into the XML output stream.
private void	writeComplexType(XmlExport.XmlElementWriter bodyWriter, XmlExport.XmlElementWriter attrWriter) Write the element.
boolean	writeDataset(DataSet dataSet, java.lang.String schemaLocation, boolean writeXmlSchema, boolean minXmlSchema, boolean writeBeforeImage, boolean omitInitialValues) Performs the export of a DATASET.
private void	writeDatasetIndexes() Write DATA-SET indexes
private void	writeDataSetKeyRefs() Write DATA-SET data relations.
boolean	writeDatasetSchema(DataSet dataSet, boolean minSchema, boolean noInitial) Performs the export of a DATASET schema.
private boolean	writeDatasetSchemaImpl(boolean minSchema, boolean defaultValues, java.lang.String nodeName) Writes a XML-SCHEMA to XML stream.
private void	writeDatum(TempTableSchema.Column column, BaseDataType datum) Write a single data value to the XML output stream, according to the instructions stored in the temp-table schema.
private void	writeDatum2(TempTableSchema.Column column, BaseDataType datum) Write a single data value to the XML output stream, according to the instructions stored in the temp-table schema.
private void	writeDsSchemaBody(java.lang.String nodeName, boolean minSchema, boolean defaultValues) Write DATA-SET schema body
private void	writeDsTables(boolean minSchema, boolean defaultValues) Write DATA-SET tables' schemas
private void	writeDsTableSchema(BufferImpl after, boolean minSchema, boolean defaultValues) Write DATA-SET table schema
private void	writeElement(java.lang.String name, XmlExport.XmlElementWriter attrWriter) Write the element.
private void	writeElement(java.lang.String name, XmlExport.XmlElementWriter attrWriter, XmlExport.XmlElementWriter bodyWriter) Write the element.
private void	writeEndElement() Write end of the element.
private boolean	writeExternalSchema(java.lang.String ns, boolean minSchema, boolean defaultValues) Write external schema for a namespace
private void	writeProdErrors() Write errors.
boolean	writeRecord(BufferImpl bufferImpl, boolean omitInitial) Writes a single record.
private void	writeRecord(TemporaryBuffer buffer, TempRecord dmo, java.lang.String rowName, TempTableSchema schema, java.lang.String xmlns, boolean hidden, boolean prodsId, boolean before, boolean omitInitialValues) Write a temp-table record's data to the XML output stream.
private void	writeSchema(java.lang.String nsPrefix, java.lang.String nsUri) Write schema element of a table/data-set.
private void	writeStartElement(java.lang.String name) Write start of the element.
private void	writeTableColums(BufferImpl buffer, TempTableSchema schema, java.lang.String tableName, boolean defaultValues, boolean minSchema, boolean inDataset, boolean isDataset) Write table schema columns
private void	writeTableElement(TempTableSchema schema, boolean minSchema, java.lang.String tableName, java.lang.String legacyName, java.lang.String xmlNodeName, java.lang.String nsPrefix, boolean isDataSet) Write element element of a table.
private boolean	writeTableSchema(BufferImpl buffer, TempTableSchema schema, boolean minSchema, boolean defaultValues) Performs the export of a TEMP-TABLE schema.
private boolean	writeTableSchema(BufferImpl buffer, TempTableSchema schema, boolean minSchema, boolean defaultValues, boolean inDataset) Performs the export of a TEMP-TABLE schema.
boolean	writeTableSchema(TemporaryBuffer buffer, boolean minSchema, boolean noInitial) Performs the export of a TEMP-TABLE schema.
private boolean	writeTableSchemaImpl(BufferImpl buffer, TempTableSchema schema, java.lang.String tableName, boolean defaultValues, boolean minSchema, boolean inDataset) Writes the XML-SCHEMA of a TEMP-TABLE to XML stream.
boolean	writeTempTable(TemporaryBuffer buffer, java.lang.String schemaLocation, boolean writeXmlSchema, boolean minXmlSchema, boolean writeBeforeImage, boolean omitInitialValues) Constructor which immediately performs the export of a TEMP-TABLE.
private void	writeTextElement(java.lang.String name, XmlExport.XmlElementWriter attrWriter, XmlExport.XmlElementWriter textWriter) Write the element with text node only.
private boolean	writeToHandle(java.util.function.Function<XmlExport,java.lang.Boolean> writer) Export to a handle.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger

INDENT

private static final java.lang.String INDENT

The 4GL output files use a 2-space indentation.

See Also:

Constant Field Values

ATTR_NS_XSI

private static final java.lang.String ATTR_NS_XSI

XML namespace attribute

See Also:

Constant Field Values

NS_URI

private static final java.lang.String NS_URI

Namespace URI for XML schema

See Also:

Constant Field Values

ATTR_XSI_NIL

private static final java.lang.String ATTR_XSI_NIL

Nil attribute

See Also:

Constant Field Values

lineSep

private static final java.lang.String lineSep

Platform-specific line separator

NOOP

private static final XmlExport.XmlElementWriter NOOP

noop XmlElementWriter

format

private final boolean format

Flag indicating whether XML output should be pretty-printed

target

private final TargetData target

XML data target which normalizes access of various media to an output stream.

encoding

private final java.lang.String encoding

Character encoding (not currently used).

external

private boolean external

Flag indicating that we're creating external schema

nested

private boolean nested

Flag indicating that we're creating schema for the tested table

writer

private javax.xml.stream.XMLStreamWriter writer

XML stream writer

indentLevel

private int indentLevel

The indentation level.

ds

private DataSet ds

The current DataSet, if one is processed. null if a table is processed.

dsName

private java.lang.String dsName

The current DataSet name, if one is processed. null if a table is processed.

nsUri

private java.lang.String nsUri

The current DataSet namespace, if one is processed. null if a table is processed.

nsPrefix

private java.lang.String nsPrefix

The current DataSet prefix, if one is processed. null if a table is processed.

serializeHidden

private boolean serializeHidden

The value of the DataSet SERIALIZE-HIDDEN attribute

relCount

private int relCount

Number of DataSet relations

prodataRelationCount

private int prodataRelationCount

Number of DataSet non PARENT-ID-RELATION relations

indexes

private final java.util.Map<java.lang.Integer,org.apache.commons.lang3.tuple.Pair<java.lang.String,TableMapper.LegacyIndexInfo>> indexes

The list of indexes, in order of their buffers.

tables

private final java.util.Map<java.lang.String,TempTableSchema> tables

The map of DATA-SET tables by legacy names

tablesByNs

private java.util.Map<java.lang.String,java.util.List<TempTableSchema>> tablesByNs

The DATA-SET tables grouped by namespace.

extSchemas

private java.util.Map<java.lang.String,java.lang.String> extSchemas

External schemas by NS

writtenSchemas

private java.util.Set<java.lang.String> writtenSchemas

Tables schemas already written

prefixByNs

private java.util.Map<java.lang.String,java.lang.String> prefixByNs

Default prefix for NS by NS

childByParent

private final java.util.Map<java.lang.String,java.util.List<java.lang.String>> childByParent

Parent -> Child table names for the NESTED relations

parentByChild

private final java.util.Map<java.lang.String,java.lang.String> parentByChild

Child -> Parent table names for the NESTED relations

childFieldsByChild

private java.util.Map<java.lang.String,java.util.Set<java.lang.String>> childFieldsByChild

Child fields for NESTED relations with FOREIGN-KEY-HIDDEN = true per child table name

childFields

private java.util.Set<java.lang.String> childFields

Child fields for the current NESTED relations with FOREIGN-KEY-HIDDEN = true

prodsErrors

private final java.util.Map<java.lang.String,org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String>> prodsErrors

The map with eventual error strings.

writeXmlSchema

private XmlExport.XmlElementWriter writeXmlSchema

XML schema writer

rootNsUri

private java.lang.String rootNsUri

The namespace for the currently exported temp-table, which is a root of the nested realtions tree

rootNsPrefix

private java.lang.String rootNsPrefix

The namespace prefix for the currently exported temp-table, which is a root of the nested realtions tree

ttNsPrefix

private java.lang.String ttNsPrefix

The namespace prefix for the currently exported temp-table, if any.

hasChild

private boolean hasChild

Current table has childs

childRecords

private int childRecords

Number of child records just read

savedHasChild

private final java.util.Stack<java.lang.Boolean> savedHasChild

Stack of 'hasChild' flag values

xsiWritten

private boolean xsiWritten

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" was written

rootsWritten

private int rootsWritten

Number of dataset/tables root element written

rootTableName

private java.lang.String rootTableName

Root table name (for DATA-SET:WRITE-XML(SCHEMA) with SERIALIZE-HIDDEN = true

rootTableRecordsWritten

private int rootTableRecordsWritten

Number of root table records written

uidxUniqueNames

private final java.util.Map<TableMapper.LegacyIndexInfo,java.lang.String> uidxUniqueNames

Maps the LegacyIndexInfo objects to unique names for them, if their name is not unique across the dataset.

uidxByUniqueNames

private final java.util.Map<java.lang.String,TableMapper.LegacyIndexInfo> uidxByUniqueNames

Unique names for unique indexes map to their original LegacyIndexInfo objects. This is the reverse of uidxUniqueNames. All unique indexes can be found here.

keyrefs

private final java.util.Set<DataRelation> keyrefs

We store here the DataRelations which have promoted to xsd:keyrefs. Those not present in this set will be serialized as prodata:relations.

ERROR_FLAG

private static final TempTableSchema.Column ERROR_FLAG

ORIGIN_ROWID

private static final TempTableSchema.Column ORIGIN_ROWID

DATASOURCE_ROWID

private static final TempTableSchema.Column DATASOURCE_ROWID

ERROR_STRING

private static final TempTableSchema.Column ERROR_STRING

AFTER_ROWID

private static final TempTableSchema.Column AFTER_ROWID

ROW_STATE

private static final TempTableSchema.Column ROW_STATE

Constructor Detail

XmlExport

public XmlExport(TargetData target,
                 boolean formatted,
                 java.lang.String encoding)

Constructor which saves the internal data for writing a XML/XSD stream.

Parameters:

target - XML data target which normalizes access of various media to an output stream.

formatted - true if serialized output should be pretty-printed for human-friendly reading; false to omit formatting.

encoding - Character encoding (not currently used).

Method Detail

writeDataset

public boolean writeDataset(DataSet dataSet,
                            java.lang.String schemaLocation,
                            boolean writeXmlSchema,
                            boolean minXmlSchema,
                            boolean writeBeforeImage,
                            boolean omitInitialValues)

Performs the export of a DATASET.

Parameters:

dataSet - The DatSet from which data is exported.

schemaLocation - Path to XML schema (not currently used).

writeXmlSchema - true to write XML schema information; false to write only data. If true, schema will be written to schemaLocation, if provided; if not provided, schema will be embedded in XML output. Not currently honored.

minXmlSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false. Not currently honored.

writeBeforeImage - Not currently honored.

omitInitialValues - If true, record values which match default initial values will be omitted from serialized output, else they will be included. Not currently honored.

Returns:

true on success. Otherwise the error is already dispatched to ErrorManager before returning.

serializeDsTables

private boolean serializeDsTables(boolean writeBeforeImage,
                                  boolean omitInitialValues)

Serialize DataSet tables

Parameters:

writeBeforeImage - Not currently honored.

omitInitialValues - If true, record values which match default initial values will be omitted from serialized output, else they will be included. Not currently honored.

Returns:

true if at least of the tables has changes

writeProdErrors

private void writeProdErrors()
                      throws javax.xml.stream.XMLStreamException

Write errors.

Throws:

javax.xml.stream.XMLStreamException - on Error

writeTempTable

public boolean writeTempTable(TemporaryBuffer buffer,
                              java.lang.String schemaLocation,
                              boolean writeXmlSchema,
                              boolean minXmlSchema,
                              boolean writeBeforeImage,
                              boolean omitInitialValues)

Constructor which immediately performs the export of a TEMP-TABLE.

Parameters:

buffer - Temp-table buffer from which data is exported.

schemaLocation - Path to XML schema (not currently used).

writeXmlSchema - true to write XML schema information; false to write only data. If true, schema will be written to schemaLocation, if provided; if not provided, schema will be embedded in XML output. Not currently honored.

minXmlSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false. Not currently honored.

writeBeforeImage - Not currently honored.

omitInitialValues - If true, record values which match default initial values will be omitted from serialized output, else they will be included. Not currently honored.

Returns:

true on success. Otherwise the error is already dispatched to ErrorManager before returning.

writeDatasetSchema

public boolean writeDatasetSchema(DataSet dataSet,
                                  boolean minSchema,
                                  boolean noInitial)

Performs the export of a DATASET schema.

Parameters:

dataSet - The DatSet to be described.

minSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false. Not currently honored.

noInitial - If true, record values which match default initial values will be omitted from serialized output, else they will be included. Not currently honored.

Returns:

true on success. Otherwise, the error is already dispatched to ErrorManager before returning.

tables

private boolean tables(boolean forSchema)

Extract tables's data from the DATASET

Parameters:

forSchema - Flag indicating that data is extracted for WRITE-XMLSCHEMA

Returns:

true if OK.

writeTableSchema

public boolean writeTableSchema(TemporaryBuffer buffer,
                                boolean minSchema,
                                boolean noInitial)

Performs the export of a TEMP-TABLE schema.

Parameters:

buffer - A buffer of a TempTable to be described.

minSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false.

noInitial - If true, record values which match default initial values will be omitted from serialized output, else they will be included. Not currently honored.

Returns:

true on success. Otherwise, the error is already dispatched to ErrorManager before returning.

writeRecord

public boolean writeRecord(BufferImpl bufferImpl,
                           boolean omitInitial)

Writes a single record.

Parameters:

bufferImpl - The buffer which holds the record to be exported.

omitInitial - If true the unmodified fields (those that are equals to the declared initial value) are skipped in order to minimize the output.

Returns:

true if operation is successful and false if an error occurred.

writeToHandle

private boolean writeToHandle(java.util.function.Function<XmlExport,java.lang.Boolean> writer)

Export to a handle. Only X-Document is currently supported.

Parameters:

writer - The writer function.

Returns:

true if the export was successful.

writeTableSchema

private boolean writeTableSchema(BufferImpl buffer,
                                 TempTableSchema schema,
                                 boolean minSchema,
                                 boolean defaultValues)
                          throws javax.xml.stream.XMLStreamException

Performs the export of a TEMP-TABLE schema.

Parameters:

buffer - A buffer of a TempTable to be described.

schema - The schema of the TEMP-TABLE.

minSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false. Not currently honored.

defaultValues - If true, record values which match default initial values will be omitted from serialized output, else they will be included. NOTE: actually setting [defaultValues] to [TRUE] which is the [omit-initial-values] from ABL will cause some extra info to be added in field description (see + attributes):

                   <xsd:element name="f11" type="xsd:string" nillable="true"  +minOccurs="0" +default=""/>
                   <xsd:element name="f12" type="xsd:int" nillable="true"     +minOccurs="0" +default="0"/>
                   <xsd:element name="f13" type="xsd:date" nillable="true"    +minOccurs="0" +prodata:initial="prodata:unknown"/>
                   <xsd:element name="f14" type="xsd:decimal" nillable="true" +minOccurs="0" +default="0.0"/>
                

Returns:

true on success. Otherwise the error is already dispatched to ErrorManager before returning.

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occur.

writeTableSchema

private boolean writeTableSchema(BufferImpl buffer,
                                 TempTableSchema schema,
                                 boolean minSchema,
                                 boolean defaultValues,
                                 boolean inDataset)
                          throws javax.xml.stream.XMLStreamException

Performs the export of a TEMP-TABLE schema.

Parameters:

buffer - A buffer of a TempTable to be described.

schema - The schema of the TEMP-TABLE.

minSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false. Not currently honored.

defaultValues - If true, record values which match default initial values will be omitted from serialized output, else they will be included. NOTE: actually setting [defaultValues] to [TRUE] which is the [omit-initial-values] from ABL will cause some extra info to be added in field description (see + attributes):

                   <xsd:element name="f11" type="xsd:string" nillable="true"  +minOccurs="0" +default=""/>
                   <xsd:element name="f12" type="xsd:int" nillable="true"     +minOccurs="0" +default="0"/>
                   <xsd:element name="f13" type="xsd:date" nillable="true"    +minOccurs="0" +prodata:initial="prodata:unknown"/>
                   <xsd:element name="f14" type="xsd:decimal" nillable="true" +minOccurs="0" +default="0.0"/>
                

inDataset - If true, this is part of a dataset SCHEMA and additional attributes will be written.

Returns:

true on success. Otherwise the error is already dispatched to ErrorManager before returning.

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occur.

writeStartElement

private void writeStartElement(java.lang.String name)
                        throws javax.xml.stream.XMLStreamException

Write start of the element.

Parameters:

name - element name.

Throws:

javax.xml.stream.XMLStreamException

writeComplexType

private void writeComplexType(XmlExport.XmlElementWriter bodyWriter,
                              XmlExport.XmlElementWriter attrWriter)
                       throws javax.xml.stream.XMLStreamException

Write the element.

Parameters:

bodyWriter - body writer

attrWriter - attributes' writer

Throws:

javax.xml.stream.XMLStreamException

writeElement

private void writeElement(java.lang.String name,
                          XmlExport.XmlElementWriter attrWriter)
                   throws javax.xml.stream.XMLStreamException

Write the element.

Parameters:

name - element name.

attrWriter - attributes' writer

Throws:

javax.xml.stream.XMLStreamException

writeTextElement

private void writeTextElement(java.lang.String name,
                              XmlExport.XmlElementWriter attrWriter,
                              XmlExport.XmlElementWriter textWriter)
                       throws javax.xml.stream.XMLStreamException

Write the element with text node only.

Parameters:

name - element name.

textWriter - attributes' writer

Throws:

javax.xml.stream.XMLStreamException

writeElement

private void writeElement(java.lang.String name,
                          XmlExport.XmlElementWriter attrWriter,
                          XmlExport.XmlElementWriter bodyWriter)
                   throws javax.xml.stream.XMLStreamException

Write the element.

Parameters:

name - element name.

attrWriter - attributes' writer

bodyWriter - body writer

Throws:

javax.xml.stream.XMLStreamException

writeEndElement

private void writeEndElement()
                      throws javax.xml.stream.XMLStreamException

Write end of the element.

Throws:

javax.xml.stream.XMLStreamException

writeTableElement

private void writeTableElement(TempTableSchema schema,
                               boolean minSchema,
                               java.lang.String tableName,
                               java.lang.String legacyName,
                               java.lang.String xmlNodeName,
                               java.lang.String nsPrefix,
                               boolean isDataSet)
                        throws javax.xml.stream.XMLStreamException

Write element element of a table.

Parameters:

schema - table schema.

minSchema - true to write minimal schema information; false to write verbose schema information.

tableName - table name.

legacyName - table legacy name.

xmlNodeName - table XML node name.

nsPrefix - table XML prefix.

isDataSet - flag indicating that the table is a part of a data-set.

Throws:

javax.xml.stream.XMLStreamException - on error

writeSchema

private void writeSchema(java.lang.String nsPrefix,
                         java.lang.String nsUri)
                  throws javax.xml.stream.XMLStreamException

Write schema element of a table/data-set.

Parameters:

nsPrefix - XML prefix of a table/data-set.

nsUri - XML namespace URI of a table/data-set.

Throws:

javax.xml.stream.XMLStreamException - on error.

writeDatasetSchemaImpl

private boolean writeDatasetSchemaImpl(boolean minSchema,
                                       boolean defaultValues,
                                       java.lang.String nodeName)
                                throws javax.xml.stream.XMLStreamException

Writes a XML-SCHEMA to XML stream.

Parameters:

minSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false. Not currently honored.

defaultValues - If true, the initial values for the fields will be written.

nodeName - The DataSet's node name.

Returns:

true on success. Otherwise the error is already dispatched to ErrorManager before returning.

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occurs.

writeDsSchemaBody

private void writeDsSchemaBody(java.lang.String nodeName,
                               boolean minSchema,
                               boolean defaultValues)
                        throws javax.xml.stream.XMLStreamException

Write DATA-SET schema body

Parameters:

minSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false. Not currently honored.

defaultValues - If true, the initial values for the fields will be written.

nodeName - The DataSet's node name.

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occurs.

writeDsTables

private void writeDsTables(boolean minSchema,
                           boolean defaultValues)
                    throws javax.xml.stream.XMLStreamException

Write DATA-SET tables' schemas

Parameters:

minSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false. Not currently honored.

defaultValues - If true, the initial values for the fields will be written.

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occurs.

writeDsTableSchema

private void writeDsTableSchema(BufferImpl after,
                                boolean minSchema,
                                boolean defaultValues)
                         throws javax.xml.stream.XMLStreamException

Write DATA-SET table schema

Parameters:

after - table buffer.

minSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false. Not currently honored.

defaultValues - If true, the initial values for the fields will be written.

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occurs.

writeAnnotation

private void writeAnnotation(boolean minSchema)
                      throws javax.xml.stream.XMLStreamException

Write DATA-SET schema annotation

Parameters:

minSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false. Not currently honored.

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occurs.

writeDataSetKeyRefs

private void writeDataSetKeyRefs()
                          throws javax.xml.stream.XMLStreamException

Write DATA-SET data relations.

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occurs.

writeDatasetIndexes

private void writeDatasetIndexes()
                          throws javax.xml.stream.XMLStreamException

Write DATA-SET indexes

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occurs.

writeExternalSchema

private boolean writeExternalSchema(java.lang.String ns,
                                    boolean minSchema,
                                    boolean defaultValues)
                             throws javax.xml.stream.XMLStreamException

Write external schema for a namespace

Parameters:

ns - namespace

minSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false. Not currently honored.

defaultValues - If true, the initial values for the fields will be written.

Returns:

name of the schema file

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occur.

extSchemaName

private java.lang.String extSchemaName(java.lang.String ns)

Get the name of the external schema for the namespace.

Parameters:

ns - namespace

Returns:

the name of the external schema for the namespace

writeTableSchemaImpl

private boolean writeTableSchemaImpl(BufferImpl buffer,
                                     TempTableSchema schema,
                                     java.lang.String tableName,
                                     boolean defaultValues,
                                     boolean minSchema,
                                     boolean inDataset)
                              throws javax.xml.stream.XMLStreamException

Writes the XML-SCHEMA of a TEMP-TABLE to XML stream.

Parameters:

buffer - The buffer that identifies the TEMP-TABLE to be described.

schema - The schema of the TEMP-TABLE.

tableName - The name of the table.

defaultValues - If true the initial values are written for the fields that declared them.

minSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false.

inDataset - If true, this is part of a dataset SCHEMA and additional attributes will be written.

Returns:

true on success. Otherwise the error is already dispatched to ErrorManager before returning.

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occurs.

writeTableColums

private void writeTableColums(BufferImpl buffer,
                              TempTableSchema schema,
                              java.lang.String tableName,
                              boolean defaultValues,
                              boolean minSchema,
                              boolean inDataset,
                              boolean isDataset)
                       throws javax.xml.stream.XMLStreamException

Write table schema columns

Parameters:

buffer - The buffer that identifies the TEMP-TABLE to be described.

schema - The schema of the TEMP-TABLE.

tableName - The name of the table.

defaultValues - If true the initial values are written for the fields that declared them.

minSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false.

inDataset - If true, this is part of a dataset SCHEMA and additional attributes will be written.

isDataset - Flag indicating that the table is a part of a dataset.

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occurs.

writeBeforeBuffer

private void writeBeforeBuffer()
                        throws javax.xml.stream.XMLStreamException

Write BEFORE-BUFFER data.

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occurs.

writeColumnAttrs

private boolean writeColumnAttrs(TempTableSchema schema,
                                 TempTableSchema.Column column,
                                 java.util.SortedSet<java.lang.Integer> fields,
                                 boolean hasAttributes,
                                 boolean defaultValues,
                                 boolean minSchema,
                                 boolean isDataset)
                          throws javax.xml.stream.XMLStreamException

Writes the XML-SCHEMA element or attrubute of a TEMP-TABLE column to XML stream.

Parameters:

schema - The schema of the TEMP-TABLE.

defaultValues - If true the initial values are written for the fields that declared them.

column - The table column in question

fields - Sorted set of the taable fields ORDERs (to calculate userOrder attribute)

hasAttributes - Flag indicating that schema contains attributes

minSchema - true to write minimal schema information; false to write verbose schema information. Ignored if writeXmlSchema is false.

isDataset - If true, this is part of a dataset SCHEMA and additional attributes will be written.

Returns:

true on success. Otherwise the error is already dispatched to ErrorManager before returning.

Throws:

javax.xml.stream.XMLStreamException - If XML-related issued occurs.

serializeTempTable

private int serializeTempTable(DataRelation relation,
                               TemporaryBuffer buffer,
                               java.lang.String rowName,
                               java.lang.String xmlns,
                               boolean omitInitialValues,
                               boolean includeHidden,
                               boolean includeProds,
                               boolean before)

Writes the content of a TEMP-TABLE to serializer.

Parameters:

relation - The relation on which this buffer is a child of.

buffer - The buffer to be used for accessing TEMP-TABLE records.

rowName - The name of the XML element that holds a record.

xmlns - The XML namespace uri, is set.

omitInitialValues - Flag indicating that initial values should be not serilaized

includeHidden - If true, the hidden fields will also be dumped.

includeProds - If true, the PROGRESS specific attribute will be written.

before - This is a BEFORE table. Rows written will be slightly decorated.

Returns:

number of processed records on success. Otherwise the error is already dispatched to ErrorManager before returning.

writeRecord

private void writeRecord(TemporaryBuffer buffer,
                         TempRecord dmo,
                         java.lang.String rowName,
                         TempTableSchema schema,
                         java.lang.String xmlns,
                         boolean hidden,
                         boolean prodsId,
                         boolean before,
                         boolean omitInitialValues)

Write a temp-table record's data to the XML output stream.

Parameters:

buffer - The buffer being serialized.

dmo - Object containing temp-table record's data.

rowName - Name applied to the element or attribute associated with the row data in the XML output.

schema - The table schema to be used.

xmlns - The XML namespace uri, is set.

hidden - If true include the hidden fields (__name__) for each record written to stream.

prodsId - If true include the prods:id attribute for each record written.

before - true if a BEFORE-TABLE record is processed.

writeBeforeData

private BufferImpl writeBeforeData(BufferImpl buf,
                                   TempRecord dmo)
                            throws javax.xml.stream.XMLStreamException

Write before data

Parameters:

buf - The buffer being serialized.

dmo - Object containing temp-table record's data.

Throws:

javax.xml.stream.XMLStreamException - on error

writeChildRecords

private void writeChildRecords(BufferImpl buf,
                               TempRecord dmo,
                               boolean prodsId,
                               boolean omitInitialValues)

Write child records of the current record

Parameters:

buf - The buffer being serialized.

dmo - Object containing temp-table record's data.

prodsId - If true include the prods:id attribute for each record written.

omitInitialValues - Flag indicating that initial values should be not serilaized

writeColumns

private void writeColumns(Record dmo,
                          java.lang.Iterable<TempTableSchema.Column> columns,
                          boolean hidden,
                          boolean noInit)
                   throws java.lang.IllegalAccessException,
                          java.lang.IllegalArgumentException,
                          java.lang.reflect.InvocationTargetException,
                          javax.xml.stream.XMLStreamException

Write data for the given columns from a single record into the XML output stream.

Parameters:

dmo - The DMO to be serialized.

columns - The set of columns for that DMO.

hidden - If true include the hidden fields (__name__) for each record written to stream.

Throws:

java.lang.IllegalAccessException - if a DMO getter method cannot be accessed using reflection.

java.lang.IllegalArgumentException - if an illegal argument is passed to the DMO getter method for a column.

java.lang.reflect.InvocationTargetException - if there is a problem invoking a getter method on the given DMO.

javax.xml.stream.XMLStreamException - if there is an error writing to the XML stream.

writeDatum

private void writeDatum(TempTableSchema.Column column,
                        BaseDataType datum)
                 throws javax.xml.stream.XMLStreamException

Write a single data value to the XML output stream, according to the instructions stored in the temp-table schema.

This version ensures that the group and decimal separators are ',' and '.' for the duration of the serialization.

Parameters:

column - Temp-table column schema information.

datum - Datum to be written to XML output.

Throws:

javax.xml.stream.XMLStreamException - if there is an error writing to the XML stream.

writeDatum2

private void writeDatum2(TempTableSchema.Column column,
                         BaseDataType datum)
                  throws javax.xml.stream.XMLStreamException

Write a single data value to the XML output stream, according to the instructions stored in the temp-table schema.

Parameters:

column - Temp-table column schema information.

datum - Datum to be written to XML output.

Throws:

javax.xml.stream.XMLStreamException - if there is an error writing to the XML stream.

lineBreak

private void lineBreak()
                throws javax.xml.stream.XMLStreamException

Write a line break to the XML output stream, if formatting is enabled.

Throws:

javax.xml.stream.XMLStreamException - if there is an error writing to the XML stream.

indent

private void indent()
             throws javax.xml.stream.XMLStreamException

Write a soft indent to the XML output stream, if formatting is enabled.

Throws:

javax.xml.stream.XMLStreamException - if there is an error writing to the XML stream.

write

private boolean write(XmlExport.XmlWriter code,
                      java.lang.String method,
                      java.lang.String widgetType)

The framework for writing a XML file. Will open the stream specified by target with requested encoding, write XML header and allow the code to write the XML body (main element). At the end, the end of document is written and the file is closed.

In case that the code exit abruptly, the expected Exception s are catched as a last resort and the stack trace is printed.

Parameters:

code - The code to be executed. It should build the actual XML content.

method - The identifier for the method using the source stream. Only used for composing the error messages.

widgetType - The parent widget. Only used for composing the error messages.

Returns:

true on success. Otherwise the error is already dispatched to ErrorManager before returning.

attrFailure

private void attrFailure()

Report warnings 13065/13093, and finish export. This is how 4GL does on DATA-SET:WRITE-XML when the DATA-SET:SERIALIZE-HIDDEN =- true and the the first table contains fields with XML-NODE-TYPE 'attribute'.

isEmpty

private static boolean isEmpty(java.lang.String s)

Check if the string is empty.

Parameters:

s - String to be checked

Returns:

true if the string is empty