Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.norther.tammi.sprig.jasper
Interface JasperReports

All Superinterfaces:
Configurable, ReportEngine
All Known Implementing Classes:
DefaultJasperReports
public interface JasperReports
extends ReportEngine

A JasperReports specific extension to ReportEngine.

Version:
$Id: JasperReports.java,v 1.15 2009/09/28 15:08:51 cvsimp Exp $
Author:
Ilkka Priha

Field Summary
static String DESIGN_EXTENSION
          The design file extension.
static String PRINT_EXTENSION
          The print file extension.
static String REPORT_EXTENSION
          The report file extension.
 
Method Summary
 net.sf.jasperreports.engine.JasperReport compile(File source)
          Compiles the specified design.
 net.sf.jasperreports.engine.JasperReport compile(InputStream input, String encoding)
          Compiles the specified design.
 net.sf.jasperreports.engine.JasperReport compile(net.sf.jasperreports.engine.design.JasperDesign design)
          Compiles the specified design.
 net.sf.jasperreports.engine.JasperReport compile(Reader reader)
          Compiles the specified design.
 net.sf.jasperreports.engine.JasperReport compile(String source)
          Compiles the specified design.
 net.sf.jasperreports.engine.JasperReport compile(String key, String source)
          Compiles the specified design.
 net.sf.jasperreports.engine.JasperReport compile(URL source)
          Compiles the specified design.
 String getCalculatorClassName()
          Gets the calculator class name
 net.sf.jasperreports.engine.JasperReport interpret(File source)
          Interprets the specified design.
 net.sf.jasperreports.engine.JasperReport interpret(InputStream input, String encoding)
          Interprets the specified design.
 net.sf.jasperreports.engine.JasperReport interpret(net.sf.jasperreports.engine.design.JasperDesign design)
          Interprets the specified design.
 net.sf.jasperreports.engine.JasperReport interpret(Reader reader)
          Interprets the specified design.
 net.sf.jasperreports.engine.JasperReport interpret(String source)
          Interprets the specified design.
 net.sf.jasperreports.engine.JasperReport interpret(String key, String source)
          Interprets the specified design.
 net.sf.jasperreports.engine.JasperReport interpret(URL url)
          Interprets the specified design.
 net.sf.jasperreports.engine.design.JasperDesign load(File source)
          Loads the specified design.
 net.sf.jasperreports.engine.design.JasperDesign load(InputStream input, String encoding)
          Loads the specified design.
 net.sf.jasperreports.engine.design.JasperDesign load(Reader reader)
          Loads the specified design.
 net.sf.jasperreports.engine.design.JasperDesign load(String source)
          Loads the specified design.
 net.sf.jasperreports.engine.design.JasperDesign load(String key, String source)
          Loads the specified design.
 net.sf.jasperreports.engine.design.JasperDesign load(URL source)
          Loads the specified design.
 ReportLayout process(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> params, TableModel data)
          Processes the specified report.
 net.sf.jasperreports.engine.JasperPrint publish(File source, Map<String,Object> params, net.sf.jasperreports.engine.JRDataSource data)
          Publishes the specified design or report.
 net.sf.jasperreports.engine.JasperPrint publish(InputStream input, Map<String,Object> params, net.sf.jasperreports.engine.JRDataSource data)
          Publishes the specified report.
 net.sf.jasperreports.engine.JasperPrint publish(net.sf.jasperreports.engine.design.JasperDesign design, Map<String,Object> params, net.sf.jasperreports.engine.JRDataSource data)
          Publishes the specified design.
 net.sf.jasperreports.engine.JasperPrint publish(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> params, net.sf.jasperreports.engine.JRDataSource data)
          Publishes the specified report.
 net.sf.jasperreports.engine.JasperPrint publish(String source, Map<String,Object> params, net.sf.jasperreports.engine.JRDataSource data)
          Publishes the specified design or report.
 net.sf.jasperreports.engine.JasperPrint publish(String key, String source, Map<String,Object> params, net.sf.jasperreports.engine.JRDataSource data)
          Publishes the specified design or report.
 net.sf.jasperreports.engine.JasperPrint publish(URL source, Map<String,Object> params, net.sf.jasperreports.engine.JRDataSource data)
          Publishes the specified design or report.
 Object read(File source)
          Reads the specified object.
 Object read(InputStream input)
          Reads the specified object.
 Object read(String source)
          Reads the specified object.
 Object read(String key, String source)
          Reads the specified object.
 Object read(URL source)
          Reads the specified object.
 void setCalculatorClassName(String className)
          Sets the calculator class name
 void write(Object source, File target)
          Writes the specified object.
 void write(Object source, OutputStream output)
          Writes the specified object.
 void write(Object source, String target)
          Writes the specified object.
 void write(Object source, String key, String target)
          Writes the specified object.
 
