Package com.inductiveautomation.snap.filedata

Class SnapSite

java.lang.Object

com.inductiveautomation.rm.base.RMListenerList

com.inductiveautomation.rm.base.RMObject

com.inductiveautomation.snap.web.WebSite

com.inductiveautomation.snap.filedata.SnapSite

All Implemented Interfaces:

RMJSONArchiver.GetKeys, RMPropertyChanger, PropertyChangeListener, Cloneable, EventListener

public class SnapSite
extends WebSite

A class to manage resources for a Snap site (a data source subclass).

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.snap.web.WebSite

WebSite.Servlet

Field Summary

Fields inherited from class com.inductiveautomation.snap.web.WebSite

Refresh_Prop

Constructor Summary

Constructors

Constructor	Description
SnapSite()

Method Summary

Modifier and Type	Method	Description
protected void	addAutosaveRow(Row aRow)	Adds a Row to AutosaveRows set.
protected SnapTable	createDataTableImpl()	Override to return SnapTable.
protected WebFile	createFileImpl(String aPath, boolean isDirectory)	Nobody should be asking for files from this site.
protected Row	createRowImpl(Entity anEntity, Object aPrimaryValue)	Creates a new row for source.
protected void	deleteEntityImpl(Entity anEntity)	Override to delete entity from encapsulated source.
protected void	deleteFileImpl(WebFile aFile)	Deletes a file.
protected void	deleteRowImpl(Row aRow)	Deletes a given row.
protected void	flushImpl()	Override to save SettingsFile and AutosaveRows.
static SnapSite	get(WebSite aSite)	Returns the SnapSite for a given site.
SnapTable	getDataTable(String aName)	Override to return as SnapTable.
protected Entity	getEntityImpl(String aName)	Returns the entity for given name.
protected byte[]	getFileBytesImpl(WebFile aFile)	Returns file bytes.
protected WebFile	getFileImpl(String aPath)	Returns a data source file for given path (if file exists).
protected List<WebFile>	getFilesImpl(WebFile aFile)	Returns a list of files at path.
protected Row	getRowImpl(Entity anEntity, Object aPrimaryValue)	Returns a row for a given entity and primary value.
protected List<Row>	getRowsImpl(Entity anEntity, Query aQuery)	Returns a set of rows for the given properties and condition.
WebSite	getSite()	Returns the encapsulated WebSite.
SnapTableView	getTableView(String aName)	Returns a table view for given name.
WebURL	getURL()	Returns the URL.
void	propertyChange(PropertyChangeEvent anEvent)	Override to track changed rows.
void	refresh()	Override to forward to real data source.
protected void	refreshFileImpl(WebFile aFile)	Reverts a file.
protected void	saveEntityImpl(Entity anEntity)	Override to save entity to encapsulated source.
protected void	saveFileImpl(WebFile aFile)	Saves a file.
protected void	saveRowImpl(Row aRow)	Inserts or updates a given row.
protected void	setSite(WebSite aSite)	Sets the encapsulated WebSite.

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

addDeepChangeListener, bulkImport, createClassLoader, createDataTable, createEntity, createEntityImpl, createFile, createRow, createRow, createSandbox, createSandboxURL, createSandboxURLS, createSchema, createSite, createURL, deleteEntity, deleteFile, deleteRow, deleteSite, flush, getClassLoader, getDataTables, getEntity, getExists, getFile, getHostName, getJSONKeys, getModifiedTime, getName, getPassword, getPath, getProp, getRequest, getResponse, getRootDirectory, getRow, getRow, getRows, getSandbox, getSchema, getServlet, getStandardFile, getURL, getURLString, getUserName, handleDelete, handleGet, handleHead, handlePut, isRunning, refreshFile, removeDeepChangeListener, saveEntity, saveFile, saveRow, setClassLoader, setExists, setModifiedTime, setModifiedTimeImpl, setPassword, setProp, setSandbox, setServlet, setURL, setUserName, toString

Methods inherited from class com.inductiveautomation.rm.base.RMObject

addPropertyChangeListener, animUpdate, firePropertyChange, firePropertyChange, firePropertyChange, getPCEvent, removePropertyChangeListener, sendPropertyChange

Methods inherited from class com.inductiveautomation.rm.base.RMListenerList

addListener, clone, getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

Methods inherited from class java.lang.Object

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

Constructor Details

SnapSite

public SnapSite()

