com.technia.tvc.reportgenerator.impl

Class ReportBase

java.lang.Object

com.technia.tvc.reportgenerator.impl.ReportBase

All Implemented Interfaces:

Report, com.technia.tvc.reportgenerator.util.Debugger.Debuggable, java.io.Serializable

Direct Known Subclasses:

CustomReport

public abstract class ReportBase
extends java.lang.Object
implements Report, java.io.Serializable, com.technia.tvc.reportgenerator.util.Debugger.Debuggable

Since:

6.4.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReportBase()

Method Summary

Modifier and Type	Method and Description
void	addSourceObject(com.technia.tvc.reportgenerator.ObjectRef objectRef) Adds a source object to this report
void	addSourceObject(java.lang.String objectId) Adds a source object to this report
protected void	afterInit(Environment env, com.technia.tvc.reportgenerator.ReportDef def)
Handle	createReport() Creates the report.
void	debug(com.technia.tvc.reportgenerator.util.Debugger d)
protected void	debugOther(com.technia.tvc.reportgenerator.util.Debugger d)
java.lang.String	getContentType()
com.technia.tvc.reportgenerator.ContextProvider	getContextProvider()
Converter	getConverter()
java.util.Date	getCreateDate()
abstract DataExtractor	getDataExtractor() Subclasses returns the proper data extractor, which is used when the report is created.
java.lang.String	getDownloadURL() Returns the URL of the report download page.
java.lang.String	getFileName()
Format	getFormat()
java.lang.String	getId() Returns the id of the report
java.util.Locale	getLocale()
java.lang.String	getName()
OutputHandler[]	getOutputHandlers()
PostProcessor[]	getPostProcessors()
PreProcessor	getPreProcessor()
com.technia.tvc.reportgenerator.ObjectRef	getReportDef() Returns a reference to the definition object, or null, if no definition object is associated with this report instance.
ReportSettings	getSettings()
com.technia.tvc.reportgenerator.ObjectRef	getSourceObject()
int	getSourceObjectCount()
java.util.Iterator<com.technia.tvc.reportgenerator.ObjectRef>	getSourceObjects()
java.lang.String	getStyleSheet()
java.lang.String	getTableName()
void	handleParameters(java.lang.String name, java.lang.String[] values) All parameters submitted from a pre-process page are handled by this method.
protected boolean	handleRuntimeParameter(java.lang.String name, java.lang.String value)
boolean	hasOutputHandler()
boolean	hasSourceObject()
void	init(Environment env, com.technia.tvc.reportgenerator.ReportDef def)
boolean	isConverterDisabled()
boolean	isOutputHandlersDisabled()
boolean	isPostProcessorsDisabled()
boolean	isSerializable()
com.technia.tvc.reportgenerator.ObjectRef	removeSourceObject(java.lang.String id) Removes a source object with the given id.
void	removeSourceObjects() Remove all source objects.
void	setContentType(java.lang.String contentType) This method can be used to explicitly specify the content type of the generated report
void	setContextProvider(com.technia.tvc.reportgenerator.ContextProvider provider)
void	setDisableConverter(boolean disable) This method can be called explicitly to disable the conversion
void	setDisableOutputHandlers(boolean disable) This method can be called explicitly to disable any output handlers being specified on the report definition.
void	setDisablePostProcessors(boolean disable) This method can be used to explicitly disable all the post-processors defined on this report.
void	setEnqueuer(com.technia.tvc.reportgenerator.Enqueuer enqueuer) Allows custom code to use a specialized Enqueuer, which knows how the report will be created
void	setFileName(java.lang.String fileName) This method can be used to explicitly set the file name of the generated report.
void	setFormat(Format format)
protected void	setPreProcessor(PreProcessor preProcessor)
void	setStyleSheet(java.lang.String styleSheet)
void	setTableName(java.lang.String tableName)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReportBase

public ReportBase()

Method Detail

createReport

public Handle createReport()
                    throws TVCException

Description copied from interface: Report

Creates the report. Note that the report might be created asynchronously, hence, you must query the returned Handle for completion

Specified by:

