com.softwarefx.chartfx.server.dataproviders
Class XmlDataProvider

java.lang.Object
  com.softwarefx.chartfx.server.dataproviders.XmlDataProvider

All Implemented Interfaces:

IDataSource

public class XmlDataProvider
extends Object
implements IDataSource

Provides access to the Chart's XML Data Provider object.

XML has proven to be a very dynamic and flexible means of data storage. Chart FX has been developed with this in mind and includes an XmlDataProvider. Using the XmlDataProvider, you can pass XML data directly to your charts for display.

When passing the data using the XML data provider, the data is passed as columns and rows, the same as with a table. The following rules apply:

a) There must be a special tag indicating that the information enclosed is the column's definition. By default this tag is named <COLUMNS>. Each column will need a separate COLUMN tag. The format is:

<COLUMNS>

<COLUMN NAME="Column1_Name" TYPE="Column1_Type" DESCRIPTION="Column1_Desciption" />

<COLUMN NAME="ColumnN_Name" TYPE="ColumnN_Type" DESCRIPTION="ColumnN_Desciption" />

</COLUMNS>

The Description attribute is optional. If it is included, it will be used as a Series or Value legend. If it is not present, the configured Column Name will be assigned as a Series or Value legend instead.

b) As you can see above, each column name is configured with a type. The attribute Type is case sensitive, and the supported data types are String, Integer, Double, Short, Float, Boolean, Byte and Date.

c) Every row is then defined using the following format:

<ROW Column1_Name="Value" ... ColumnN_Name="Value"/>

Constructor Summary

XmlDataProvider()

Method Summary

XmlColumnCollection	getColumns() Returns the collection of XmlColumns.
Locale	getCulture() Gets the Culture.
String	getDateFormat() Gets the DateFormat.
boolean	isRowsAsElements() Gets the RowsAsElements.
void	load(InputStream stream) Specifies the path to the XML file.
void	load(String filename) Specifies the path to the XML file.
void	loadXML(String xmlString) Used to pass the XML as a string.
void	setCulture(Locale locale) Allows you to localize data for a specific language and region.
void	setDateFormat(String dateFormat) Allows you to customize the default date format for the Chart FX XmlDataProvider.
void	setRowsAsElements(boolean RowsAsElements) Sets the bool value that determines row data format.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlDataProvider

public XmlDataProvider()

Method Detail

getColumns

public XmlColumnCollection getColumns()

Returns the collection of XmlColumns.

Remarks:

This collection is empty until XmlColumns are added.

getCulture

public Locale getCulture()

Gets the Culture. For more detail see setCulture(java.util.Locale).

getDateFormat

public String getDateFormat()

Gets the DateFormat. For more detail see setDateFormat(java.lang.String).

isRowsAsElements

public boolean isRowsAsElements()

Gets the RowsAsElements. For more detail see setRowsAsElements(boolean).

load

public void load(InputStream stream)

Specifies the path to the XML file.

Remarks:

You can pass the xml data parameter as either a string or stream using this method.

When passing the data using the XML data provider, the data is passed as columns and rows, the same as with a table. The following rules apply:

a) There must be a special tag indicating that the information enclosed is the column's definition. By default this tag is named <COLUMNS>. Each column will need a separate COLUMN tag. The format is:

<COLUMNS>
<COLUMN NAME="Column1_Name" TYPE="Column1_Type" DESCRIPTION="Column1_Desciption" />
<COLUMN NAME="ColumnN_Name" TYPE="ColumnN_Type" DESCRIPTION="ColumnN_Desciption" />
</COLUMNS>

The Description attribute is optional. If it is included, it will be used as a Series or Value legend. If it is not present, the configured Column Name will be assigned as a Series or Value legend instead.

b) As you can see above, each column name is configured with a type. The attribute Type is case sensitive, and the supported data types are String, Integer, Double, Short, Float, Boolean, Byte and Date.

c) Every row is then defined using the following format:

<ROW Column1_Name="Value" ... ColumnN_Name="Value"/>

Parameters:

stream - Stream as System.IO

See Also:

