SnapTableView (ignition 7.9.0-beta1 API)

java.lang.Object
- com.inductiveautomation.snap.web.DataTableView
- - com.inductiveautomation.snap.filedata.SnapTableView

All Implemented Interfaces:

RMJSONArchiver.GetKeys, java.beans.PropertyChangeListener, java.util.EventListener
```
public class SnapTableView
extends DataTableView
implements RMJSONArchiver.GetKeys, java.beans.PropertyChangeListener
```
A class to represent a dataset generated from a table, a query and query parameters.

Constructor Summary

Constructors
Constructor and Description

SnapTableView()

Constructors
Constructor and Description
`SnapTableView()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addParameter(Property aParameter)` Adds a parameter.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener aLstnr)` Add a property change listener.
`protected void`	`addRow(Row aRow)` Override to clear filtered rows.
`protected Query`	`createQuery()` Creates the default query, substituting parameter values if it contains parameter keys.
`protected Entity`	`createQueryEntity()` Returns the query parameters entity.
`SnapRow`	`createRow()` Creates a new row.
`protected Entity`	`createViewEntity()` Returns the view entity - a modified version of the underlying table entity to include query relation + properties.
`protected void`	`firePropertyChange(java.beans.PropertyChangeEvent anEvent)` Fires a property change.
`protected void`	`firePropertyChange(java.lang.String aPropName, java.lang.Object anOldVal, java.lang.Object aNewVal, int anIndex)` Fires a property change.
`java.lang.String`	`getFilter()` Returns the filter string.
`java.util.List<Row>`	`getFilteredRows()` Returns the list of filtered rows.
`java.util.List<java.lang.String>`	`getJSONKeys()` RMJSONArchiver.GetKeys method.
`Property`	`getParameter(int anIndex)` Return the individual parameter.
`Property`	`getParameter(java.lang.String aName)` Returns the named parameter.
`int`	`getParameterCount()` Return the number of parameters.
`java.util.List<Property>`	`getParameters()` Returns the list of parameters.
`java.lang.Object`	`getParameterValue(java.lang.String aName)` Returns the current parameter value for given parameter name.
`Entity`	`getQueryEntity()` Returns the query entity.
`Query`	`getQueryTemplate()` Returns the query used to build actual query (may contain parameter names instead of values).
`Entity`	`getViewEntity()` Returns the view entity.
`void`	`propertyChange(java.beans.PropertyChangeEvent anEvent)` Catches changes to condition and properties and forwards on.
`void`	`refresh()` Reloads rows.
`Property`	`removeParameter(int anIndex)` Removes a parameter at given index.
`int`	`removeParameter(Property aParameter)` Removes a given parameter from parameters list.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener aLstnr)` Remove a property change listener.
`protected void`	`removeRow(Row aRow)` Override to clear filtered rows.
`void`	`setFilter(java.lang.String aString)` Sets the filter string.
`void`	`setParameters(java.util.List<Property> theParameters)` Sets a list of parameters.
`void`	`setParameterValue(java.lang.String aName, java.lang.Object aValue)` Sets the current parameter value for given parameter name.
`void`	`setQueryTemplate(Query aQuery)` Sets the query used to build actual query (may contain parameter names instead of values).
`java.lang.String`	`toString()` Standard toString implementation.

Methods inherited from class com.inductiveautomation.snap.web.DataTableView
getName, getQuery, getRows, getRowsImpl, getSite, getTable, getTableEntity, isRowsSet, setName, setQuery, setTable

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

- Constructor Detail
  - SnapTableView
```
public SnapTableView()
```
- Method Detail
  - getQueryTemplate
```
public Query getQueryTemplate()
```
    Returns the query used to build actual query (may contain parameter names instead of values).
  - setQueryTemplate
```
public void setQueryTemplate(Query aQuery)
```
    Sets the query used to build actual query (may contain parameter names instead of values).
  - createQuery
```
protected Query createQuery()
```
    Creates the default query, substituting parameter values if it contains parameter keys.
    
    Overrides:
    
    createQuery in class DataTableView
  - getParameterCount