createReport in interface Report

Returns:

The Handle

Throws:

TVCException

setEnqueuer

public void setEnqueuer(com.technia.tvc.reportgenerator.Enqueuer enqueuer)

Description copied from interface: Report

Allows custom code to use a specialized Enqueuer, which knows how the report will be created

Specified by:

setEnqueuer in interface Report

Parameters:

enqueuer - The Enqueuer instance.

init

public void init(Environment env,
                 com.technia.tvc.reportgenerator.ReportDef def)
          throws TVCException

Throws:

TVCException

afterInit

protected void afterInit(Environment env,
                         com.technia.tvc.reportgenerator.ReportDef def)
                  throws TVCException

Throws:

TVCException

getId

public java.lang.String getId()

Returns the id of the report

Specified by:

getId in interface Report

Returns:

The ID of this report

getName

public java.lang.String getName()

Specified by:

getName in interface Report

Returns:

The name of this report

getReportDef

public com.technia.tvc.reportgenerator.ObjectRef getReportDef()

Returns a reference to the definition object, or null, if no definition object is associated with this report instance.

Specified by:

getReportDef in interface Report

Returns:

The report definition (if such were used) as a ObjectRef

getCreateDate

public java.util.Date getCreateDate()

Specified by:

getCreateDate in interface Report

Returns:

The date when the report is created

getPreProcessor

public PreProcessor getPreProcessor()

Specified by:

getPreProcessor in interface Report

Returns:

The PreProcessor attached to this report (if any)

setPreProcessor

protected void setPreProcessor(PreProcessor preProcessor)

getTableName

public java.lang.String getTableName()

setTableName

public void setTableName(java.lang.String tableName)

getStyleSheet

public java.lang.String getStyleSheet()

Specified by:

getStyleSheet in interface Report

Returns:

The name of the stylesheet being used; if any.

setStyleSheet

public void setStyleSheet(java.lang.String styleSheet)

getDataExtractor

public abstract DataExtractor getDataExtractor()

Subclasses returns the proper data extractor, which is used when the report is created.

Specified by:

getDataExtractor in interface Report

Returns:

The DataExtractor used by this report

setDisableConverter

public void setDisableConverter(boolean disable)

Description copied from interface: Report

This method can be called explicitly to disable the conversion

Typically, this method is called from a test class used during development in order to not have to create a specific report definition used for testing

Specified by:

setDisableConverter in interface Report

Parameters:

disable - True to disable

isConverterDisabled

public boolean isConverterDisabled()

getConverter

public Converter getConverter()

Specified by:

getConverter in interface Report

Returns:

The Converter being used.

setContextProvider

public void setContextProvider(com.technia.tvc.reportgenerator.ContextProvider provider)

getContextProvider

public com.technia.tvc.reportgenerator.ContextProvider getContextProvider()

Specified by:

getContextProvider in interface Report

Returns:

The ContextProvider. NOTE: This method is only used internally within the report generator and should normally not be used

getFormat

public Format getFormat()

Specified by:

getFormat in interface Report

Returns:

The format that the generated report has

setFormat

public void setFormat(Format format)

setContentType

public void setContentType(java.lang.String contentType)

Description copied from interface: Report

This method can be used to explicitly specify the content type of the generated report

Specified by:

setContentType in interface Report

Parameters:

contentType - The content type

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface Report

Returns:

The content type of the generated report

setFileName

public void setFileName(java.lang.String fileName)

Description copied from interface: Report

This method can be used to explicitly set the file name of the generated report.

Specified by:

setFileName in interface Report

Parameters:

fileName - The name of the file

getFileName

public java.lang.String getFileName()

Specified by:

getFileName in interface Report

Returns:

The name of the generated file.

addSourceObject

public void addSourceObject(java.lang.String objectId)
                     throws TVCException

Description copied from interface: Report

Adds a source object to this report

Specified by:

addSourceObject in interface Report

Parameters:

objectId - The id of the object to add

Throws:

TVCException - If the id is invalid

addSourceObject

public void addSourceObject(com.technia.tvc.reportgenerator.ObjectRef objectRef)