setCulture(java.util.Locale), setDateFormat(java.lang.String), loadXML(java.lang.String)

load

public void load(String filename)

Specifies the path to the XML file.

Remarks:

You can pass the xml data parameter as either a string or stream using this method.

When passing the data using the XML data provider, the data is passed as columns and rows, the same as with a table. The following rules apply:

a) There must be a special tag indicating that the information enclosed is the column's definition. By default this tag is named <COLUMNS>. Each column will need a separate COLUMN tag. The format is:

<COLUMNS>
<COLUMN NAME="Column1_Name" TYPE="Column1_Type" DESCRIPTION="Column1_Desciption" />
<COLUMN NAME="ColumnN_Name" TYPE="ColumnN_Type" DESCRIPTION="ColumnN_Desciption" />
</COLUMNS>

The Description attribute is optional. If it is included, it will be used as a Series or Value legend. If it is not present, the configured Column Name will be assigned as a Series or Value legend instead.

b) As you can see above, each column name is configured with a type. The attribute Type is case sensitive, and the supported data types are String, Integer, Double, Short, Float, Boolean, Byte and Date.

c) Every row is then defined using the following format:

<ROW Column1_Name="Value" ... ColumnN_Name="Value"/>

Parameters:

filename -

See Also:

setCulture(java.util.Locale), setDateFormat(java.lang.String), loadXML(java.lang.String)

loadXML

public void loadXML(String xmlString)

Used to pass the XML as a string.

Remarks:

This method allows you to concatenate the contents of an xml file into one string and pass that string as the XML data.

When passing the data using the XML data provider, the data is passed as columns and rows, the same as with a table. The following rules apply:

a) There must be a special tag indicating that the information enclosed is the column's definition. By default this tag is named <COLUMNS>. Each column will need a separate COLUMN tag. The format is:

<COLUMNS>
<COLUMN NAME="Column1_Name" TYPE="Column1_Type" DESCRIPTION="Column1_Desciption" />
<COLUMN NAME="ColumnN_Name" TYPE="ColumnN_Type" DESCRIPTION="ColumnN_Desciption" />
</COLUMNS>

The Description attribute is optional. If it is included, it will be used as a Series or Value legend. If it is not present, the configured Column Name will be assigned as a Series or Value legend instead.

b) As you can see above, each column name is configured with a type. The attribute Type is case sensitive, and the supported data types are String, Integer, Double, Short, Float, Boolean, Byte and Date.

c) Every row is then defined using the following format:

<ROW Column1_Name="Value" ... ColumnN_Name="Value"/>

Parameters:

xmlString -

See Also:

setCulture(java.util.Locale), setDateFormat(java.lang.String), load(java.io.InputStream)

setCulture

public void setCulture(Locale locale)

Allows you to localize data for a specific language and region.

Remarks:

Culture attributes set with this property will effect only selected data, to set localization attributes for the entire chart, please use the Chart.setCulture(java.util.Locale) property of the Chart Class .

If no attributes are set using this property or the Chart Class Chart.setCulture(java.util.Locale) property, then Chart FX inherits the system culture.

When setting this property, you may need the Language Code and/or Country Code constants for the desired culture. For more information, please refer to the java.util.Locale documentation.

Example:

XmlDataProvider xmldp = new XmlDataProvider("myxmlfile.xml");


xmldp.setCulture("es-ES");


See Also:

Chart.setCulture(java.util.Locale), ValueFormat.setCulture(java.util.Locale), Chart, ValueFormat

setDateFormat

public void setDateFormat(String dateFormat)

Allows you to customize the default date format for the Chart FX XmlDataProvider.

Remarks:

When dates are included in the XML file and are in a format other than "mm/dd/yyyy" (which is the default format), the DateFormat property must be used to create a mask that will instruct Chart FX how to understand the values.

See Also:

TextProvider.setDateFormat(java.lang.String), TextProvider

setRowsAsElements

public void setRowsAsElements(boolean RowsAsElements)

Sets the bool value that determines row data format.

Remarks:

This property allows you to specify the format of row data. Either as nodes(elements) or attributes. The default settings is attribute (false).