Method Details

getSite

public WebSite getSite()

Returns the encapsulated WebSite.

setSite

protected void setSite(WebSite aSite)

Sets the encapsulated WebSite.

getURL

public WebURL getURL()

Returns the URL.

Overrides:

getURL in class WebSite

createFileImpl

protected WebFile createFileImpl(String aPath,
 boolean isDirectory)

Nobody should be asking for files from this site.

Overrides:

createFileImpl in class WebSite

getFileImpl

protected WebFile getFileImpl(String aPath)

Description copied from class: WebSite

Returns a data source file for given path (if file exists).

Overrides:

getFileImpl in class WebSite

getFilesImpl

protected List<WebFile> getFilesImpl(WebFile aFile)

Description copied from class: WebSite

Returns a list of files at path.

Overrides:

getFilesImpl in class WebSite

getFileBytesImpl

protected byte[] getFileBytesImpl(WebFile aFile)

Description copied from class: WebSite

Returns file bytes.

Overrides:

getFileBytesImpl in class WebSite

saveFileImpl

protected void saveFileImpl(WebFile aFile)
                     throws Exception

Description copied from class: WebSite

Saves a file.

Overrides:

saveFileImpl in class WebSite

Throws:

Exception

deleteFileImpl

protected void deleteFileImpl(WebFile aFile)
                       throws Exception

Description copied from class: WebSite

Deletes a file.

Overrides:

deleteFileImpl in class WebSite

Throws:

Exception

refreshFileImpl

protected void refreshFileImpl(WebFile aFile)
                        throws Exception

Description copied from class: WebSite

Reverts a file.

Overrides:

refreshFileImpl in class WebSite

Throws:

Exception

getDataTable

public SnapTable getDataTable(String aName)

Override to return as SnapTable.

Overrides:

getDataTable in class WebSite

createDataTableImpl

protected SnapTable createDataTableImpl()

Override to return SnapTable.

Overrides:

createDataTableImpl in class WebSite

getTableView

public SnapTableView getTableView(String aName)

Returns a table view for given name.

getEntityImpl

protected Entity getEntityImpl(String aName)
                        throws Exception

Returns the entity for given name.

Overrides:

getEntityImpl in class WebSite

Throws:

Exception

saveEntityImpl

protected void saveEntityImpl(Entity anEntity)
                       throws Exception

Override to save entity to encapsulated source.

Overrides:

saveEntityImpl in class WebSite

Throws:

Exception

deleteEntityImpl

protected void deleteEntityImpl(@Nullable
 Entity anEntity)
                         throws Exception

Override to delete entity from encapsulated source.

Overrides:

deleteEntityImpl in class WebSite

Throws:

Exception

createRowImpl

@Nonnull
protected Row createRowImpl(Entity anEntity,
 Object aPrimaryValue)

Creates a new row for source.

Overrides:

createRowImpl in class WebSite

getRowImpl

@Nullable
protected Row getRowImpl(@Nonnull
 Entity anEntity,
 Object aPrimaryValue)

Returns a row for a given entity and primary value.

Overrides:

getRowImpl in class WebSite

getRowsImpl

@Nonnull
protected List<Row> getRowsImpl(Entity anEntity,
 Query aQuery)

Returns a set of rows for the given properties and condition.

Specified by:

getRowsImpl in class WebSite

saveRowImpl

protected void saveRowImpl(Row aRow)
                    throws Exception

Inserts or updates a given row.

Specified by:

saveRowImpl in class WebSite

Throws:

Exception

deleteRowImpl

protected void deleteRowImpl(Row aRow)
                      throws Exception

Deletes a given row.

Specified by:

deleteRowImpl in class WebSite

Throws:

Exception

propertyChange

public void propertyChange(PropertyChangeEvent anEvent)

Override to track changed rows.

Specified by:

propertyChange in interface PropertyChangeListener

Overrides:

propertyChange in class WebSite

addAutosaveRow

protected void addAutosaveRow(Row aRow)

Adds a Row to AutosaveRows set.

refresh

public void refresh()

Override to forward to real data source.

Overrides:

refresh in class WebSite

flushImpl

protected void flushImpl()
                  throws Exception

Override to save SettingsFile and AutosaveRows.

Overrides:

flushImpl in class WebSite

Throws:

Exception

get

public static SnapSite get(WebSite aSite)

Returns the SnapSite for a given site.