```
public int getParameterCount()
```
    Return the number of parameters.
  - getParameter
```
public Property getParameter(int anIndex)
```
    Return the individual parameter.
  - getParameters
```
public java.util.List<Property> getParameters()
```
    Returns the list of parameters.
  - setParameters
```
public void setParameters(java.util.List<Property> theParameters)
```
    Sets a list of parameters.
  - addParameter
```
public void addParameter(Property aParameter)
```
    Adds a parameter.
  - removeParameter
```
public Property removeParameter(int anIndex)
```
    Removes a parameter at given index.
  - removeParameter
```
public int removeParameter(Property aParameter)
```
    Removes a given parameter from parameters list.
  - getParameter
```
public Property getParameter(java.lang.String aName)
```
    Returns the named parameter.
  - getParameterValue
```
public java.lang.Object getParameterValue(java.lang.String aName)
```
    Returns the current parameter value for given parameter name.
  - setParameterValue
```
public void setParameterValue(java.lang.String aName,
                              java.lang.Object aValue)
```
    Sets the current parameter value for given parameter name.
  - getViewEntity
```
public Entity getViewEntity()
```
    Returns the view entity.
  - createViewEntity
```
protected Entity createViewEntity()
```
    Returns the view entity - a modified version of the underlying table entity to include query relation + properties.
  - getQueryEntity
```
public Entity getQueryEntity()
```
    Returns the query entity.
  - createQueryEntity
```
protected Entity createQueryEntity()
```
    Returns the query parameters entity.
  - createRow
```
public SnapRow createRow()
```
    Creates a new row.
  - addRow
```
protected void addRow(Row aRow)
```
    Override to clear filtered rows.
    
    Overrides:
    
    addRow in class DataTableView
  - removeRow
```
protected void removeRow(Row aRow)
```
    Override to clear filtered rows.
    
    Overrides:
    
    removeRow in class DataTableView
  - getFilter
```
public java.lang.String getFilter()
```
    Returns the filter string.
  - setFilter
```
public void setFilter(java.lang.String aString)
```
    Sets the filter string.
  - getFilteredRows
```
public java.util.List<Row> getFilteredRows()
```
    Returns the list of filtered rows.
  - refresh
```
public void refresh()
```
    Reloads rows.
    
    Overrides:
    
    refresh in class DataTableView
  - propertyChange
```
public void propertyChange(java.beans.PropertyChangeEvent anEvent)
```
    Catches changes to condition and properties and forwards on.
    
    Specified by:
    
    propertyChange in interface java.beans.PropertyChangeListener
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener aLstnr)
```
    Add a property change listener.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener aLstnr)
```
    Remove a property change listener.
  - firePropertyChange
```
protected void firePropertyChange(java.lang.String aPropName,
                                  java.lang.Object anOldVal,
                                  java.lang.Object aNewVal,
                                  int anIndex)
```
    Fires a property change.
  - firePropertyChange
```
protected void firePropertyChange(java.beans.PropertyChangeEvent anEvent)
```
    Fires a property change.
  - getJSONKeys
```
public java.util.List<java.lang.String> getJSONKeys()
```
    RMJSONArchiver.GetKeys method.
    
    Specified by:
    
    getJSONKeys in interface RMJSONArchiver.GetKeys
  - toString
```
public java.lang.String toString()
```
    Standard toString implementation.
    
    Overrides:
    
    toString in class java.lang.Object

Class SnapTableView

Constructor Summary

Method Summary

Methods inherited from class com.inductiveautomation.snap.web.DataTableView

Methods inherited from class java.lang.Object

Constructor Detail

SnapTableView

Method Detail

getQueryTemplate

setQueryTemplate

createQuery

getParameterCount

getParameter

getParameters

setParameters

addParameter

removeParameter

removeParameter

getParameter

getParameterValue

setParameterValue

getViewEntity

createViewEntity

getQueryEntity

createQueryEntity

createRow

addRow

removeRow

getFilter

setFilter

getFilteredRows

refresh

propertyChange

addPropertyChangeListener

removePropertyChangeListener

firePropertyChange

firePropertyChange

getJSONKeys

toString