Package com.inet.report

Class SummaryInfo

  • All Implemented Interfaces:
    java.io.Serializable
    public class SummaryInfo
extends java.lang.Object
implements java.io.Serializable
    With this class SummaryInfo you can get/set the report summary info specified in the "Summary Info" of the i-net Designer or with the setXXX methods in this class.
    For example:

    Engine eng = new Engine( Engine.NO_EXPORT );
    eng.setReportFile( "file:C:/MyReports/Report1.rpt" );
    SummaryInfo su = eng.getSummaryInfo();
    System.out.println("created: "+su.getCreated());
    System.out.println("LastSaved: "+su.getLastSaved());
    System.out.println("Author: "+su.getAuthor());
    System.out.println("Subject: "+su.getSubject());
    System.out.println("ReportTitle: "+su.getReportTitle());
    Since:
    6.0
    See Also:
    Engine.getSummaryInfo(), Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAuthor()
      Returns the author of the report if the value was specified in the "Summary Info" or with the method setAuthor(String).
      java.lang.String getComments()
      Returns the comments of the report if the value was specified in the "Summary Info" or with the method setComments(String).
      java.util.Date getCreated()
      Returns the date and time the report was created.
      java.lang.String getKeywords()
      Returns the keywords of the report if the value was specified in the "Summary Info" or with the method setKeywords(String).
      java.util.Date getLastSaved()
      Returns the date and time set as the last time the report was saved.
      java.lang.String getReportTitle()
      Returns the report title if the value was specified in the "Summary Info" or with the method setReportTitle(String).
      java.lang.String getSubject()
      Returns the subject of the report if the value was specified in the "Summary Info" or with the method setSubject(String).
      java.lang.String getTemplate()
      Returns the template value of the report if the value was specified in the "Summary Info" or with the method setTemplate(String).
      java.awt.Image getThumbnail()
      FOR INTERNAL USE ONLY Gets the report's "thumbnail" image if there is one.
      byte[] getThumbnailData()
      FOR INTERNAL USE ONLY Gets the report's "thumbnail" image if there is one.
      void setAuthor​(java.lang.String author)
      Sets the author of the report.
      void setComments​(java.lang.String comments)
      Sets the comments of the report.
      void setCreated​(java.util.Date createTime)
      Sets the date and time the report was created.
      void setKeywords​(java.lang.String keywords)
      Sets the keywords of the report as a single string.
      void setLastSaved​(java.util.Date lastSave)
      Sets the date and time the report was last saved.
      void setReportTitle​(java.lang.String title)
      Sets the report title.
      void setSubject​(java.lang.String subject)
      Sets the subject of the report, that is, the general theme.
      void setTemplate​(java.lang.String template)
      Sets the template field of the report.
      void setThumbnail​(java.awt.Image img)
      FOR INTERNAL USE ONLY Sets the image as the report's "thumbnail" image.
      void setThumbnailData​(byte[] data)
      FOR INTERNAL USE ONLY Sets the image as the report's "thumbnail" image.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getAuthor

        public java.lang.String getAuthor()
        Returns the author of the report if the value was specified in the "Summary Info" or with the method setAuthor(String).
        Returns:
        The author of the report if specified, otherwise null
        Since:
        6.0
        See Also:
        setAuthor(String)

      • setAuthor

        public void setAuthor​(java.lang.String author)
        Sets the author of the report.
        Parameters:
        author - Author of the report
        Since:
        6.0
        See Also:
        getAuthor()

      • getKeywords

        public java.lang.String getKeywords()
        Returns the keywords of the report if the value was specified in the "Summary Info" or with the method setKeywords(String).
        Returns:
        The keywords of the report if specified
        Since:
        6.0
        See Also:
        setKeywords(String)

      • setKeywords

        public void setKeywords​(java.lang.String keywords)
        Sets the keywords of the report as a single string.
        Parameters:
        keywords - Keywords of the report as a single string.
        Since:
        6.0
        See Also:
        getKeywords()

      • getComments

        public java.lang.String getComments()
        Returns the comments of the report if the value was specified in the "Summary Info" or with the method setComments(String).
        Returns:
        The comments saved in the report, if any.
        Since:
        6.0
        See Also:
        setComments(String)

      • setComments

        public void setComments​(java.lang.String comments)
        Sets the comments of the report. These could be for example the reason for the report, or or changes which have been made to the report, etc.
        Parameters:
        comments - Comments to set for the report
        Since:
        6.0
        See Also:
        getComments()

      • getReportTitle

        public java.lang.String getReportTitle()
        Returns the report title if the value was specified in the "Summary Info" or with the method setReportTitle(String).
        Returns:
        The report title if specified, else null
        Since:
        6.0
        See Also:
        setReportTitle(String)

      • setReportTitle

        public void setReportTitle​(java.lang.String title)
        Sets the report title. May be null if no title is to be set. The title is used as label for the view tabs in the viewer and as export file name.
        Parameters:
        title - Title to set for the report, may be null
        Since:
        6.0
        See Also:
        getReportTitle()

      • getSubject

        public java.lang.String getSubject()
        Returns the subject of the report if the value was specified in the "Summary Info" or with the method setSubject(String).
        Returns:
        The subject of the report if specified
        Since:
        6.0
        See Also:
        setSubject(String)

      • setSubject

        public void setSubject​(java.lang.String subject)
        Sets the subject of the report, that is, the general theme.
        Parameters:
        subject - Subject to set for the report
        Since:
        6.0
        See Also:
        getSubject()

      • getTemplate

        public java.lang.String getTemplate()
        Returns the template value of the report if the value was specified in the "Summary Info" or with the method setTemplate(String).
        Returns:
        The value of the template field if specified.
        Since:
        6.0
        See Also:
        setTemplate(String)

      • setTemplate

        public void setTemplate​(java.lang.String template)
        Sets the template field of the report. Note that at this point, this has no effect other than to save another string in the SummaryInfo.
        Parameters:
        template - String to save as "template" of the report.
        Since:
        6.0
        See Also:
        getTemplate()

      • getCreated

        public java.util.Date getCreated()
        Returns the date and time the report was created.
        Returns:
        Date and time set as report creation time.
        Since:
        6.0
        See Also:
        setCreated(java.util.Date)

      • setCreated

        public void setCreated​(java.util.Date createTime)
        Sets the date and time the report was created.
        Parameters:
        createTime - Time to set as the creation date of the report.
        Since:
        6.0
        See Also:
        getCreated()

      • getLastSaved

        public java.util.Date getLastSaved()
        Returns the date and time set as the last time the report was saved.
        Returns:
        The date and time set as the last time the report was saved.
        Since:
        6.0
        See Also:
        setLastSaved(java.util.Date)

      • setLastSaved

        public void setLastSaved​(java.util.Date lastSave)
        Sets the date and time the report was last saved.
        Parameters:
        lastSave - Date and time to set the report as being last saved on
        Since:
        6.0
        See Also:
        getLastSaved()

      • setThumbnail

        public void setThumbnail​(java.awt.Image img)
        FOR INTERNAL USE ONLY Sets the image as the report's "thumbnail" image. This image is stored within the report as Thumbnails/Thumbnail.png. This overwrites the currently set thumbnail. Setting null is allowed and causes the thumbnail to be the default thumbnail image. The thumbnail image is scaled to 96x96 pixels.
        Parameters:
        img - Image to store as the report's thumbnail. Null is allowed.
        Since:
        9.0

      • getThumbnail

        public java.awt.Image getThumbnail()
        FOR INTERNAL USE ONLY Gets the report's "thumbnail" image if there is one. Can be null, which means no thumbnail exists for the report (e.g. if the report is in an old report format).
        Returns:
        the report's thumbnail image or null if the report has no thumbnail
        Since:
        9.0

      • setThumbnailData

        public void setThumbnailData​(byte[] data)
        FOR INTERNAL USE ONLY Sets the image as the report's "thumbnail" image. This image is stored within the report as Thumbnails/Thumbnail.png. This overwrites the currently set thumbnail. Setting null is allowed and causes the thumbnail to be the default thumbnail image. The thumbnail image is scaled to 96x96 pixels.
        Parameters:
        data - Image to store as the report's thumbnail. Null is allowed. The bytes must be readable from ImageIO.
        Since:
        11.0

      • getThumbnailData

        public byte[] getThumbnailData()
        FOR INTERNAL USE ONLY Gets the report's "thumbnail" image if there is one. Can be null, which means no thumbnail exists for the report (e.g. if the report is in an old report format).
        Returns:
        the report's thumbnail image data or null if the report has no thumbnail
        Since:
        11.0