Description copied from interface: Report

Adds a source object to this report

Specified by:

addSourceObject in interface Report

Parameters:

objectRef - An ObjectRef representing the source object

getSourceObjectCount

public int getSourceObjectCount()

Specified by:

getSourceObjectCount in interface Report

Returns:

The number of source objects.

hasSourceObject

public boolean hasSourceObject()

Specified by:

hasSourceObject in interface Report

Returns:

True if Report.getSourceObjectCount() is greater than zero.

getSourceObject

public com.technia.tvc.reportgenerator.ObjectRef getSourceObject()

Specified by:

getSourceObject in interface Report

Returns:

The first source object (as a ObjectRef instance}

getSourceObjects

public java.util.Iterator<com.technia.tvc.reportgenerator.ObjectRef> getSourceObjects()

Specified by:

getSourceObjects in interface Report

Returns:

An Iterator containing all source objects, if any,

removeSourceObjects

public void removeSourceObjects()

Description copied from interface: Report

Remove all source objects.

Specified by:

removeSourceObjects in interface Report

removeSourceObject

public com.technia.tvc.reportgenerator.ObjectRef removeSourceObject(java.lang.String id)

Description copied from interface: Report

Removes a source object with the given id.

Specified by:

removeSourceObject in interface Report

Parameters:

id - The id of the object

Returns:

The ObjectRef or null if no such object is part of the source object collection.

getSettings

public ReportSettings getSettings()

Specified by:

getSettings in interface Report

Returns:

The report settings

setDisableOutputHandlers

public void setDisableOutputHandlers(boolean disable)

Description copied from interface: Report

This method can be called explicitly to disable any output handlers being specified on the report definition.

Typically, this method is called from a test class used during development in order to not have to create a specific report definition used for testing

Specified by:

setDisableOutputHandlers in interface Report

Parameters:

disable - True to disable

isOutputHandlersDisabled

public boolean isOutputHandlersDisabled()

hasOutputHandler

public boolean hasOutputHandler()

getOutputHandlers

public OutputHandler[] getOutputHandlers()

Specified by:

getOutputHandlers in interface Report

Returns:

The output handlers defined for this report.

setDisablePostProcessors

public void setDisablePostProcessors(boolean disable)

Description copied from interface: Report

This method can be used to explicitly disable all the post-processors defined on this report.

Typically, this method is called from a test class used during development in order to not have to create a specific report definition used for testing

Specified by:

setDisablePostProcessors in interface Report

Parameters:

disable - True to disable

isPostProcessorsDisabled

public boolean isPostProcessorsDisabled()

getPostProcessors

public PostProcessor[] getPostProcessors()

Specified by:

getPostProcessors in interface Report

Returns:

The post processors defined for this report

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface Report

Returns:

The current locale (typically the locale that the user creating the report has)

handleParameters

public void handleParameters(java.lang.String name,
                             java.lang.String[] values)

Description copied from interface: Report

All parameters submitted from a pre-process page are handled by this method. E.g. the parameter names/values within the request from a pre-process page is passed to this method.

Specified by:

handleParameters in interface Report

Parameters:

name - The name of the parameter

values - The values

handleRuntimeParameter

protected boolean handleRuntimeParameter(java.lang.String name,
                                         java.lang.String value)

isSerializable

public boolean isSerializable()

Specified by:

isSerializable in interface Report

Returns:

TRUE if the report is serializable; e.g. the report is able to execute in a so called report queue. Normally, this method returns true, however, subclasses can override this to force not being executed within an external report queue.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

debug

public void debug(com.technia.tvc.reportgenerator.util.Debugger d)

Specified by:

debug in interface com.technia.tvc.reportgenerator.util.Debugger.Debuggable

debugOther

protected void debugOther(com.technia.tvc.reportgenerator.util.Debugger d)

getDownloadURL

public java.lang.String getDownloadURL()

Description copied from interface: Report

Returns the URL of the report download page. This allows report developers to customize which page the report is downloaded from. If this method returns null the standard download page will be used.

Specified by:

getDownloadURL in interface Report

Returns:

The custom download URL.