com.reportmill.shape

Class ReportOwner

java.lang.Object

com.reportmill.shape.ReportOwner

All Implemented Interfaces:

RMKeyChain.Get

public class ReportOwner
extends java.lang.Object
implements RMKeyChain.Get

A base class that loads and runs reports.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportOwner.ShapeList A shape class to represent multiple pages of shapes.

Constructor Summary

Constructors

Constructor and Description
ReportOwner()

Method Summary

Modifier and Type	Method and Description
void	addModelObject(java.lang.Object anObj) Sets objects in this reportmill.
void	addPageReferenceShape(RMShape aShape) Registers a shape with a page key in it.
RMDocument	generateReport() Generates the report.
java.util.List	getKeyChainListValue(java.lang.String aKeyChain) Returns a list for the given keychain.
java.lang.Object	getKeyChainValue(java.lang.Object aRoot, RMKeyChain aKeyChain) RMKeyChain.Get implementation to run against DataStack.
java.lang.Object	getModel() Returns the model object.
java.lang.String	getNullString() Returns the string used to represent null values.
java.util.List<RMShape>	getPageReferenceShapes() Returns the list of page reference shapes.
boolean	getPaginate() Returns whether this reportmill paginates.
RMDocument	getTemplate() Returns the template.
java.lang.Object	peekDataStack() Returns the last data object in the data objects list.
java.lang.Object	popDataStack() Removes a specific object at given index in list.
void	pushDataStack(java.lang.Object anObj) Adds a data object to the data object list.
void	resolvePageReferences() Performs page substitutions on any text fields that were identified as containing @Page@ keys.
RMShape	rpg(RMShape aShape, RMShape aParent) Performs RPG on a given shape.
void	setNullString(java.lang.String aString) Sets the string used to represent null values.
void	setPageReferenceShapes(java.util.List aList) Sets the list of page reference shapes.
void	setPaginate(boolean aFlag) Sets whether this reportmill paginates.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportOwner

public ReportOwner()

Method Detail

getTemplate

public RMDocument getTemplate()

Returns the template.

getNullString

public java.lang.String getNullString()

Returns the string used to represent null values.

setNullString

public void setNullString(java.lang.String aString)

Sets the string used to represent null values.

getPaginate

public boolean getPaginate()

Returns whether this reportmill paginates.

setPaginate

public void setPaginate(boolean aFlag)

Sets whether this reportmill paginates.

getModel

public java.lang.Object getModel()

Returns the model object.

addModelObject

public void addModelObject(java.lang.Object anObj)

Sets objects in this reportmill.

pushDataStack

public void pushDataStack(java.lang.Object anObj)

Adds a data object to the data object list.

popDataStack

public java.lang.Object popDataStack()

Removes a specific object at given index in list.

peekDataStack

public java.lang.Object peekDataStack()

Returns the last data object in the data objects list.

generateReport

public RMDocument generateReport()

Generates the report.

rpg

public RMShape rpg(RMShape aShape,
                   RMShape aParent)

Performs RPG on a given shape.

getPageReferenceShapes

public java.util.List<RMShape> getPageReferenceShapes()

Returns the list of page reference shapes.

setPageReferenceShapes

public void setPageReferenceShapes(java.util.List aList)

Sets the list of page reference shapes.

addPageReferenceShape

public void addPageReferenceShape(RMShape aShape)

Registers a shape with a page key in it.

getKeyChainValue

public java.lang.Object getKeyChainValue(java.lang.Object aRoot,
                                         RMKeyChain aKeyChain)

RMKeyChain.Get implementation to run against DataStack.

Specified by:

getKeyChainValue in interface RMKeyChain.Get

getKeyChainListValue

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

Returns a list for the given keychain.

resolvePageReferences

public void resolvePageReferences()

Performs page substitutions on any text fields that were identified as containing @Page@ keys.