Methods inherited from interface org.norther.tammi.sprig.report.ReportEngine
createExporter, fill, getExporterClassName, getReportKey, parse, parse, parse, parse, parse, parse, process, process, process, process, process, process, removeExporterClassName, setExporterClassName, setReportKey
 
Methods inherited from interface org.norther.tammi.core.config.Configurable
addProperty, addProperty, addPropertyFilePath, addPropertyFilePath, clearProperties, containsProperty, getConfigKey, getProperties, getProperty, getPropertyFilePath, getPropertyFilePaths, indexOfProperty, propertyMap, propertyMap, removeProperty, removeProperty, removePropertyFilePath, setConfigKey, setProperties, setProperty, setPropertyFilePath, setPropertyFilePath, setPropertyFilePaths, setPropertyFilePaths, storeProperties
 

Field Detail

DESIGN_EXTENSION

static final String DESIGN_EXTENSION
The design file extension.

See Also:
Constant Field Values

REPORT_EXTENSION

static final String REPORT_EXTENSION
The report file extension.

See Also:
Constant Field Values

PRINT_EXTENSION

static final String PRINT_EXTENSION
The print file extension.

See Also:
Constant Field Values
Method Detail

getCalculatorClassName

String getCalculatorClassName()
Gets the calculator class name

Returns:
the calculator class name.

setCalculatorClassName

void setCalculatorClassName(String className)
Sets the calculator class name

Parameters:
className - the calculator class name.

process

ReportLayout process(net.sf.jasperreports.engine.JasperReport report,
                     Map<String,Object> params,
                     TableModel data)
                     throws LogException
Processes the specified report.

Parameters:
report - the report.
params - the parameters.
data - the data model.
Returns:
the filled layout.
Throws:
LogException - on errors.

load

net.sf.jasperreports.engine.design.JasperDesign load(String source)
                                                     throws LogException
Loads the specified design.

Parameters:
source - the source path.
Returns:
the loaded design.
Throws:
LogException - on errors.

load

net.sf.jasperreports.engine.design.JasperDesign load(String key,
                                                     String source)
                                                     throws LogException
Loads the specified design.

Parameters:
key - the path key.
source - the source path.
Returns:
the loaded design.
Throws:
LogException - on errors.

load

net.sf.jasperreports.engine.design.JasperDesign load(File source)
                                                     throws LogException
Loads the specified design.

Parameters:
source - the source file.
Returns:
the loaded design.
Throws:
LogException - on errors.

load

net.sf.jasperreports.engine.design.JasperDesign load(URL source)
                                                     throws LogException
Loads the specified design.

Parameters:
source - the source URL.
Returns:
the loaded design.
Throws:
LogException - on errors.

load

net.sf.jasperreports.engine.design.JasperDesign load(Reader reader)
                                                     throws LogException
Loads the specified design.

Parameters:
reader - the source reader.
Returns:
the loaded design.
Throws:
LogException - on errors.

load

net.sf.jasperreports.engine.design.JasperDesign load(InputStream input,
                                                     String encoding)
                                                     throws LogException
