Package com.nomagic.magicdraw.magicreport.tools

Class TemplateTool

  • All Implemented Interfaces:
    com.nomagic.magicreport.engine.ITool, com.nomagic.magicreport.IVariable, java.io.Serializable, java.lang.Cloneable
    @OpenApiAll
public class TemplateTool
extends com.nomagic.magicreport.engine.tools.TemplateTool
    Additional features for template tool.
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface com.nomagic.magicreport.engine.ITool

        com.nomagic.magicreport.engine.ITool.HTMLString, com.nomagic.magicreport.engine.ITool.RetainedString, com.nomagic.magicreport.engine.ITool.Void

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String category  
      private java.lang.String description  
      private com.nomagic.magicdraw.magicreport.ui.bean.ReportBean reportBean  
      private java.util.Map<java.lang.String,​java.lang.Object> reportDataVariableMap  
      private java.lang.String selectedReportData  
      private static long serialVersionUID  

      • Fields inherited from class com.nomagic.magicreport.engine.tools.TemplateTool

        CONTEXT_NAME

      • Fields inherited from class com.nomagic.magicreport.engine.Tool

        context, properties

      • Fields inherited from interface com.nomagic.magicreport.engine.ITool

        VOID

    • Constructor Summary

      Constructors 
      Constructor Description
      TemplateTool()
      Default constructor.
      TemplateTool​(com.nomagic.magicdraw.magicreport.ui.bean.TemplateBean templateBean)
      Create a tool with information from template bean.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCategory()
      Gets category name.
      java.lang.String getDescription()
      Gets description.
      com.nomagic.magicdraw.magicreport.ui.bean.ReportBean getReportData()
      Gets selected report data.
      java.util.List<com.nomagic.magicdraw.magicreport.tools.ReportDataVariable> getReportDataVariables()
      Get all report data variable as list of ReportDataVariable
      java.lang.String getSelectedReportData()
      Gets selected report data name.
      void setReportDataVariableMap​(java.util.Map<java.lang.String,​java.lang.Object> reportDataVariableMap)
      Set report data variable map

      • Methods inherited from class com.nomagic.magicreport.engine.tools.TemplateTool

        getFile, getLatestInputFile, getLatestInputLocation, getLatestOutputFile, getLatestOutputLocation, getLocation, getMainOutputLocation, getMainTemplateLocation, getName, getOutputFile, getOutputFileName, getOutputFileNameNoExt, getOutputFileNoExt, getOutputLocation, getResourcesLocation, getTemplateFile, getTemplateLocation

      • Methods inherited from class com.nomagic.magicreport.engine.Tool

        clone, getContext, getProperties, getProperty, getProperty, notifyObservers, setContext, setProperties

      • Methods inherited from class java.util.Observable

        addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • description

        private java.lang.String description

      • category

        private java.lang.String category

      • selectedReportData

        private java.lang.String selectedReportData

      • reportBean

        private com.nomagic.magicdraw.magicreport.ui.bean.ReportBean reportBean

      • reportDataVariableMap

        private java.util.Map<java.lang.String,​java.lang.Object> reportDataVariableMap

    • Constructor Detail

      • TemplateTool

        public TemplateTool()
        Default constructor.

      • TemplateTool

        public TemplateTool​(com.nomagic.magicdraw.magicreport.ui.bean.TemplateBean templateBean)
        Create a tool with information from template bean.
        Parameters:
        templateBean - template bean

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Gets description.
        Returns:
        the description

      • getCategory

        public java.lang.String getCategory()
        Gets category name.
        Returns:
        the category name

      • getSelectedReportData

        public java.lang.String getSelectedReportData()
        Gets selected report data name.
        Returns:
        the selected report data name

      • getReportData

        public com.nomagic.magicdraw.magicreport.ui.bean.ReportBean getReportData()
        Gets selected report data.
        Returns:
        the selected report data

      • setReportDataVariableMap

        public void setReportDataVariableMap​(java.util.Map<java.lang.String,​java.lang.Object> reportDataVariableMap)
        Set report data variable map
        Parameters:
        reportDataVariableMap - map of report data variable

      • getReportDataVariables

        public java.util.List<com.nomagic.magicdraw.magicreport.tools.ReportDataVariable> getReportDataVariables()
        Get all report data variable as list of ReportDataVariable
        Returns:
        list of ReportDataVariable