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

Quick Search    Search Deep

com.dghda.kent.reports
Class FixedTemplateReport  view FixedTemplateReport download FixedTemplateReport.java

java.lang.Object
  extended bycom.dghda.module.BaseModule
      extended bycom.dghda.kent.BaseKentModule
          extended bycom.dghda.kent.reports.FixedTemplateReport
All Implemented Interfaces:
com.dghda.kent.KentModule, com.dghda.module.Module, com.dghda.kent.Report
Direct Known Subclasses:
BaseJDBCReport

public abstract class FixedTemplateReport
extends com.dghda.kent.BaseKentModule
implements com.dghda.kent.Report

A base class to simplify writing reports which use load a template.


Nested Class Summary
 
Nested classes inherited from class com.dghda.module.Module
com.dghda.module.Module.ModuleVersion
 
Field Summary
private  java.lang.String m_Template
           
 
Fields inherited from class com.dghda.kent.BaseKentModule
 
Fields inherited from class com.dghda.module.BaseModule
 
Fields inherited from interface com.dghda.kent.KentModule
ACTION_ID, AUTHENTICATED_USER, FORMAT_ID, REPORT_ID
 
Constructor Summary
FixedTemplateReport(java.lang.String id, java.lang.String shortName, java.lang.String description, com.dghda.module.Module.ModuleVersion version, com.dghda.kent.ReportEngine engine, java.io.InputStream input)
          Creates a new report object loaded by the given report engine.
 
Method Summary
 java.lang.String getReportTemplate(java.util.Properties config)
          Returns the loaded report template.
protected  void load(java.io.InputStream input)
          Copies the contents of the given stream into a string.
 
Methods inherited from class com.dghda.kent.BaseKentModule
getReportEngine
 
Methods inherited from class com.dghda.module.BaseModule
getDescription, getID, getName, getVersion
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.dghda.kent.Report
getReportData
 
Methods inherited from interface com.dghda.kent.KentModule
getConfigurationOptions
 
Methods inherited from interface com.dghda.module.Module
getDescription, getID, getName, getVersion
 

Field Detail

m_Template

private java.lang.String m_Template
Constructor Detail

FixedTemplateReport

public FixedTemplateReport(java.lang.String id,
                           java.lang.String shortName,
                           java.lang.String description,
                           com.dghda.module.Module.ModuleVersion version,
                           com.dghda.kent.ReportEngine engine,
                           java.io.InputStream input)
                    throws java.io.IOException
Creates a new report object loaded by the given report engine.

Method Detail

getReportTemplate

public java.lang.String getReportTemplate(java.util.Properties config)
Returns the loaded report template.

Specified by:
getReportTemplate in interface com.dghda.kent.Report

load

protected void load(java.io.InputStream input)
             throws java.io.IOException
Copies the contents of the given stream into a string.