net.windward.xmlreport
Interface ProcessReportAPI

All Superinterfaces:

ProcessReportAPIBase

All Known Subinterfaces:

ProcessDocxAPI, ProcessExcelMLAPI, ProcessHtmlAPI, ProcessPdfAPI, ProcessRtfAPI, ProcessTxtAPI, ProcessWordMLAPI, ProcessXlsAPI, ProcessXlsxAPI

All Known Implementing Classes:

ProcessReport

public interface ProcessReportAPI

extends ProcessReportAPIBase

This class is the base class that takes a template stream and a DataSource and merges them to create a report stream. The way to use this is to construct an object that extends this class, set any options, then call the process methods.

Version:

2.0 2 January 2004

Field Summary

static int	CHARSET_DEFAULT Set the charset based on Windward Report's internal rules.
static int	CHARSET_RTF Set the charset to the default in the template rtf file.
static int	CHARSET_UNICODE Set the charset to unicode.
static java.util.Locale	LOCALE_DEFAULT Set the locale based on Windward Report's internal rules.
static java.util.Locale	LOCALE_SYSTEM Set the locale to the system's default locale.
static int	TYP_DOCX The output will be a DOCX document.
static int	TYP_EXCEL_ML The output will be a SmlWorkbook document.
static int	TYP_HTML The output report stream will be an HTML document
static int	TYP_PDF The output report stream will be a PDF document
static int	TYP_RTF The output report stream will be a RTF document
static int	TYP_TXT The output report stream will be an ASCII text document
static int	TYP_WORD_ML The output will be a WordML document.
static int	TYP_XLS The output report will be an Excel (.xls) document.
static int	TYP_XLSX The output will be a XLSX document.

Method Summary

void	setChartProvider(net.windward.chart.ChartProvider charting) Returns the chart provider used for this process.

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase

addBean, close, duplicate, getBaseDirectory, getCharset, getInfo, getKeywords, getLocale, getNumPages, getReport, getReportType, getSubject, getTitle, isDebugMode, process, processComplete, processData, processSetup, processSetup, setBaseDirectory, setCharset, setDebugMode, setKeywords, setLocale, setSubject, setTitle

Field Detail

TYP_RTF

public static final int TYP_RTF

The output report stream will be a RTF document

TYP_PDF

public static final int TYP_PDF

The output report stream will be a PDF document

TYP_HTML

public static final int TYP_HTML

The output report stream will be an HTML document

TYP_TXT

public static final int TYP_TXT

The output report stream will be an ASCII text document

TYP_XLS

public static final int TYP_XLS

The output report will be an Excel (.xls) document.

TYP_EXCEL_ML

public static final int TYP_EXCEL_ML

The output will be a SmlWorkbook document.

TYP_WORD_ML

public static final int TYP_WORD_ML

The output will be a WordML document.

TYP_DOCX

public static final int TYP_DOCX

The output will be a DOCX document.

TYP_XLSX

public static final int TYP_XLSX

The output will be a XLSX document.

CHARSET_DEFAULT

public static final int CHARSET_DEFAULT

Set the charset based on Windward Report's internal rules. For html this is utf-8 (unicode) unless it's HTML_1 in which case it's the rtf template language. For txt it's the rtf template native format.

CHARSET_UNICODE

public static final int CHARSET_UNICODE

Set the charset to unicode.

CHARSET_RTF

public static final int CHARSET_RTF

Set the charset to the default in the template rtf file.

LOCALE_DEFAULT

public static final java.util.Locale LOCALE_DEFAULT

Set the locale based on Windward Report's internal rules. This will set it to the rtf template native format. You can use null instead of this constant.

LOCALE_SYSTEM

public static final java.util.Locale LOCALE_SYSTEM

Set the locale to the system's default locale. You can use Locale.getDefault() instead of this constant.

Method Detail

setChartProvider

public void setChartProvider(net.windward.chart.ChartProvider charting)

Returns the chart provider used for this process. The default is JFreeChartProvider.

Parameters:

charting - The chart provider to use.