Reading an XML File into a Data Source

The following sample code reads an XML file into a data source.

How to Read in an XML File into a Data Source

try {
  dataSource.parse("XMLFileExample.xml");
} catch (Exception e) {
  e.printStackTrace();
}

Following is an example of an XML file.

<cplData xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation = "ilog/cpl/schema/data.xsd">
<cplData>
<classes>
  <class>
    <name>Alarm</name>
    <attribute>
      <name>ID</name>
      <javaClass>java.lang.String</javaClass>
    </attribute>
    <attribute>
      <name>severity</name>
      <javaClass>itest.table.datasourcexmltable.MainFrame$Severity</javaClass>
      <defaultValue>Warning</defaultValue>
    </attribute>
    <attribute>
      <name>acknowledged</name>
      <javaClass>java.lang.Boolean</javaClass>
      <defaultValue>false</defaultValue>
    </attribute>
  </class>
</classes>
<addObject id="alarm1" initializeDefaultValue="true">
 <class>Alarm</class>
  <attribute name="ID">alarm1</attribute>
</addObject>
<addObject id="alarm2" initializeDefaultValue="false">
 <class>Alarm</class>
  <attribute name="ID">alarm2</attribute>
  <attribute name="severity">Major</attribute>
  <attribute name="acknowledged">false</attribute>
</addObject >
<addObject id="alarm3" initializeDefaultValue="false">
 <class>Alarm</class>
  <attribute name="ID">alarm3</attribute>
  <attribute name="severity">Major</attribute>
  <attribute name="acknowledged">true</attribute>
</addObject >
<addObject id="alarm4" initializeDefaultValue="false">
 <class>Alarm</class>
  <attribute name="ID">alarm4</attribute>
</addObject >
<updateObject id="alarm2">
  <attribute name="acknowledged">true</attribute>
</updateObject>
</cplData>

When defining your business model in a data source file, please note that the business class inheritance (defined through the tag "superClass" ) is resolved at the end of each <classes> element. As a consequence, you cannot define within the first <classes> element a class that inherits from a class defined within another <classes> element later in the file. For example, the following model definition is incorrect:

Incorrect Example

<cplData xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation = "ilog/cpl/schema/data.xsd">
<classes>
  <class>
    <name>Domain</name>
    <superClass>NetworkElement</superClass>
  </class>
</classes>
 
<classes>
  <class>
    <name>NetworkElement</name>
    <attribute>
      <name>name</name>
      <javaClass>java.lang.String</javaClass>
    </attribute>
  </class>
</classes>
</cplData>

To get a correct business model definition, you can either define the whole business class hierarchy inside the same <classes> element as follows:

Correct Example

<cplData xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation = "ilog/cpl/schema/data.xsd">
<classes>
  <class>
    <name>NetworkElement</name>
    <attribute>
      <name>name</name>
      <javaClass>java.lang.String</javaClass>
    </attribute>
  </class>
  <class>
    <name>Domain</name>
    <superClass>NetworkElement</superClass>
  </class>
</classes>
</cplData>

XML File Samples

How to Define the Business Model

The following sample illustrates the use of the XML elements <cplData>, <classes>, <class> and <attribute>, which define the business model:

How to Create a New Business Object

The following sample illustrates the use of the XML element <addObject> to create a new business object of the business class "Domain":

How to Create Containment Relationships Between Business Objects

The following sample shows how to create containment relationships between business objects using the XML element <parent>. The example creates a new business object "Server1" which is a child of business object "Domain1".

How to Specify a Link Relationship

The following sample shows how to specify a link relationship using the XML elements <link>, <to> and <from>. In this example, you create the link "Link1" which connects two objects "Domain1" and "Domain2".

How to Update the Values of an Object

The following sample shows how to update values of an existing object using the XML element <updateObject>. You can update simple attributes, such as "name", and you can also change structural information such as changing the end point of the link:

How to Remove an Object from the Data Source

The following sample shows how to remove an object from the data soure using the XML element <removeObject>:

Writing the Data Source Content to XML

You can also write the content of the data source to an XML file like this:

datasource.output("network.xml");

You can also use a java.io.Writer. The following example prints the data source to the default output:

Writer writer = new PrintWriter(System.out);
dataSource.output(writer);
writer.flush();

Adding Predefined Business Objects

Almost all predefined business objects can be added to a data source. This is the case for:

For information on how to add these objects to a data source through XML or through the API, refer to the corresponding sections further in this documentation.