Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.dghda.kent
Class ReportData  view ReportData download ReportData.java

java.lang.Object
  extended bycom.dghda.kent.ReportData

public class ReportData
extends java.lang.Object

This class provides a convenient method of creating a report data document. Report data documents are formatted based on their report template.


Nested Class Summary
static class ReportData.DataSet
          A class which contains encapsulates a data set.
 
Field Summary
private  java.util.TreeMap m_DataSets
           
 
Constructor Summary
  ReportData()
          Constructs a new report data object.
protected ReportData(org.w3c.dom.Document data)
          Constructs a new report data object by parsing the given document.
 
Method Summary
 void addDataSet(ReportData.DataSet data)
          Adds a new, already constructed, data set to the report.
 void addDataSet(java.lang.String name, java.lang.String[] columns)
          Adds a new data set to the report.
 void addRow(java.lang.String name, java.lang.String[] data)
          Adds a row to the specified data set.
static ReportData constructReportData(java.lang.String data)
          Constructs a new report data object by parsing the given XML document.
 java.lang.String getColumn(java.lang.String dataSet, java.lang.String field, int which)
          Gets the value of a specific column.
 java.lang.String getData()
          Returns a document containing the report data constructed.
 ReportData.DataSet getDataSet(java.lang.String name)
          Returns the given data set.
 java.util.Iterator getDataSetIterator()
          An iterator over the data sets.
 int getNumberRows(java.lang.String dataSet)
          Gets the number of rows in a given data set.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_DataSets

private java.util.TreeMap m_DataSets
Constructor Detail

ReportData

public ReportData()
Constructs a new report data object.


ReportData

protected ReportData(org.w3c.dom.Document data)
              throws org.xml.sax.SAXException
Constructs a new report data object by parsing the given document.

Method Detail

constructReportData

public static ReportData constructReportData(java.lang.String data)
                                      throws javax.xml.parsers.ParserConfigurationException,
                                             org.xml.sax.SAXException
Constructs a new report data object by parsing the given XML document.


addDataSet

public void addDataSet(java.lang.String name,
                       java.lang.String[] columns)
                throws InvalidColumnException,
                       InvalidDataSetException
Adds a new data set to the report.


addDataSet

public void addDataSet(ReportData.DataSet data)
                throws InvalidDataSetException
Adds a new, already constructed, data set to the report.


addRow

public void addRow(java.lang.String name,
                   java.lang.String[] data)
            throws InvalidColumnException,
                   InvalidDataSetException
Adds a row to the specified data set.


getDataSet

public ReportData.DataSet getDataSet(java.lang.String name)
Returns the given data set.


getDataSetIterator

public java.util.Iterator getDataSetIterator()
An iterator over the data sets. The iterator returns a data set object.


getNumberRows

public int getNumberRows(java.lang.String dataSet)
                  throws InvalidDataSetException
Gets the number of rows in a given data set.


getColumn

public java.lang.String getColumn(java.lang.String dataSet,
                                  java.lang.String field,
                                  int which)
                           throws InvalidColumnException,
                                  InvalidDataSetException
Gets the value of a specific column.


getData

public java.lang.String getData()
Returns a document containing the report data constructed.