Loads the specified design.

Parameters:
input - the source stream.
encoding - the encoding.
Returns:
the loaded design.
Throws:
LogException - on errors.

compile

net.sf.jasperreports.engine.JasperReport compile(String source)
                                                 throws LogException
Compiles the specified design.

Parameters:
source - the source path.
Returns:
the compiled report.
Throws:
LogException - on errors.

compile

net.sf.jasperreports.engine.JasperReport compile(String key,
                                                 String source)
                                                 throws LogException
Compiles the specified design.

Parameters:
key - the path key.
source - the source path.
Returns:
the compiled report.
Throws:
LogException - on errors.

compile

net.sf.jasperreports.engine.JasperReport compile(File source)
                                                 throws LogException
Compiles the specified design.

Parameters:
source - the source file.
Returns:
the compiled report.
Throws:
LogException - on errors.

compile

net.sf.jasperreports.engine.JasperReport compile(URL source)
                                                 throws LogException
Compiles the specified design.

Parameters:
source - the source URL.
Returns:
the compiled report.
Throws:
LogException - on errors.

compile

net.sf.jasperreports.engine.JasperReport compile(Reader reader)
                                                 throws LogException
Compiles the specified design.

Parameters:
reader - the source reader.
Returns:
the compiled report.
Throws:
LogException - on errors.

compile

net.sf.jasperreports.engine.JasperReport compile(InputStream input,
                                                 String encoding)
                                                 throws LogException
Compiles the specified design.

Parameters:
input - the source stream.
encoding - the encoding.
Returns:
the compiled report.
Throws:
LogException - on errors.

compile

net.sf.jasperreports.engine.JasperReport compile(net.sf.jasperreports.engine.design.JasperDesign design)
                                                 throws LogException
Compiles the specified design.

Parameters:
design - the design.
Returns:
the compiled report.
Throws:
LogException - on errors.

interpret

net.sf.jasperreports.engine.JasperReport interpret(String source)
                                                   throws LogException
Interprets the specified design.

Parameters:
source - the source path.
Returns:
the interpreted design.
Throws:
LogException - on errors.

interpret

net.sf.jasperreports.engine.JasperReport interpret(String key,
                                                   String source)
                                                   throws LogException
Interprets the specified design.

Parameters:
key - the path key.
source - the source path.
Returns:
the interpreted report.
Throws:
LogException - on errors.

interpret

net.sf.jasperreports.engine.JasperReport interpret(File source)
                                                   throws LogException
Interprets the specified design.

Parameters:
source - the source file.
Returns:
the interpreted report.
Throws:
LogException - on errors.

interpret

net.sf.jasperreports.engine.JasperReport interpret(URL url)
                                                   throws LogException
Interprets the specified design.

Parameters:
url - the source URL.
Returns:
the interpreted report.
Throws:
LogException - on errors.

interpret

net.sf.jasperreports.engine.JasperReport interpret(Reader reader)
                                                   throws LogException
Interprets the specified design.

Parameters:
reader - the source reader.
Returns:
the interpreted report.
Throws:
LogException - on errors.

interpret

net.sf.jasperreports.engine.JasperReport interpret(InputStream input,
                                                   String encoding)
                                                   throws LogException
Interprets the specified design.

Parameters:
input - the source stream.
encoding - the encoding.
Returns:
the interpreted report.
Throws:
LogException - on errors.

interpret

net.sf.jasperreports.engine.JasperReport interpret(net.sf.jasperreports.engine.design.JasperDesign design)
                                                   throws LogException
Interprets the specified design.

Parameters:
design - the design.
Returns:
the interpreted report.
Throws:
LogException - on errors.

publish

net.sf.jasperreports.engine.JasperPrint publish(String source,
                                                Map<String,Object> params,
                                                net.sf.jasperreports.engine.JRDataSource data)
                                                throws LogException
Publishes the specified design or report.

Parameters:
source - the source path.
params - the parameters.
data - the data source.
Returns:
the published print.
Throws:
LogException - on errors.

