Class SampleData
- java.lang.Object
-
- com.inductiveautomation.ignition.common.util.AbstractChangeable
-
- com.inductiveautomation.reporting.designer.workspace.design.SampleData
-
- All Implemented Interfaces:
Changeable
public class SampleData extends AbstractChangeable
This class holds the logic need to determine if sample data needs to be loaded or re-loaded based upon changes to the data configuration. It is shared by the design and preview panels, so that sample data is loaded as infrequently as possible.It is used by calling update() when a panel is displayed, and then responding to the state of the sample data by listening for changes.
Created by carl.gould on 3/31/2015.
-
-
Field Summary
-
Fields inherited from class com.inductiveautomation.ignition.common.util.AbstractChangeable
changeEvent, listenerList
-
-
Constructor Summary
Constructors Constructor Description SampleData(ReportingResourceWorkspace workspace, ResourcePath resourceId, ReportResource report)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
forceUpdate()
Used by the ReportingResourceEditor to force updating when the report path changes.java.util.List<java.lang.String>
getErrors()
Returns a list of any errors incurred during the collection of Data for a report.SampleDataSchema
getLoadedSampleData()
boolean
isLoading()
void
update()
Checks to see whether or not the sample data which was previously loaded (if any) is up-to-date.-
Methods inherited from class com.inductiveautomation.ignition.common.util.AbstractChangeable
addChangeListener, fireStateChanged, getChangeListeners, removeChangeListener
-
-
-
-
Constructor Detail
-
SampleData
public SampleData(ReportingResourceWorkspace workspace, ResourcePath resourceId, ReportResource report)
-
-
Method Detail
-
getErrors
public java.util.List<java.lang.String> getErrors()
Returns a list of any errors incurred during the collection of Data for a report. Returns an empty List if no errors are found.- Returns:
- list containing errors, empty List (non-null) if errorless.
-
isLoading
public boolean isLoading()
-
getLoadedSampleData
public SampleDataSchema getLoadedSampleData()
-
update
public void update()
Checks to see whether or not the sample data which was previously loaded (if any) is up-to-date. Eventually will fire a state change - either immediately if the already loaded data is still good, or later if the data needs to be fetched.
-
forceUpdate
public void forceUpdate()
Used by the ReportingResourceEditor to force updating when the report path changes.
-
-