com.aspc.jasper

Class DBPrintJasperReport

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.jasper.DBPrintJasperReport

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

AgileActivityReport, BranchLabel, BranchMeetingReport, BranchReport, CommitteeLabel, CommitteeReport, ComplaintReport, ConferenceLabels, ConferenceReport, CurrentMemberStatistics, DailyBankDepositListing, EmployerLabel, EmployerReport, FederalVotingList, JobTimeBillingReport, LoadEmployerDeduction, MemberGenderStatistics, MemberLabel, MemberRenewal, MemberRenewalStatistics, MemberReport, MemberSchoolInBranchStatistics, NewMemberStatistics, OutstandingRefundRejectPayments, PrintEmployerDeductionLetter, PrintEmployerPayments, PrintMemberCard, PrintMemberStatement, ProcessMembershipReceipts, UnionAccountingFigures, UnionAccountingFiguresV2, UnionIncomeSummary, WorkplaceLabel, WorkplaceReport, WorkplaceVisitStatistics

public class DBPrintJasperReport
extends DBObject

Print Jasper Report.

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

Since:

$Date: 2014-12-18 01:49:04 $

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 Print Jasper Report
static java.lang.String	DBCLASS_NAME Print Jasper Report

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected DBResult	convertMultiValuesToDBResult(java.lang.String multiString)
static DBPrintJasperReport	create(MutableDataSource mds) Make a new instance of this class.
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsMandatory(DBField field) Conditional mandatory field.
Person	findCreatedBy(java.lang.String... args) Created by user.
DBFile	findFile(java.lang.String... args) The generated file.
DBJasperReport	findJasper(java.lang.String... args) The jasper report.
static DBPrintJasperReport	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBPrinter	findPrinter(java.lang.String... args) The printer.
DBPrintType	findType(java.lang.String... args) The print type (PDF/Printer).
Person	getCreatedBy(java.lang.String... args)
java.util.Date	getCreatedTime(java.lang.String... args)
DBFile	getFile(java.lang.String... args)
int	getID(java.lang.String... args)
DBJasperReport	getJasper(java.lang.String... args)
DBPrinter	getPrinter(java.lang.String... args)
protected DBResult	getReportDBResult(java.lang.String className, java.lang.String sort) Get report DBResult
java.lang.String	getResult(java.lang.String... args)
java.lang.String	getSearchParams(java.lang.String... args)
java.lang.String	getSelectedRecords(java.lang.String... args)
DBPrintType	getType(java.lang.String... args)
protected DBReportCriteria	makeCriteria(DBReport report, java.lang.String par) Make Report Criteria
static DBQuery<DBPrintJasperReport>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBPrintJasperReport	setCreatedBy(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
DBPrintJasperReport	setCreatedTime(java.util.Date value, java.lang.String... args)
DBPrintJasperReport	setFile(com.aspc.dal.file.DBFile value, java.lang.String... args)
DBPrintJasperReport	setID(int value, java.lang.String... args)
DBPrintJasperReport	setJasper(com.aspc.dal.jasper.DBJasperReport value, java.lang.String... args)
DBPrintJasperReport	setPrinter(com.aspc.dal.jasper.DBPrinter value, java.lang.String... args)
DBPrintJasperReport	setResult(java.lang.String value, java.lang.String... args)
DBPrintJasperReport	setSearchParams(java.lang.String value, java.lang.String... args)
DBPrintJasperReport	setSelectedRecords(java.lang.String value, java.lang.String... args)
DBPrintJasperReport	setType(com.aspc.dal.jasper.DBPrintType value, java.lang.String... args)
protected DBFile	writeBytesToFile(byte[] bytes, java.lang.String fileName, java.lang.String folderGK) Write report to file

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, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, 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

Print Jasper Report

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Print Jasper Report

Constructor Detail

DBPrintJasperReport

public DBPrintJasperReport(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

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public DBPrintJasperReport setID(int value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getCreatedBy

@CheckReturnValue
 @Nullable
public Person getCreatedBy(java.lang.String... args)

findCreatedBy

@CheckReturnValue
 @Nonnull
public final Person findCreatedBy(java.lang.String... args)
                                                       throws NotFoundException

Created by user.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setCreatedBy

@Nonnull
public DBPrintJasperReport setCreatedBy(com.aspc.dal.layers.aspc_app.contact.Person value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getCreatedTime

@CheckReturnValue
 @Nullable
public java.util.Date getCreatedTime(java.lang.String... args)

setCreatedTime

@Nonnull
public DBPrintJasperReport setCreatedTime(java.util.Date value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getFile

@CheckReturnValue
 @Nullable
public DBFile getFile(java.lang.String... args)

findFile

@CheckReturnValue
 @Nonnull
public final DBFile findFile(java.lang.String... args)
                                                  throws NotFoundException

The generated file.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setFile

@Nonnull
public DBPrintJasperReport setFile(com.aspc.dal.file.DBFile value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getJasper

@CheckReturnValue
 @Nullable
public DBJasperReport getJasper(java.lang.String... args)

findJasper

@CheckReturnValue
 @Nonnull
public final DBJasperReport findJasper(java.lang.String... args)
                                                            throws NotFoundException

The jasper report.

--> DBJasperReport (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBJasperReport

Throws:

NotFoundException - DBJasperReport was not found

setJasper

@Nonnull
public DBPrintJasperReport setJasper(com.aspc.dal.jasper.DBJasperReport value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getPrinter

@CheckReturnValue
 @Nullable
public DBPrinter getPrinter(java.lang.String... args)

findPrinter

@CheckReturnValue
 @Nonnull
public final DBPrinter findPrinter(java.lang.String... args)
                                                        throws NotFoundException

The printer.

--> DBPrinter (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBPrinter

Throws:

NotFoundException - DBPrinter was not found

setPrinter

@Nonnull
public DBPrintJasperReport setPrinter(com.aspc.dal.jasper.DBPrinter value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getResult

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

setResult

@Nonnull
public DBPrintJasperReport setResult(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getSearchParams

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

setSearchParams

@Nonnull
public DBPrintJasperReport setSearchParams(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getSelectedRecords

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

setSelectedRecords

@Nonnull
public DBPrintJasperReport setSelectedRecords(java.lang.String value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

getType

@CheckReturnValue
 @Nullable
public DBPrintType getType(java.lang.String... args)

findType

@CheckReturnValue
 @Nonnull
public final DBPrintType findType(java.lang.String... args)
                                                       throws NotFoundException

The print type (PDF/Printer).

--> DBPrintType (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBPrintType

Throws:

NotFoundException - DBPrintType was not found

setType

@Nonnull
public DBPrintJasperReport setType(com.aspc.dal.jasper.DBPrintType value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBPrintJasperReport 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<DBPrintJasperReport> 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 DBPrintJasperReport findKey(@Nonnull
                                                                      DataSource ds,
                                                                      int 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

extAutoEnterCreate

@OverridingMethodsMustInvokeSuper
protected void extAutoEnterCreate()
                                                             throws java.lang.Exception

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class DBObject

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem

makeCriteria

protected DBReportCriteria makeCriteria(DBReport report,
                                        java.lang.String par)
                                 throws java.lang.Exception

Make Report Criteria

Parameters:

report - the report

par - the parameters

Returns:

Report Criteria

Throws:

java.lang.Exception - a serous problem

writeBytesToFile

protected DBFile writeBytesToFile(byte[] bytes,
                                  java.lang.String fileName,
                                  java.lang.String folderGK)
                           throws java.lang.Exception

Write report to file

Parameters:

bytes - bytes

fileName - fileName

folderGK - folderGK

Returns:

the value

Throws:

java.lang.Exception - a serious problem.

convertMultiValuesToDBResult

protected DBResult convertMultiValuesToDBResult(java.lang.String multiString)

Parameters:

multiString - GlobalKeys separate by comma

Returns:

DBResult

getReportDBResult

protected DBResult getReportDBResult(java.lang.String className,
                                     java.lang.String sort)
                              throws java.lang.Exception

Get report DBResult

Parameters:

className - className

sort - sort

Returns:

DBResult

Throws:

java.lang.Exception - exception