Package com.reportmill.base

Class ReportMill

java.lang.Object
com.reportmill.base.RMObject
com.reportmill.base.ReportMill
All Implemented Interfaces:
RMArchiver.Archiving, RMKey.ValueForKeyChain, Cloneable
public class ReportMill extends RMObject implements RMKey.ValueForKeyChain
This class is used as a helper object by RMDocument to generate a report.

  • Field Details

  • Constructor Details

    • ReportMill

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

  • Method Details

    • getPaginate

      public boolean getPaginate()
      Returns whether this reportmill paginates.

    • getDataObjects

      public List getDataObjects()
      Returns the data objects list.

    • getPageIndex

      public int getPageIndex()
      Returns the current page being processed during report generation.

    • getNullString

      public String getNullString()
      Returns the string used to represent null values.

    • generateReport

      public RMDocument generateReport(RMDocument aDoc, Object objects, Object userInfo, boolean paginate)
      Returns a rpg clone of the given document with given objects, userInfo and pagination setting.

    • getDataObject

      public Object getDataObject(int anIndex)
      Returns the data object at the specified index.

    • addDataObject

      public void addDataObject(Object anObj)
      Adds a data object to the data object list.

    • removeDataObject

      public void removeDataObject(Object anObj)
      Removes an object from the data object list.

    • addUserInfo

      public void addUserInfo(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 Object convertFromAppServerType(Object anObj)
      Called by various objects to convert objects to generic types.

    • listValueForKeyChain

      public List listValueForKeyChain(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 Object getRPGCloneForObject(Object anObj)
      Returns the corresponding rpg'd object for an original object.

    • setRPGCloneForObject

      public void setRPGCloneForObject(Object aCopy, Object anObj)
      Sets the corresponding rpg'd object for an original object.

    • valueForKeyChain

      public Object valueForKeyChain(Object aKeyChain)
      ReportMill's valueForKeyChain implementation.
      Specified by:
      valueForKeyChain in interface RMKey.ValueForKeyChain

    • getLicense

      public static String getLicense()
      Returns the ReportMill license string for the current user.

    • setLicense

      public static void setLicense(String aLicense)
      Sets the ReportMill license string for the current user.

    • setLicense

      public static void setLicense(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.