Package com.inductiveautomation.rm.shape

Class ReportOwner

java.lang.Object
com.inductiveautomation.rm.shape.ReportOwner
All Implemented Interfaces:
RMKeyChain.Get
public class ReportOwner extends Object implements RMKeyChain.Get
A base class that loads and runs reports.

  • Constructor Details

    • ReportOwner

      public ReportOwner()

  • Method Details

    • getTemplate

      public RMDocument getTemplate()
      Returns the template.

    • createTemplate

      protected RMDocument createTemplate()
      Creates the template.

    • setTemplate

      protected void setTemplate(RMDocument aDoc)
      Sets the template.

    • getNullString

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

    • setNullString

      public void setNullString(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 Object getModel()
      Returns the model object.

    • addModelObject

      public void addModelObject(Object anObj)
      Sets objects in this reportmill.

    • pushDataStack

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

    • popDataStack

      public Object popDataStack()
      Removes a specific object at given index in list.

    • peekDataStack

      public Object peekDataStack()
      Returns the last data object in the data objects list.

    • getDataStack

      public List getDataStack()
      Returns an unmodifiable version of the _dataStack.

    • generateReport

      public RMDocument generateReport()
      Generates the report.

    • rpg

      public RMShape rpg(RMShape aShape, RMShape aParent)
      Performs RPG on a given shape.

    • getPageReferenceShapes

      public List<RMShape> getPageReferenceShapes()
      Returns the list of page reference shapes.

    • setPageReferenceShapes

      public void setPageReferenceShapes(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 Object getKeyChainValue(Object aRoot, RMKeyChain aKeyChain)
      RMKeyChain.Get implementation to run against DataStack.
      Specified by:
      getKeyChainValue in interface RMKeyChain.Get

    • getKeyChainListValue

      public List getKeyChainListValue(String aKeyChain)
      Returns a list for the given keychain.

    • convertToStandardType

      protected Object convertToStandardType(Object anObj)
      Called by various objects to convert objects to generic types.

    • resolvePageReferences

      public void resolvePageReferences()
      Performs page substitutions on any text fields that were identified as containing @Page@ keys.