ReportData

java.lang.Object

com.inductiveautomation.snap.filedata.SnapData

com.inductiveautomation.snap.filedata.ReportData

Direct Known Subclasses:: PDFData, SwingData

public class ReportData extends SnapData

A file for Snap reports.

Constructor Summary

Constructors

Constructor

Description

ReportData()
Method Summary

Modifier and Type

Method

Description

RMParentShape

createRootShape()

Creates the root shape from ReportFile.

WebFile

generateReport(Object aDataSet)

Generate report file.

static ReportData

get(WebFile aFile)

Returns the ReportData for given file.

RMDocument

getDocument()

Returns the root shape as a document (if it is one).

RMParentShape

getRootShape()

Returns the root shape of the file.

static boolean

is(WebFile aFile)

Returns whether file contains ReportData.

boolean

isGenerated()

Returns whether report file document has already generated report.

void

setBytes(byte[] theBytes)

Override to clear document.

void

setGenerated(boolean aValue)

Sets whether report file document has already generated report.

void

setRootShape(RMParentShape aShape)

Sets the root shape of the file.

Methods inherited from class com.inductiveautomation.snap.filedata.SnapData
createBytes, createSourceURL, delete, get, getBytes, getInputStream, getSite, getSource, getSourceFile, getSourceURL, is, refresh, save, setSource

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ReportData
  
  public ReportData()
Method Details
- getRootShape
  
  public RMParentShape getRootShape()
  
  Returns the root shape of the file.
- setRootShape
  
  public void setRootShape(RMParentShape aShape)
  
  Sets the root shape of the file.
- createRootShape
  
  public RMParentShape createRootShape()
  
  Creates the root shape from ReportFile.
- getDocument
  
  public RMDocument getDocument()
  
  Returns the root shape as a document (if it is one).
- setBytes
  
  public void setBytes(byte[] theBytes)
  
  Override to clear document.
  
  Overrides:
  
  setBytes in class SnapData
- isGenerated
  
  public boolean isGenerated()
  
  Returns whether report file document has already generated report.
- setGenerated
  
  public void setGenerated(boolean aValue)
  
  Sets whether report file document has already generated report.
- generateReport
  
  public WebFile generateReport(Object aDataSet)
  
  Generate report file.
- is
  
  public static boolean is(WebFile aFile)
  
  Returns whether file contains ReportData.
- get
  
  public static ReportData get(WebFile aFile)
  
  Returns the ReportData for given file.