Package com.reportmill.base

Class ReportMill

java.lang.Object

com.reportmill.base.RMObject

com.reportmill.base.ReportMill

All Implemented Interfaces:

RMArchiver.Archiving, RMKey.ValueForKeyChain, java.lang.Cloneable

public class ReportMill
extends RMObject
implements RMKey.ValueForKeyChain

This class is used as a helper object by RMDocument to generate a report.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReportMill.AppServer	An inner class to provide a hook for converting objects (like NSArray to List, etc.).
static interface	ReportMill.Listener	An interface for classes than want to know about filled shapes.

Field Summary

Fields

Modifier and Type	Field	Description
static ReportMill.AppServer	appServer

Constructor Summary

Constructors

Constructor	Description
ReportMill()	Creates a new reportmill with the specified paginate option (true or false).

Method Summary

Modifier and Type	Method	Description
void	addDataObject(java.lang.Object anObj)	Adds a data object to the data object list.
void	addPageReferenceShape(RMShape aShape)	Registers a shape with a page key in it.
void	addUserInfo(java.lang.Object userInfo)	Adds a user info object to the data objects list (also handles ReportMill.Listeners).
static java.lang.Object	convertFromAppServerType(java.lang.Object anObj)	Called by various objects to convert objects to generic types.
void	didFillShape(RMShape aShape, RMShape aCopy)	Called by shapes when rpgCloned to notify listener.
RMDocument	generateReport(RMDocument aDoc, java.lang.Object objects, java.lang.Object userInfo, boolean paginate)	Returns a rpg clone of the given document with given objects, userInfo and pagination setting.
java.lang.Object	getDataObject(int anIndex)	Returns the data object at the specified index.
java.util.List	getDataObjects()	Returns the data objects list.
static java.lang.String	getLicense()	Returns the ReportMill license string for the current user.
java.lang.String	getNullString()	Returns the string used to represent null values.
int	getPageIndex()	Returns the current page being processed during report generation.
boolean	getPaginate()	Returns whether this reportmill paginates.
java.lang.Object	getRPGCloneForObject(java.lang.Object anObj)	Returns the corresponding rpg'd object for an original object.
static boolean	isLicensed()	Returns whether ReportMill has a valid license for the current user.
static void	lc(RMDocument aDoc)	Simple lc check.
java.util.List	listValueForKeyChain(java.lang.String aKeyChain)	Returns a list for the given keychain.
void	removeDataObject(java.lang.Object anObj)	Removes an object from the data object list.
static void	setLicense(java.lang.String aLicense)	Sets the ReportMill license string for the current user.
static void	setLicense(java.lang.String aLicense, boolean persistent, boolean isApp)	Sets the ReportMill license string for the current user (with option to persist).
static void	setLicenseState(LicenseState licenseState)
void	setRPGCloneForObject(java.lang.Object aCopy, java.lang.Object anObj)	Sets the corresponding rpg'd object for an original object.
java.lang.Object	valueForKeyChain(java.lang.Object aKeyChain)	ReportMill's valueForKeyChain implementation.

Methods inherited from class com.reportmill.base.RMObject

clone, copy, didChange, didUndo, getAnimAttribute, getClassNameShort, initWithArchiver, undoClone, undoCopy, undoEquals

Methods inherited from class java.lang.Object

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

Field Detail

appServer

public static ReportMill.AppServer appServer

Constructor Detail

ReportMill

public ReportMill()

Creates a new reportmill with the specified paginate option (true or false).

Method Detail

getPaginate

public boolean getPaginate()

Returns whether this reportmill paginates.

getDataObjects

public java.util.List getDataObjects()

Returns the data objects list.

getPageIndex

public int getPageIndex()

Returns the current page being processed during report generation.

getNullString

public java.lang.String getNullString()

Returns the string used to represent null values.

generateReport

public RMDocument generateReport(RMDocument aDoc,
                                 java.lang.Object objects,
                                 java.lang.Object userInfo,
                                 boolean paginate)

Returns a rpg clone of the given document with given objects, userInfo and pagination setting.

getDataObject

public java.lang.Object getDataObject(int anIndex)

Returns the data object at the specified index.

addDataObject

public void addDataObject(java.lang.Object anObj)

Adds a data object to the data object list.

removeDataObject

public void removeDataObject(java.lang.Object anObj)

Removes an object from the data object list.

addUserInfo

public void addUserInfo(java.lang.Object userInfo)

Adds a user info object to the data objects list (also handles ReportMill.Listeners).

didFillShape

public void didFillShape(RMShape aShape,
                         RMShape aCopy)

Called by shapes when rpgCloned to notify listener.

convertFromAppServerType

public static java.lang.Object convertFromAppServerType(java.lang.Object anObj)

Called by various objects to convert objects to generic types.

listValueForKeyChain

public java.util.List listValueForKeyChain(java.lang.String aKeyChain)

Returns a list for the given keychain.

addPageReferenceShape

public void addPageReferenceShape(RMShape aShape)

Registers a shape with a page key in it.

getRPGCloneForObject

public java.lang.Object getRPGCloneForObject(java.lang.Object anObj)

Returns the corresponding rpg'd object for an original object.

setRPGCloneForObject

public void setRPGCloneForObject(java.lang.Object aCopy,
                                 java.lang.Object anObj)

Sets the corresponding rpg'd object for an original object.

valueForKeyChain

public java.lang.Object valueForKeyChain(java.lang.Object aKeyChain)

ReportMill's valueForKeyChain implementation.

Specified by:

valueForKeyChain in interface RMKey.ValueForKeyChain

getLicense

public static java.lang.String getLicense()

Returns the ReportMill license string for the current user.

setLicense

public static void setLicense(java.lang.String aLicense)

Sets the ReportMill license string for the current user.

setLicense

public static void setLicense(java.lang.String aLicense,
                              boolean persistent,
                              boolean isApp)

Sets the ReportMill license string for the current user (with option to persist).

isLicensed

public static boolean isLicensed()

Returns whether ReportMill has a valid license for the current user.

setLicenseState

public static void setLicenseState(LicenseState licenseState)

lc

public static void lc(RMDocument aDoc)

Simple lc check.