Package com.inet.report
Class SummaryInfo
java.lang.Object
com.inet.report.SummaryInfo
- All Implemented Interfaces:
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());
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:
-
Method Summary
Modifier and TypeMethodDescriptionReturns the author of the report if the value was specified in the "Summary Info" or with the method setAuthor(String).Returns the comments of the report if the value was specified in the "Summary Info" or with the method setComments(String).Returns the date and time the report was created.Returns the keywords of the report if the value was specified in the "Summary Info" or with the method setKeywords(String).Returns the date and time set as the last time the report was saved.Returns the report title if the value was specified in the "Summary Info" or with the method setReportTitle(String).Returns the subject of the report if the value was specified in the "Summary Info" or with the method setSubject(String).Returns the template value of the report if the value was specified in the "Summary Info" or with the method setTemplate(String).FOR INTERNAL USE ONLY Gets the report's "thumbnail" image if there is one.byte[]
FOR INTERNAL USE ONLY Gets the report's "thumbnail" image if there is one.void
Sets the author of the report.void
setComments
(String comments) Sets the comments of the report.void
setCreated
(Date createTime) Sets the date and time the report was created.void
setKeywords
(String keywords) Sets the keywords of the report as a single string.void
setLastSaved
(Date lastSave) Sets the date and time the report was last saved.void
setReportTitle
(String title) Sets the report title.void
setSubject
(String subject) Sets the subject of the report, that is, the general theme.void
setTemplate
(String template) Sets the template field of the report.void
setThumbnail
(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.
-
Method Details
-
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
Sets the author of the report.- Parameters:
author
- Author of the report- Since:
- 6.0
- See Also:
-
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
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:
-
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
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:
-
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
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:
-
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
Sets the subject of the report, that is, the general theme.- Parameters:
subject
- Subject to set for the report- Since:
- 6.0
- See Also:
-
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
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:
-
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
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:
-
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
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:
-
setThumbnail
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
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
-