DXmlDocumentWriter

Overview

Package

Class

Tree

Deprecated

Index

Help

TPTP 4.5.0 Platform Project
Internal API Specification

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.tptp.platform.report.drivers.xml.internal
Class DXmlDocumentWriter

java.lang.Object
  org.eclipse.tptp.platform.report.extension.internal.DExtensible
      org.eclipse.tptp.platform.report.tools.internal.DParser
          org.eclipse.tptp.platform.report.drivers.xml.internal.DXmlDocumentWriter

All Implemented Interfaces:: IWriter

Deprecated. As of TPTP 4.5.0, use the TPTP Business Intelligence and Reporting Tools (BIRT) reporting infrastructure (org.eclipse.tptp.platform.report.birt).

public class DXmlDocumentWriter
extends DParser
implements IWriter
extends DParser
implements IWriter

Provides an object to write JScrib document in an XML format.
The following example writes a JScrib IDDocument item in an xml file named 'myfile.rxml'.

    IDDocument doc = new DDocument();
    ...
    DXmlWriter aw = new DXmlWriter();
    try{
        aw.write( new FileOutputStream("myfile.rxml"), doc );
        // Good, the file is generated 
        ...
    }
    catch(Exception e ) 
    {
      // An error occurs in the writer
      ...
    }

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.tptp.platform.report.tools.internal.DParser
`DParser.ParserException`

Nested classes/interfaces inherited from class org.eclipse.tptp.platform.report.extension.internal.DExtensible
`DExtensible.InvokeMethod`

Field Summary
`protected java.util.ArrayList`	`folder_model_written_` Deprecated.

Fields inherited from class org.eclipse.tptp.platform.report.extension.internal.DExtensible
`mapMethod, paramTab`

Constructor Summary
`DXmlDocumentWriter()` Deprecated. Create a JScrib XML writer, by default auto indent mode is not engaged.