publish

net.sf.jasperreports.engine.JasperPrint publish(String key,
                                                String source,
                                                Map<String,Object> params,
                                                net.sf.jasperreports.engine.JRDataSource data)
                                                throws LogException
Publishes the specified design or report.

Parameters:
key - the path key.
source - the source path.
params - the parameters.
data - the data source.
Returns:
the published print.
Throws:
LogException - on errors.

publish

net.sf.jasperreports.engine.JasperPrint publish(File source,
                                                Map<String,Object> params,
                                                net.sf.jasperreports.engine.JRDataSource data)
                                                throws LogException
Publishes the specified design or report.

Parameters:
source - the source file.
params - the parameters.
data - the data source.
Returns:
the published print.
Throws:
LogException - on errors.

publish

net.sf.jasperreports.engine.JasperPrint publish(URL source,
                                                Map<String,Object> params,
                                                net.sf.jasperreports.engine.JRDataSource data)
                                                throws LogException
Publishes the specified design or report.

Parameters:
source - the source URL.
params - the parameters.
data - the data source.
Returns:
the published print.
Throws:
LogException - on errors.

publish

net.sf.jasperreports.engine.JasperPrint publish(InputStream input,
                                                Map<String,Object> params,
                                                net.sf.jasperreports.engine.JRDataSource data)
                                                throws LogException
Publishes the specified report.

Parameters:
input - the source stream.
params - the parameters.
data - the data source.
Returns:
the published print.
Throws:
LogException - on errors.

publish

net.sf.jasperreports.engine.JasperPrint publish(net.sf.jasperreports.engine.design.JasperDesign design,
                                                Map<String,Object> params,
                                                net.sf.jasperreports.engine.JRDataSource data)
                                                throws LogException
Publishes the specified design.

Parameters:
design - the source design.
params - the parameters.
data - the data source.
Returns:
the published print.
Throws:
LogException - on errors.

publish

net.sf.jasperreports.engine.JasperPrint publish(net.sf.jasperreports.engine.JasperReport report,
                                                Map<String,Object> params,
                                                net.sf.jasperreports.engine.JRDataSource data)
                                                throws LogException
Publishes the specified report.

Parameters:
report - the report.
params - the parameters.
data - the data source.
Returns:
the published print.
Throws:
LogException - on errors.

read

Object read(String source)
            throws LogException
Reads the specified object.

Parameters:
source - the source path.
Returns:
the read object.
Throws:
LogException - on errors.

read

Object read(String key,
            String source)
            throws LogException
Reads the specified object.

Parameters:
key - the path key.
source - the source path.
Returns:
the read object.
Throws:
LogException - on errors.

read

Object read(File source)
            throws LogException
Reads the specified object.

Parameters:
source - the source file.
Returns:
the read object.
Throws:
LogException - on errors.

read

Object read(URL source)
            throws LogException
Reads the specified object.

Parameters:
source - the source URL.
Returns:
the read object.
Throws:
LogException - on errors.

read

Object read(InputStream input)
            throws LogException
Reads the specified object.

Parameters:
input - the source stream.
Returns:
the read object.
Throws:
LogException - on errors.

write

void write(Object source,
           String target)
           throws LogException
Writes the specified object.

Parameters:
source - the source object.
target - the target path.
Throws:
LogException - on errors.

write

void write(Object source,
           String key,
           String target)
           throws LogException
Writes the specified object.

Parameters:
source - the source object.
key - the path key.
target - the target path.
Throws:
LogException - on errors.

write

void write(Object source,
           File target)
           throws LogException
Writes the specified object.

Parameters:
source - the source object.
target - the target file.
Throws:
LogException - on errors.

write

void write(Object source,
           OutputStream output)
           throws LogException
Writes the specified object.

Parameters:
source - the source object.
output - the target stream.
Throws:
LogException - on errors.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2004 The Norther Organization. All rights reserved.