org.outerj.xreporter.report.definition
Class ReportDefinition

java.lang.Object
  extended byorg.outerj.xreporter.report.definition.ReportDefinition
All Implemented Interfaces:
java.lang.Comparable, org.apache.avalon.framework.configuration.Configurable

public class ReportDefinition
extends java.lang.Object
implements org.apache.avalon.framework.configuration.Configurable, java.lang.Comparable

Root class of the object model that represents a report definition.


Field Summary
protected  java.util.List catalogPaths
          List of catalogs this report belongs to.
protected static java.util.Comparator comparator
           
protected  java.lang.String description
          Description of this report definition, this is a resource bundle key.
protected  java.io.File file
          The file from which the report definition was read
protected  java.lang.String id
          ID of this report definition.
protected  java.lang.String name
          Name of this report definition, this is a resource bundle key.
protected  OutputDefinition outputDefinition
           
protected  java.lang.String requiredDataSourceType
           
protected  java.lang.String sortCode
          String on which to sort the reports.
protected  java.util.List steps
           
protected  java.util.Map stepsByName
           
 
Method Summary
 void addCatalogPath(java.util.List catalogPath)
           
protected  void addStepDefinition(StepDefinition step)
           
 int compareTo(java.lang.Object o)
           
 void configure(org.apache.avalon.framework.configuration.Configuration configuration)
           
 void generateSax(org.xml.sax.ContentHandler contentHandler)
          Generates the XML representation of the report definition.
 java.util.List getCatalogPaths()
           
 java.lang.String getDescription(ResourceHandle resourceHandle)
           
 java.io.File getFile()
           
 java.lang.String getId()
           
 java.lang.String getName(ResourceHandle resourceHandle)
           
 OutputDefinition getOutputDefinition()
           
 java.lang.String getRequiredDataSourceType()
           
 java.lang.String getSortCode()
           
 java.util.List getStepDefinitions()
           
 void setOutputDefinition(OutputDefinition outputDefinition)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

id

protected java.lang.String id
ID of this report definition.


name

protected java.lang.String name
Name of this report definition, this is a resource bundle key.


sortCode

protected java.lang.String sortCode
String on which to sort the reports.


description

protected java.lang.String description
Description of this report definition, this is a resource bundle key.


requiredDataSourceType

protected java.lang.String requiredDataSourceType

outputDefinition

protected OutputDefinition outputDefinition

file

protected java.io.File file
The file from which the report definition was read


comparator

protected static java.util.Comparator comparator

catalogPaths

protected java.util.List catalogPaths
List of catalogs this report belongs to. The entries of this list are what is returned by Catalog.parseCatalogPath(java.lang.String).


steps

protected java.util.List steps

stepsByName

protected java.util.Map stepsByName
Method Detail

configure

public void configure(org.apache.avalon.framework.configuration.Configuration configuration)
               throws org.apache.avalon.framework.configuration.ConfigurationException
Specified by:
configure in interface org.apache.avalon.framework.configuration.Configurable
Throws:
org.apache.avalon.framework.configuration.ConfigurationException

getId

public java.lang.String getId()

getName

public java.lang.String getName(ResourceHandle resourceHandle)

getDescription

public java.lang.String getDescription(ResourceHandle resourceHandle)

getRequiredDataSourceType

public java.lang.String getRequiredDataSourceType()

addStepDefinition

protected void addStepDefinition(StepDefinition step)

getStepDefinitions

public java.util.List getStepDefinitions()

getOutputDefinition

public OutputDefinition getOutputDefinition()

setOutputDefinition

public void setOutputDefinition(OutputDefinition outputDefinition)

generateSax

public void generateSax(org.xml.sax.ContentHandler contentHandler)
                 throws javax.xml.parsers.ParserConfigurationException,
                        org.xml.sax.SAXException,
                        java.io.IOException
Generates the XML representation of the report definition.

Throws:
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
java.io.IOException

getSortCode

public java.lang.String getSortCode()

compareTo

public int compareTo(java.lang.Object o)
Specified by:
compareTo in interface java.lang.Comparable

addCatalogPath

public void addCatalogPath(java.util.List catalogPath)

getCatalogPaths

public java.util.List getCatalogPaths()

getFile

public java.io.File getFile()