Method Summary
`void`	`clear()` Deprecated. Clears all internal datas.
`void`	`doMethod(java.lang.Boolean v, DExtensible ext, java.lang.Object arg)` Deprecated. write xml for Boolean objects.
`void`	`doMethod(java.lang.Byte v, DExtensible ext, java.lang.Object arg)` Deprecated. write xml for Byte objects.
`void`	`doMethod(java.lang.Class c, DExtensible ext, java.lang.Object arg)` Deprecated. write xml for Class object, onl name of class is save
`void`	`doMethod(DAlignmentPair align, DExtensible p, java.lang.Object arg)` Deprecated. Write DAlignmentPair value
`void`	`doMethod(java.util.Date date, DExtensible ext, java.lang.Object arg)` Deprecated. write xml for java.util.Date, save the time in milliseconds
`void`	`doMethod(DAxis a, DExtensible p, java.lang.Object arg)` Deprecated. Writes xml for a DAxis
`void`	`doMethod(DCategory event, DExtensible ext, java.lang.Object arg)` Deprecated. Writes DCategory element
`void`	`doMethod(DCoord c, DExtensible p, java.lang.Object arg)` Deprecated. Writes xml for a DCoord
`void`	`doMethod(DCoordObject c, DExtensible p, java.lang.Object arg)` Deprecated. Writes xml for a DCoord
`void`	`doMethod(DCurve c, DExtensible p, java.lang.Object arg)` Deprecated. Writes xml for a DCurve
`void`	`doMethod(DDocument d, DExtensible p, java.lang.Object arg)` Deprecated. Writes xml for a DDocument.
`void`	`doMethod(com.ibm.icu.text.DecimalFormat df, DExtensible ext, java.lang.Object arg)` Deprecated. write xml for DecimalFormat save pattern
`void`	`doMethod(DGraphic g, DExtensible p, java.lang.Object arg)` Deprecated. Writes xml for a DGraphic
`void`	`doMethod(DMarkerLine ml, DExtensible p, java.lang.Object arg)` Deprecated. Writes 'markerLine' element
`void`	`doMethod(DMarkerRegion ml, DExtensible p, java.lang.Object arg)` Deprecated. Writes 'markerRegion' element
`void`	`doMethod(java.lang.Double v, DExtensible ext, java.lang.Object arg)` Deprecated. write xml for Double objects.
`void`	`doMethod(DPalettes pal, DExtensible p, java.lang.Object arg)` Deprecated. Writes 'palettes' node
`void`	`doMethod(DPoint p, DExtensible prs, java.lang.Object arg)` Deprecated. Writes xml for a DPoint
`void`	`doMethod(java.lang.Float v, DExtensible ext, java.lang.Object arg)` Deprecated. write xml for Float objects.
`void`	`doMethod(IDStringSerializable i, DExtensible ext, java.lang.Object arg)` Deprecated. aml dump for IDStringSerializable class, write as cdata the writeXml() result.
`void`	`doMethod(IDXmlSerializable i, DExtensible ext, java.lang.Object arg)` Deprecated. aml dump for IDXmlSerializable class, write as cdata the writeXml() result.
`void`	`doMethod(java.lang.Integer v, DExtensible ext, java.lang.Object arg)` Deprecated. write xml for Integer objects.
`void`	`doMethod(java.lang.Long v, DExtensible ext, java.lang.Object arg)` Deprecated. write xml for Long objects.
`void`	`doMethod(java.lang.Short v, DExtensible ext, java.lang.Object arg)` Deprecated. write xml for Short v.
`void`	`doMethod(com.ibm.icu.text.SimpleDateFormat df, DExtensible ext, java.lang.Object arg)` Deprecated. write xml for SimpleDateFormat save pattern
`void`	`doMethod(java.lang.String str, DExtensible ext, java.lang.Object arg)` Deprecated. encode string using any '&xx;' xml entity and dump coded string
`static java.lang.String`	`encode(java.lang.String s)` Deprecated. Encodes given string replacing a trap character by their xml entity names (ie > by >, & by &).
`static java.lang.String`	`EncodeColor(IDColor c)` Deprecated. encode IDColor into a 6 hexa-digit string RRGGBB
`void`	`endElement()` Deprecated. Closes a previously started element, choose the best way to write the end ("/>" or "</ELM>", depending on data collected such as outCData was called.
`java.io.OutputStream`	`getOutputStream()` Deprecated.
`java.lang.String`	`getRootElementName()` Deprecated. Modifying this name means you need to modify it in DXmlReader
`boolean`	`isAutoIndentMode()` Deprecated.
`boolean`	`isWriteCompleteDocument()` Deprecated.
`void`	`outAttribute(java.lang.String attr_name, boolean attr_value)` Deprecated. Write boolean attribute
`void`	`outAttribute(java.lang.String attr_name, boolean attr_value, boolean default_value)` Deprecated. Writes a boolean attribute, if value differ than default one.
`void`	`outAttribute(java.lang.String attr_name, double attr_value)` Deprecated. Writes float attribute.
`void`	`outAttribute(java.lang.String attr_name, double attr_value, double default_value)` Deprecated. Writes a float attribute, if value differ than default one.
`void`	`outAttribute(java.lang.String attr_name, float attr_value)` Deprecated. Writes float attribute.
`void`	`outAttribute(java.lang.String attr_name, float attr_value, float default_value)` Deprecated. Writes a float attribute, if value differ than default one.
`void`	`outAttribute(java.lang.String attr_name, int attr_value)` Deprecated. Writes an integer attribute
`void`	`outAttribute(java.lang.String attr_name, int attr_value, int default_value)` Deprecated. Writes an integer attribute, if value differ than default one.
`void`	`outAttribute(java.lang.String attr_name, java.lang.String attr_value, boolean required)` Deprecated. Writes an attribute in current element.
`void`	`outAttribute(java.lang.String attr_name, java.lang.String attr_value, java.lang.String default_value)` Deprecated. Writes an attribute only if value differ than default (do nothing if value is null)
`void`	`outCData(java.lang.String data)` Deprecated. Writes CData: text outside element area (>..
`protected void`	`outIndent(int idt)` Deprecated. Writes a \n and a number of space depending on parameter, if auto indent mode is engaged.
`void`	`outPropertyAttr(java.lang.String attr_name, DPropertyStore ps, java.lang.String key)` Deprecated. Writes a property contained in a property store as an element attribute only if the key property exists in the property store
`void`	`outPropertyAttr(java.lang.String attr_name, DPropertyStore ps, java.lang.String key, boolean default_value)` Deprecated. Writes a property contained in a property store as an element attribute only if the key property exists in the property store
`void`	`outPropertyAttr(java.lang.String attr_name, DPropertyStore ps, java.lang.String key, double default_value)` Deprecated. Writes a property contained in a property store as an element attribute only if the key property exists in the property store
`void`	`outPropertyAttr(java.lang.String attr_name, DPropertyStore ps, java.lang.String key, float default_value)` Deprecated. Writes a property contained in a property store as an element attribute only if the key property exists in the property store
`void`	`outPropertyAttr(java.lang.String attr_name, DPropertyStore ps, java.lang.String key, int default_value)` Deprecated. Writes a property contained in a property store as an element attribute only if the key property exists in the property store
`void`	`outPropertyAttr(java.lang.String attr_name, DPropertyStore ps, java.lang.String key, java.lang.String default_value)` Deprecated. Writes a property contained in a property store as an element attribute only if the key property exists in the property store
`void`	`setAutoIndentMode(boolean b)` Deprecated. Change current value of auto indent mode, is this mode xml elements will be indented using spaces if they don't contains CData.
`void`	`setWriteCompleteDocument(boolean b)` Deprecated. Change 'complete document' mode.
`void`	`startElement(java.lang.String name)` Deprecated. Calls this to start an XML element, do the ouput and data used to close the element correctly.
`void`	`startElement(java.lang.String name, IDItem item)` Deprecated. Starts element and write common IDItem attribute (style).
`void`	`write(java.io.OutputStream output, IDObject object)` Deprecated. Writes an IDObject in OutputStream in XML Formal.
`void`	`write(java.io.OutputStream output, IDObject[] objects)` Deprecated. Writes an IDObject array in the OutputStream in XML format
`protected void`	`writeAxes(DGraphic g, DExtensible p, java.lang.Object arg)` Deprecated. Writes 'axes' node
`protected void`	`writeCategories(DAxis a, DExtensible p, java.lang.Object arg)` Deprecated. Writes 'category' element
`protected void`	`writeChartTitle(DGraphic g, DExtensible p, java.lang.Object arg)` Deprecated. Writes 'chartTitle' node
`protected void`	`writeCurves(DGraphic g, DExtensible p, java.lang.Object arg)` Deprecated. Writes 'curves' node
`protected void`	`writeLabelFormat(DAxis a, DExtensible p, java.lang.Object arg)` Deprecated. Writes 'labelFormat' element
`protected void`	`writeLegend(DGraphic g, DExtensible p, java.lang.Object arg)` Deprecated. Writes 'legend' node
`protected void`	`writeMajorUnit(DAxis a, DExtensible p, java.lang.Object arg)` Deprecated. Writes 'majorUnit' element
`protected void`	`writeMinorUnit(DAxis a, DExtensible p, java.lang.Object arg)` Deprecated. Writes 'minorUnit' element
`protected void`	`writePlotArea(DGraphic g, DExtensible p, java.lang.Object arg)` Deprecated. Writes 'plotArea' node

Methods inherited from class org.eclipse.tptp.platform.report.tools.internal.DParser
`doChildrenItem, doMethod, doMethod, doMethod, getListLevel, getTitleLevel`

Methods inherited from class org.eclipse.tptp.platform.report.extension.internal.DExtensible
`doMethod, getDoMethod, installDoMethod, installDoMethods, installDoMethods, invokeDoMethod, invokeSuperDoMethod, removeDoMethod, removeDoMethod, removeDoMethods, removeDoMethods, resolveDoMethod`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

folder_model_written_

protected java.util.ArrayList folder_model_written_

Deprecated.

Constructor Detail

DXmlDocumentWriter

public DXmlDocumentWriter()

Deprecated.

Create a JScrib XML writer, by default auto indent mode is not engaged.

See Also:: setAutoIndentMode(boolean)

Method Detail

getOutputStream

public java.io.OutputStream getOutputStream()

Deprecated.

Returns:: current used output stream

isAutoIndentMode

public boolean isAutoIndentMode()

Deprecated.

Returns:: true if auto indent mode is engaged.
See Also:: setAutoIndentMode(boolean)

setAutoIndentMode

public void setAutoIndentMode(boolean b)

Deprecated.

Change current value of auto indent mode, is this mode xml elements will be indented using spaces if they don't contains CData. Using this mode produce more human readable stream (files), but their size will grow. (depending on the number of element and max element stack level encountered, but a rate from 10% to 50% seems to be common).

See Also:: outCData(java.lang.String)

isWriteCompleteDocument

public boolean isWriteCompleteDocument()

Deprecated.

Returns:: true if writer will write complete jscrib xml document for each write() calls

setWriteCompleteDocument

public void setWriteCompleteDocument(boolean b)

Deprecated.

Change 'complete document' mode.
Default value is true. If parameter is true, next call to write() method will generate a complete XML document including <?xml ...>, <JSCRIB> and registries elements. In this mode all colors, fonts, styles and any registries seen in write() parameter are merged into current writer's registries, and written once at the end of XML document.
If parameter is false, next call to write() method will generate only the part of XML elements corresponding to given IDObject. In this mode any colors, fonts, styles are merged into writer's registries but no output of writer's registries are done. But any registries seen in write() call parameters is generated as simple object.

getRootElementName

public java.lang.String getRootElementName()

Deprecated.

Modifying this name means you need to modify it in DXmlReader

Returns:: xml root element name for jscrib, default is 'JSCRIB'.

write

public void write(java.io.OutputStream output,
                  IDObject[] objects)
           throws java.lang.Exception

Deprecated.

Writes an IDObject array in the OutputStream in XML format

Specified by:: write in interface IWriter

Throws:: java.lang.Exception

write

public void write(java.io.OutputStream output,
                  IDObject object)
           throws java.lang.Exception

Deprecated.

Writes an IDObject in OutputStream in XML Formal.

Specified by:: write in interface IWriter

Throws:: java.lang.Exception
See Also:: write(OutputStream, IDObject[]).

clear

public void clear()

Deprecated.

Clears all internal datas.

Specified by:: clear in interface IWriter
Overrides:: clear in class DParser

See Also:: DParser.clear()

outIndent

protected void outIndent(int idt)
                  throws java.io.IOException

Deprecated.

Writes a \n and a number of space depending on parameter, if auto indent mode is engaged.

Parameters:: idt - proportinal to the number of space to write.
Throws:: java.io.IOException - is the ouput failed.

startElement

public void startElement(java.lang.String name)

Deprecated.

Calls this to start an XML element, do the ouput and data used to close the element correctly. Support for indentation.

Parameters:: name - the name of the element to start.
See Also:: endElement(), outAttribute(java.lang.String, java.lang.String, boolean)

endElement

public void endElement()

Deprecated.

Closes a previously started element, choose the best way to write the end ("/>" or "</ELM>", depending on data collected such as outCData was called.

See Also:: startElement(java.lang.String), outCData(java.lang.String)

outCData

public void outCData(java.lang.String data)

Deprecated.

Writes CData: text outside element area (>..<), text is encoded and converted to UTF-8 before wrote. You must call this if you want auto indentation works correctly.

Parameters:: data - the text to write.

outAttribute

public void outAttribute(java.lang.String attr_name,
                         java.lang.String attr_value,
                         boolean required)

Deprecated.

Writes an attribute in current element. If required and value is null, an error is thrown, if not required and the value is null and error is thrown.

Parameters:: attr_name - the name of the attribute; attr_value - the value of the attribute

outAttribute

public final void outAttribute(java.lang.String attr_name,
                               java.lang.String attr_value,
                               java.lang.String default_value)

Deprecated.

Writes an attribute only if value differ than default (do nothing if value is null)

Parameters:: attr_name - the name of the attribute; attr_value - the value of the attribute; default_value - the default value, if equals to the value, no output are done.

outAttribute

public final void outAttribute(java.lang.String attr_name,
                               int attr_value)

Deprecated.

Writes an integer attribute

Parameters:: attr_name - the name of the attribute; attr_value - the value of the attribute

outAttribute

public final void outAttribute(java.lang.String attr_name,
                               int attr_value,
                               int default_value)

Deprecated.

Writes an integer attribute, if value differ than default one.

Parameters:: attr_name - the name of the attribute; attr_value - the value of the attribute; default_value - the default value, if equals to the value, no output are done.

outAttribute

public final void outAttribute(java.lang.String attr_name,
                               boolean attr_value)

Deprecated.

Write boolean attribute

Parameters:: attr_name - the name of the attribute; attr_value - the value of the attribute

outAttribute

public final void outAttribute(java.lang.String attr_name,
                               boolean attr_value,
                               boolean default_value)

Deprecated.

Writes a boolean attribute, if value differ than default one.

Parameters:: attr_name - the name of the attribute; attr_value - the value of the attribute; default_value - the default value, if equals to the value, no output are done.

outAttribute

public final void outAttribute(java.lang.String attr_name,
                               float attr_value)

Deprecated.

Writes float attribute.

Parameters:: attr_name - the name of the attribute; attr_value - the value of the attribute

outAttribute

public final void outAttribute(java.lang.String attr_name,
                               float attr_value,
                               float default_value)

Deprecated.

Writes a float attribute, if value differ than default one.

Parameters:: attr_name - the name of the attribute; attr_value - the value of the attribute; default_value - the default value, if equals to the value, no output are done.

outAttribute

public final void outAttribute(java.lang.String attr_name,
                               double attr_value)

Deprecated.

Writes float attribute.

Parameters:: attr_name - the name of the attribute; attr_value - the value of the attribute

outAttribute

public final void outAttribute(java.lang.String attr_name,
                               double attr_value,
                               double default_value)

Deprecated.

Writes a float attribute, if value differ than default one.

Parameters:: attr_name - the name of the attribute; attr_value - the value of the attribute; default_value - the default value, if equals to the value, no output are done.