ilog.views.chart.data.xml

Class IlvXMLDataWriter

java.lang.Object

ilog.views.chart.data.xml.IlvXMLDataWriter

public class IlvXMLDataWriter
extends Object

A class that exports a Chart data model to an XML file. For more information on the format used to save the data, see IlvXMLDataReader.

Since:

JViews 5.0

Constructor Summary

Constructors

Constructor and Description
IlvXMLDataWriter() Deprecated. Please use the constructor that takes a Locale argument.
IlvXMLDataWriter(Locale locale) Creates a new IlvXMLDataWriter.

Method Summary

Modifier and Type	Method and Description
String	generateId(IlvDataSet dataSet, boolean xSeries) Generates the XML ID for the specified series of the specified data set.
String	getDateFormat() Returns the document date format.
char	getDelimiter() Returns the delimiter used for valuesList element.
protected Document	getDocument() Returns the document being populated by this writer.
Locale	getLocale() Returns the locale used to convert dates to a textual representation.
char	getTrimChar() Returns the space replacement character.
String	getVersion() Returns the DTD version.
void	setDateFormat(String format) Sets the document date format.
void	setDelimiter(char delimiter) Sets the delimiter for valuesList element.
void	setLocale(Locale locale) Sets the locale used to convert dates to a textual representation.
void	setStyleSheets(String[] ssheets) Sets the style sheets associated with this XML file.
void	setTrimChar(char c) Sets the space replacement character.
void	setVersion(String version) Sets the DTD version.
void	write(Document document, IlvDataSet[] dataSets) Writes in the specified XML document the contents of the specified data set arrays.
void	write(OutputStream output, IlvDataSet[] dataSets) Writes in the specified output stream the contents of the specified data set arrays as an XML document.
protected void	writeProperties(Element srcElt, IlvDataSet ds) Writes the property elements for the specified data set.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvXMLDataWriter

@Deprecated
public IlvXMLDataWriter()

Deprecated. Please use the constructor that takes a Locale argument.

Creates a new IlvXMLDataWriter that doesn't write a locale designator into the XML file.

Deprecated Since:

JViews 8.1

IlvXMLDataWriter

public IlvXMLDataWriter(Locale locale)

Creates a new IlvXMLDataWriter.

Parameters:

locale - The locale used to convert dates to a textual representation, see setLocale(java.util.Locale). Usually the value passed here is Locale.getDefault().

Since:

JViews 8.1

See Also:

setLocale(java.util.Locale)

Method Detail

getVersion

public final String getVersion()

Returns the DTD version.

setVersion

public void setVersion(String version)

Sets the DTD version. If the parameter is null, then the original DTD version is used.

getLocale

public Locale getLocale()

Returns the locale used to convert dates to a textual representation.

Returns:

a locale or null

Since:

JViews 8.1

See Also:

setLocale(java.util.Locale)

setLocale

public void setLocale(Locale locale)

Sets the locale used to convert dates to a textual representation.

If the given locale is non-null, it is used to convert dates to a textual representation, and is designated through an xml:lang attribute. Such XML files can then be read in any locale.

If the given locale is null, the current locale is used to convert dates to a textual representation, and no locale designator is written into the XML file. Such XML files can only be read is the same locale as the one in which they were written.

Parameters:

locale - A locale, or null.

Since:

JViews 8.1

See Also:

getLocale()

getDateFormat

public String getDateFormat()

Returns the document date format. The format is used to serialize time series.

See Also:

setDateFormat(java.lang.String)

setDateFormat

public final void setDateFormat(String format)

Sets the document date format. If the parameter is null, then a default date format ("dd-MMMM-yy" or "dd-MMMM-yyTHH:mm:ss" or "dd-MMMM-yyTHH:mm:ss.SSS", as appropriate) is used. The IlvDataSetProperty.isXTimeSeries(ilog.views.chart.data.IlvDataSet) and IlvDataSetProperty.isYTimeSeries(ilog.views.chart.data.IlvDataSet) methods are used to check whether this format must be used to serialize values.

Parameters:

format - A date format string in the syntax described in the class SimpleDateFormat or com.ibm.icu.text.SimpleDateFormat, not containing whitespace nor commas.

See Also:

setDateFormat(java.lang.String)

getTrimChar

public final char getTrimChar()

Returns the space replacement character.

See Also:

setTrimChar(char)

setTrimChar

public void setTrimChar(char c)

Sets the space replacement character. This character is used to replace space characters in a ID attribute.

setDelimiter

public void setDelimiter(char delimiter)

Sets the delimiter for valuesList element. The default value is ','.

getDelimiter

public char getDelimiter()

Returns the delimiter used for valuesList element.

See Also:

setDelimiter(char)

generateId

public String generateId(IlvDataSet dataSet,
                         boolean xSeries)

Generates the XML ID for the specified series of the specified data set. The default implementation returns the data set name, replacing any space characters by the replacement character, and prefixing the data set name with "X" in the case of an x-series. You may override this method to perform a more XML-compliant ID generation.

Since:

JViews 5.5

See Also:

setTrimChar(char)

writeProperties

protected void writeProperties(Element srcElt,
                               IlvDataSet ds)

Writes the property elements for the specified data set.

Parameters:

srcElt - The parent Element of the property elements.

ds - The data set.

setStyleSheets

public void setStyleSheets(String[] ssheets)

Sets the style sheets associated with this XML file. These style sheets are referenced using xml-stylesheet processing instructions.

Parameters:

ssheets - An array of the style sheets URLs.

Since:

JViews 5.5

write

public void write(Document document,
                  IlvDataSet[] dataSets)

Writes in the specified XML document the contents of the specified data set arrays.

write

public void write(OutputStream output,
                  IlvDataSet[] dataSets)
           throws IOException

Writes in the specified output stream the contents of the specified data set arrays as an XML document.

Throws:

IOException - An error occurred while writing the document to the specified output stream.

getDocument

protected Document getDocument()

Returns the document being populated by this writer.

Since:

JViews 6.0