com.aspc.jasper

Class DBJasperReport

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.jasper.DBJasperReport

All Implemented Interfaces:

SecondaryCacheGroup

public class DBJasperReport
extends DBObject

Jasper report details.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

2010/03/23

Author:

Liam

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID Jasper report details
static java.lang.String	DBCLASS_NAME Jasper report details

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBJasperReport(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static DBJasperReport	create(MutableDataSource mds) Make a new instance of this class.
JasperPrint	fill(JasperReport jasperReport, java.lang.Object param, java.lang.Object extraParam) fill the report
static DBJasperReport	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
java.lang.String	getCode(java.lang.String... args)
DataSourcePlugin	getDataSourcePlugin(java.lang.String className, java.lang.Object pram, java.lang.Object extraParam) getDataSourcePlugin
java.util.Map	getJasperParameters()
java.util.Map	getJasperVariables()
java.lang.String	getName(java.lang.String... args)
java.lang.String	getReport(java.lang.String... args)
java.lang.String	getReportName() Get report name.
java.lang.String	getReportPath(java.lang.String aReportFileName) Get report path
static DBQuery<DBJasperReport>	makeQuery(DataSource ds) Make a new QUERY for this class.
void	print(DBObject printer, java.lang.Object clause) Print report
void	print(DBObject printer, java.lang.Object clause, java.lang.Object extraParam) Print report
void	print(java.lang.String reportFileName, DBObject dbPrinter, java.lang.Object clause, java.lang.Object extraParam) Print report
byte[]	runReportToCSV(java.lang.String reportFileName, java.lang.Object param, java.lang.Object extraParam, java.util.HashMap variables)
DBFile	runReportToCSVFile(java.lang.String folderGK, java.lang.String reportFileName, java.lang.Object param, java.lang.Object extraParam) Run Report To HTML format
byte[]	runReportToExcel(java.lang.String reportFileName, java.lang.Object param, java.lang.Object extraParam, java.util.HashMap variables)
DBFile	runReportToFile(java.lang.String fileType, java.lang.String folderGK, java.lang.String reportFileName, java.lang.Object param, java.lang.Object extraParam) Run Report To File
byte[]	runReportToPdf() Get pdf bytes
byte[]	runReportToPdf(java.lang.Object param) get pdf bytes
byte[]	runReportToPdf(java.lang.Object param, java.lang.Object extraParam) Get pdf bytes
byte[]	runReportToPdf(java.lang.String reportFileName, java.lang.Object param, java.lang.Object extraParam, java.util.HashMap variables) Get pdf bytes
void	runReportToPdfFile(java.lang.String extraClause, java.lang.String fileName, DBFolder parent) Save the report to PDF file
DBFile	runReportToPDFFile(java.lang.String folderGK, java.lang.String reportFileName, java.lang.Object param, java.lang.Object extraParam) Run Report To HTML format
byte[]	runReportToXHTML(java.util.HashMap variables)
byte[]	runReportToXHTML(java.lang.String reportFileName, java.lang.Object param, java.lang.Object extraParam, java.util.HashMap variables)
DBFile	runReportToXHTMLFile(java.lang.String folderGK, java.lang.String reportFileName, java.lang.Object param, java.lang.Object extraParam)
DBFile	runReportToXLSFile(java.lang.String folderGK, java.lang.String reportFileName, java.lang.Object param, java.lang.Object extraParam) Run Report To HTML format
DBJasperReport	setCode(java.lang.String value, java.lang.String... args)
DBJasperReport	setDataSourcePlugin(java.lang.String value, java.lang.String... args)
DBJasperReport	setName(java.lang.String value, java.lang.String... args)
DBJasperReport	setReport(java.lang.String value, java.lang.String... args)
DBJasperReport	setReportName(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Jasper report details

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Jasper report details

Constructor Detail

DBJasperReport

public DBJasperReport(DBClass def,
                      DataSource dataSource)
               throws java.lang.Exception

Std. DBObject constructor

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getCode

@CheckReturnValue
 @Nonnull
public java.lang.String getCode(java.lang.String... args)

setCode

@Nonnull
public DBJasperReport setCode(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

setDataSourcePlugin

@Nonnull
public DBJasperReport setDataSourcePlugin(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getName

@CheckReturnValue
 @Nonnull
public java.lang.String getName(java.lang.String... args)

setName

@Nonnull
public DBJasperReport setName(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getReport

@CheckReturnValue
 @Nonnull
public java.lang.String getReport(java.lang.String... args)

setReport

@Nonnull
public DBJasperReport setReport(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

setReportName

@Nonnull
public DBJasperReport setReportName(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBJasperReport create(@Nonnull
                                                                MutableDataSource mds)
                                                         throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<DBJasperReport> makeQuery(@Nonnull
                                                                            DataSource ds)
                                                                     throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static DBJasperReport findKey(@Nonnull
                                                                 DataSource ds,
                                                                 @Nonnull
                                                                 java.lang.String key)
                                                          throws NotFoundException,
                                                                 java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

fill

public JasperPrint fill(JasperReport jasperReport,
                        java.lang.Object param,
                        java.lang.Object extraParam)
                 throws java.lang.Exception

fill the report

Parameters:

jasperReport - jasperReport

param - param

extraParam - extraParam

Returns:

JasperPrint

Throws:

java.lang.Exception - Exception

print

public void print(DBObject printer,
                  java.lang.Object clause)
           throws java.lang.Exception

Print report

Parameters:

printer - printer

clause - clause

Throws:

java.lang.Exception - exception

print

public void print(DBObject printer,
                  java.lang.Object clause,
                  java.lang.Object extraParam)
           throws java.lang.Exception

Print report

Parameters:

printer - printer

clause - clause

extraParam - extra parameter

Throws:

java.lang.Exception - exception

print

public void print(java.lang.String reportFileName,
                  DBObject dbPrinter,
                  java.lang.Object clause,
                  java.lang.Object extraParam)
           throws java.lang.Exception

Print report

Parameters:

reportFileName - reportFileName

dbPrinter - printer

clause - clause

extraParam - extra parameter

Throws:

java.lang.Exception - exception

runReportToPdf

public byte[] runReportToPdf(java.lang.Object param)
                      throws java.lang.Exception

get pdf bytes

Parameters:

param - parameter

Returns:

bytes bytes

Throws:

java.lang.Exception - exception

runReportToPdf

public byte[] runReportToPdf()
                      throws java.lang.Exception

Get pdf bytes

Returns:

bytes array

Throws:

java.lang.Exception - Exception

runReportToPdf

public byte[] runReportToPdf(java.lang.Object param,
                             java.lang.Object extraParam)
                      throws java.lang.Exception

Get pdf bytes

Parameters:

param - param

extraParam - extraParam

Returns:

bytes array

Throws:

java.lang.Exception - Exception

runReportToPdf

public byte[] runReportToPdf(java.lang.String reportFileName,
                             java.lang.Object param,
                             java.lang.Object extraParam,
                             java.util.HashMap variables)
                      throws java.lang.Exception

Get pdf bytes

Parameters:

reportFileName - filename

param - param

extraParam - extraParam

variables -

Returns:

bytes array

Throws:

java.lang.Exception - Exception

runReportToPdfFile

public void runReportToPdfFile(java.lang.String extraClause,
                               java.lang.String fileName,
                               DBFolder parent)
                        throws java.lang.Exception

Save the report to PDF file

Parameters:

extraClause - clause

fileName - file name

parent - parent directory

Throws:

java.lang.Exception - exception

runReportToFile

public DBFile runReportToFile(java.lang.String fileType,
                              java.lang.String folderGK,
                              java.lang.String reportFileName,
                              java.lang.Object param,
                              java.lang.Object extraParam)
                       throws java.lang.Exception

Run Report To File

Parameters:

fileType - fileType

folderGK - folderGK

reportFileName - reportFileName

param - param

extraParam - extraParam

Returns:

DBFile

Throws:

java.lang.Exception - Exception

runReportToPDFFile

public DBFile runReportToPDFFile(java.lang.String folderGK,
                                 java.lang.String reportFileName,
                                 java.lang.Object param,
                                 java.lang.Object extraParam)
                          throws java.lang.Exception

Run Report To HTML format

Parameters:

folderGK - folder

reportFileName - report file name

param - param

extraParam - param2

Returns:

PDF FILE

Throws:

java.lang.Exception - EXCEPTION

runReportToXHTMLFile

public DBFile runReportToXHTMLFile(java.lang.String folderGK,
                                   java.lang.String reportFileName,
                                   java.lang.Object param,
                                   java.lang.Object extraParam)
                            throws java.lang.Exception

Parameters:

folderGK - folder

reportFileName - filename

param - param

extraParam - the params

Returns:

XHTML file

Throws:

java.lang.Exception - exception

runReportToXHTML

public byte[] runReportToXHTML(java.lang.String reportFileName,
                               java.lang.Object param,
                               java.lang.Object extraParam,
                               java.util.HashMap variables)
                        throws java.lang.Exception

Parameters:

reportFileName - filename

param - param

extraParam - the params

variables -

Returns:

XHTML String

Throws:

java.lang.Exception - exception

runReportToXHTML

public byte[] runReportToXHTML(java.util.HashMap variables)
                        throws java.lang.Exception

Parameters:

variables -

Returns:

XHTML String

Throws:

java.lang.Exception - exception

runReportToCSV

public byte[] runReportToCSV(java.lang.String reportFileName,
                             java.lang.Object param,
                             java.lang.Object extraParam,
                             java.util.HashMap variables)
                      throws java.lang.Exception

Parameters:

reportFileName - filename

param - param

extraParam - the params

variables -

Returns:

XHTML String

Throws:

java.lang.Exception - exception

runReportToCSVFile

public DBFile runReportToCSVFile(java.lang.String folderGK,
                                 java.lang.String reportFileName,
                                 java.lang.Object param,
                                 java.lang.Object extraParam)
                          throws java.lang.Exception

Run Report To HTML format

Parameters:

folderGK - folder

reportFileName - report file name

param - param

extraParam - param2

Returns:

CVS file

Throws:

java.lang.Exception - exception

runReportToXLSFile

public DBFile runReportToXLSFile(java.lang.String folderGK,
                                 java.lang.String reportFileName,
                                 java.lang.Object param,
                                 java.lang.Object extraParam)
                          throws java.lang.Exception

Run Report To HTML format

Parameters:

folderGK - folder

reportFileName - report file name

param - param

extraParam - param2

Returns:

HTML file

Throws:

java.lang.Exception - exception

runReportToExcel

public byte[] runReportToExcel(java.lang.String reportFileName,
                               java.lang.Object param,
                               java.lang.Object extraParam,
                               java.util.HashMap variables)
                        throws java.lang.Exception

Parameters:

reportFileName - filename

param - param

extraParam - the params

variables -

Returns:

XHTML String

Throws:

java.lang.Exception - exception

getDataSourcePlugin

public DataSourcePlugin getDataSourcePlugin(java.lang.String className,
                                            java.lang.Object pram,
                                            java.lang.Object extraParam)
                                     throws java.lang.Exception

getDataSourcePlugin

Parameters:

className - className

pram - parameter

extraParam - extraParameter

Returns:

extraClause clause

Throws:

java.lang.Exception - a serious proble

getJasperParameters

public java.util.Map getJasperParameters()
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getJasperVariables

public java.util.Map getJasperVariables()
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getReportName

public java.lang.String getReportName()

Get report name.

Returns:

report name.

getReportPath

public java.lang.String getReportPath(java.lang.String aReportFileName)
                               throws JRException

Get report path

Parameters:

aReportFileName - file name

Returns:

path

Throws:

JRException - exception