ilog.views.dashboard

Class IlvDashboardDOM

java.lang.Object

ilog.views.dashboard.IlvDashboardDOM

public class IlvDashboardDOM
extends Object

The IlvDashboardDOM utility class is used to read and write a dashboard diagram to and from a Document Object Model (DOM) Element.

Example

The following code example shows you how to use IlvDashboardDOM.

   public void buildDoc(IlvDiagrammer diagrammer) throws Exception {
   
   IlvDashboardDiagram diagram = (IlvDashboardDiagram) diagrammer;
   DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
   DocumentBuilder builder = dbFactory.newDocumentBuilder();
   Document document = builder.newDocument();
   Element dashboardDOM = IlvDashboardDOM.buildDashboardDOM(document, diagram);
   ...
 

Since:

JViews 8.0

See Also:

The Document Object Model

Method Summary

Modifier and Type	Method and Description
static Element	buildDashboardDOM(Document document, IlvDashboardDiagram diagram) Builds a DOM Element describing an IlvDashboardDiagram instance.
static boolean	isValidDocument(Document document) Checks if document is a valid dashboard diagram document.
static void	readDashboardDOM(IlvDashboardDiagram diagram, Document document) Reads the dashboard diagram contents from a DOM Element.

Methods inherited from class java.lang.Object

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

Method Detail

buildDashboardDOM

public static Element buildDashboardDOM(Document document,
                                        IlvDashboardDiagram diagram)

Builds a DOM Element describing an IlvDashboardDiagram instance. The created Element is not added to document by this function. It is the responsibility of the caller to add it to the document at the suitable level of the hierarchy.

Parameters:

document - The Document used to create DOM objects.

diagram - The dashboard diagram to be written to a DOM Element.

Returns:

A DOM Element containing the description of diagram.

See Also:

Example

isValidDocument

public static boolean isValidDocument(Document document)

Checks if document is a valid dashboard diagram document.

Note: this method does not validate the XML stored in document.

Parameters:

document - The Document to test.

Returns:

Returns true if the root element in document is a valid dashboard diagram root tag.

readDashboardDOM

public static void readDashboardDOM(IlvDashboardDiagram diagram,
                                    Document document)
                             throws IlvDiagrammerException

Reads the dashboard diagram contents from a DOM Element.

The following code example shows how to read a DOM into a IlvDashboardDiagram instance.

 public void read(IlvDiagrammer diagrammer) throws Exception {
   // The given diagrammer must be an IlvDashboardDiagram
   if (diagrammer instanceof IlvDashboardDiagram) {
     IlvDashboardDiagram source = (IlvDashboardDiagram) diagrammer;
     ...
   }
   IlvDashboardContext context = new IlvDashboardContext();
   IlvDashboardDiagram dashboard = new IlvDashboardDiagram(context);
              
   // Build the DOM
   DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
   DocumentBuilder builder = factory.newDocumentBuilder();
   Document document = builder.newDocument();
   Element dashboardDOM = IlvDashboardDOM.buildDashboardDOM(document, source);
   document.appendChild(dashboardDOM);
   // Read the contents
   IlvDashboardDOM.readDashboardDOM(dashboard, document);
   ...
 

Parameters:

diagram - The target dashboard diagram.

document - The source document.

Throws:

IlvDiagrammerException