IlvXMLDataReader (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.chart.data.xml.IlvXMLDataReader

All Implemented Interfaces:: IlvDataReader

public class IlvXMLDataReader
extends Object
implements IlvDataReader

A class to load data from an XML stream.

In order to be properly loaded, the XML document structure should conform to the following DTD:

 <?xml version="1.0" encoding="UTF-8"?>

 <!ELEMENT chartData (data+)>
 <!ATTLIST chartData xmlns:ilvchart CDATA #FIXED "http://www.ilog.com/products/jviews/chart"
                        version CDATA #REQUIRED
                        xml:lang NMTOKEN #IMPLIED>

 <!ELEMENT data (labels?, series+)>
 <!ATTLIST data xSeries IDREF #IMPLIED
                   xml:lang NMTOKEN #IMPLIED>

 <!ELEMENT series ((valueOperator | (value | valuesList)*), labels?, property*)>
 <!ATTLIST series dateFormat CDATA           #IMPLIED
                     type       (double | date) #REQUIRED
                     name       CDATA           #IMPLIED
                     id         ID              #REQUIRED
                     xml:lang   NMTOKEN         #IMPLIED>

 <!ELEMENT labels (#PCDATA | label)*>
 <!ATTLIST labels delimiter CDATA #IMPLIED
                     xml:space (preserve) #FIXED 'preserve'>

 <!ELEMENT value (#PCDATA)>
 <!ATTLIST value xml:lang NMTOKEN #IMPLIED>

 <!ELEMENT label (#PCDATA)>
 <!ATTLIST label xml:space (preserve) #FIXED 'preserve'>

 <!ELEMENT valuesList (#PCDATA)>
 <!ATTLIST valuesList delimiter CDATA #IMPLIED
                         xml:lang NMTOKEN #IMPLIED>

 <!ELEMENT valueOperator (seriesRef|property)*>
 <!ATTLIST valueOperator class NMTOKEN #REQUIRED>

 <!ELEMENT seriesRef EMPTY>
 <!ATTLIST seriesRef ref IDREF #REQUIRED>

 <!ENTITY % propertyExt "">
 <!ELEMENT property (#PCDATA %propertyExt;)*>
 <!ATTLIST property name CDATA #REQUIRED
                       javaClass CDATA #IMPLIED>

Assuming that a chart contains 3 data sets: 2 (DS_A and DS_B) that do not use xvalues series, 1 (DS_C) using a specific series for its abscissa; the resulting XML file is:

 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE chartData SYSTEM 'chartxml.dtd'>
 <chartData version="1.0">
   <data>
     <series id="DS_A" type="double">
       <valuesList>0.0,8.0,6.0,13.0,22.0,21.0,19.0,28.0,27.0,23.0</valuesList>
     </series>
     <series id="DS_B" type="double">
       <valuesList>0.0,9.0,11.0,14.0,11.0,16.0,19.0,21.0,12.0,12.0</valuesList>
     </series>
   </data>
   <data xSeries="X_DS_C">
     <series id="X_DS_C" type="double">
       <valuesList>0.0,2.0,4.0,6.0,8.0,10.0,12.0,14.0,16.0,18.0</valuesList>
     </series>
     <series id="DS_C" type="double">
       <valuesList>0.0,0.0,6.0,3.0,0.0,2.0,9.0,18.0,9.0,5.0</valuesList>
     </series>
   </data>
 </chartData>

Since:: JViews 5.0

Constructor Summary

Constructors
Constructor and Description

IlvXMLDataReader()
Creates a new IlvXMLDataReader.

Constructors
Constructor and Description
`IlvXMLDataReader()` Creates a new `IlvXMLDataReader`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected IlvDataSet`	`createDataSet(String name, double[] xvalues, double[] yvalues)` Creates a new `IlvDataSet`.
`static IlvXMLPropertyReader`	`getDefaultPropertyReader()` Returns the default property reader or `null` if no default property reader has been set.
`Document`	`getDocument()` Returns the `Document` object containing the XML document.
`IlvXMLPropertyReader`	`getPropertyReader(String propertyName)` Returns the property reader associated with the specified property, or the default property reader if the property name is `null`.
`String[]`	`getStyleSheets()` Returns the CSS style sheets associated with this document.
`boolean`	`isValidating()` Returns the document factory validating mode.
`IlvDataSet[]`	`read(Document document)` Read a chart data model from the specified `org.w3c.dom.Document`.
`IlvDataSet[]`	`read(InputSource in)` Reads a chart data model from the specified `org.xml.sax.InputSource`.
`IlvDataSet[]`	`read(InputStream in)` Reads a chart data model from an XML document.
`IlvDataSet[]`	`read(String uri)` Reads a chart data model from an XML document.
`static void`	`registerPropertyReader(String propertyName, IlvXMLPropertyReader reader)` Associates the specified property reader with the specified property.
`void`	`setPropertyReader(String propertyName, IlvXMLPropertyReader reader)` Associates the specified property reader with the specified property.
`void`	`setValidating(boolean validate)` Sets the document factory validating mode to the specified value.

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

- Constructor Detail
  - IlvXMLDataReader
```
public IlvXMLDataReader()
```
    Creates a new IlvXMLDataReader.
- Method Detail
  - registerPropertyReader
```
public static void registerPropertyReader(String propertyName,
                                          IlvXMLPropertyReader reader)
```
    Associates the specified property reader with the specified property. If the property name is null, the specified reader is used as the default property reader of the class. The default property reader is used to read a property element when no specific property reader has been registered for this property. By default, the IlvXMLDataReader class does not set a default reader.
    
    See Also:
    
    IlvXMLPropertyReader
  - getDefaultPropertyReader
```
public static IlvXMLPropertyReader getDefaultPropertyReader()
```
    Returns the default property reader or null if no default property reader has been set.
    
    See Also:
    
    registerPropertyReader(java.lang.String, ilog.views.chart.data.xml.IlvXMLPropertyReader)
  - setPropertyReader
```
public void setPropertyReader(String propertyName,
                              IlvXMLPropertyReader reader)
```
    Associates the specified property reader with the specified property. If the property name is null, the specified reader is used as the default property reader. The scope of this association is limited to this reader.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    IlvXMLPropertyReader, registerPropertyReader(java.lang.String, ilog.views.chart.data.xml.IlvXMLPropertyReader)
  - getPropertyReader
```
public IlvXMLPropertyReader getPropertyReader(String propertyName)
```
    Returns the property reader associated with the specified property, or the default property reader if the property name is null.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    IlvXMLPropertyReader, setPropertyReader(java.lang.String, ilog.views.chart.data.xml.IlvXMLPropertyReader)
  - getStyleSheets
```
public String[] getStyleSheets()
```
    Returns the CSS style sheets associated with this document.
    
    Returns:
    
    An array of URLs, or file names of the style sheet files, or null if none is specified.
    
    Since:
    
    JViews 5.5
  - getDocument
```
public Document getDocument()
```
    Returns the Document object containing the XML document.
  - setValidating
```
public void setValidating(boolean validate)
```
    Sets the document factory validating mode to the specified value. The default value is false.
  - isValidating
```
public boolean isValidating()
```
    Returns the document factory validating mode.
  - createDataSet
```
protected IlvDataSet createDataSet(String name,
                                   double[] xvalues,
                                   double[] yvalues)
```
    Creates a new IlvDataSet. The default implementation returns an instance of IlvDefaultDataSet. You may override this method to return an instance of your own class.
    
    Parameters:
    
    name - The name of the data set. The string is equal to the y-series ID.
    
    xvalues - The x-values array. May be null if no x-values are defined.
    
    yvalues - The y-values array.
    
    See Also:
    
    IlvDefaultDataSet
  - read
```
public IlvDataSet[] read(InputStream in)
                  throws Exception
```
    Reads a chart data model from an XML document.
    
    Specified by:
    
    read in interface IlvDataReader
    
    Parameters:
    
    in - The byte InputStream containing the document.
    
    Returns:
    
    The data sets.
    
    Throws:
    
    Exception
  - read
```
public IlvDataSet[] read(String uri)
                  throws Exception
```
    Reads a chart data model from an XML document.
    
    Specified by:
    
    read in interface IlvDataReader
    
    Parameters:
    
    uri - The URI locating the document.
    
    Returns:
    
    The data sets.
    
    Throws:
    
    Exception
  - read
```
public IlvDataSet[] read(InputSource in)
                  throws Exception
```
    Reads a chart data model from the specified org.xml.sax.InputSource.
    
    Returns:
    
    The data sets.
    
    Throws:
    
    Exception
  - read
```
public IlvDataSet[] read(Document document)
                  throws IlvXMLDataReaderException
```
    Read a chart data model from the specified org.w3c.dom.Document.
    
    Returns:
    
    The data sets.
    
    Throws:
    
    IlvXMLDataReaderException - An error occurred while building datasets.
    
    Since:
    
    JViews 5.5

Class IlvXMLDataReader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvXMLDataReader

Method Detail

registerPropertyReader

getDefaultPropertyReader

setPropertyReader

getPropertyReader

getStyleSheets

getDocument

setValidating

isValidating

createDataSet

read

read

read

read