Package com.inductiveautomation.snap.websites

Class FileSite

java.lang.Object

com.inductiveautomation.rm.base.RMListenerList

com.inductiveautomation.rm.base.RMObject

com.inductiveautomation.snap.web.WebSite

com.inductiveautomation.snap.websites.FileSite

All Implemented Interfaces:

RMJSONArchiver.GetKeys, RMPropertyChanger, PropertyChangeListener, Cloneable, EventListener

Direct Known Subclasses:

EclipseSite, LocalSite, SandboxSite

public class FileSite
extends WebSite

A data source to read/write data and files to a file system.

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
FileSite()

Method Summary

Modifier and Type	Method	Description
protected void	deleteEntityImpl(Entity anEntity)	Delete entity file and entity table data file.
protected void	deleteFileImpl(WebFile aFile)	Deletes file.
protected void	deleteRowImpl(Row aRow)	Deletes a given row.
void	deleteSite()	Deletes this data source, assuming it corresponds to something that can be deleted, like a database.
protected void	flushImpl()	Override to Saves changes if any made.
protected Entity	getEntityImpl(String aName)	Get entity by loading from entity file.
protected List<Row>	getEntityRows(Entity anEntity)	Returns the list of rows for a given entity.
protected byte[]	getFileBytesImpl(WebFile aFile)	Gets file bytes.
protected WebFile	getFileImpl(String aPath)	Returns a file at
protected List<WebFile>	getFilesImpl(WebFile aFile)	Returns files at path.
long	getModifiedTime(WebFile aFile)	Override to get modified time from Java file.
protected List<Row>	getRowsImpl(Entity anEntity, Query aQuery)	Returns a set of rows for the given properties and condition.
protected File	getStandardFile(WebFile aFile)	Returns the Java file for a WebFile.
protected File	getStandardFile(String aPath)	Returns the Java file for RMFile.
protected WebFile	getTableDataFile(String aName, boolean doCreate)	Returns the file for the given entity.
protected WebFile	getTableEntityFile(String aName, boolean doCreate)	Returns the file for the given entity.
protected void	saveEntityFile(Entity anEntity)	Save entity files for changed entities.
protected void	saveEntityFiles()	Save entity files for changed entities.
protected void	saveEntityImpl(Entity anEntity)	Save entity by saving entity bytes to entity file.
protected void	saveFileImpl(WebFile aFile)	Writes file bytes.
protected void	saveRowImpl(Row aRow)	Inserts or updates a given row.
protected void	setModifiedTimeImpl(WebFile aFile, long aTime)	Saves the modified time for a file to underlying file system.

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

addDeepChangeListener, bulkImport, createClassLoader, createDataTable, createDataTableImpl, createEntity, createEntityImpl, createFile, createFileImpl, createRow, createRow, createRowImpl, createSandbox, createSandboxURL, createSandboxURLS, createSchema, createSite, createURL, deleteEntity, deleteFile, deleteRow, flush, getClassLoader, getDataTable, getDataTables, getEntity, getExists, getFile, getHostName, getJSONKeys, getName, getPassword, getPath, getProp, getRequest, getResponse, getRootDirectory, getRow, getRow, getRowImpl, getRows, getSandbox, getSchema, getServlet, getURL, getURL, getURLString, getUserName, handleDelete, handleGet, handleHead, handlePut, isRunning, propertyChange, refresh, refreshFile, refreshFileImpl, removeDeepChangeListener, saveEntity, saveFile, saveRow, setClassLoader, setExists, setModifiedTime, 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

FileSite

public FileSite()

Method Details

getFileImpl

protected WebFile getFileImpl(String aPath)

Returns a file at

Overrides:

getFileImpl in class WebSite

getFilesImpl

protected List<WebFile> getFilesImpl(WebFile aFile)
                              throws Exception

Returns files at path.

Overrides:

getFilesImpl in class WebSite

Throws:

Exception

getFileBytesImpl

protected byte[] getFileBytesImpl(WebFile aFile)
                           throws Exception

Gets file bytes.

Overrides:

getFileBytesImpl in class WebSite

Throws:

Exception

saveFileImpl

protected void saveFileImpl(WebFile aFile)
                     throws Exception

Writes file bytes.

Overrides:

saveFileImpl in class WebSite

Throws:

Exception

deleteFileImpl

protected void deleteFileImpl(WebFile aFile)
                       throws Exception

Deletes file.

Overrides:

deleteFileImpl in class WebSite

Throws:

Exception

getModifiedTime

public long getModifiedTime(WebFile aFile)

Override to get modified time from Java file.

Overrides:

getModifiedTime in class WebSite

setModifiedTimeImpl

protected void setModifiedTimeImpl(WebFile aFile,
 long aTime)
                            throws Exception

Saves the modified time for a file to underlying file system.

Overrides:

setModifiedTimeImpl in class WebSite

Throws:

Exception

getEntityImpl

protected Entity getEntityImpl(String aName)
                        throws Exception

Get entity by loading from entity file.

Overrides:

getEntityImpl in class WebSite

Throws:

Exception

saveEntityImpl

protected void saveEntityImpl(Entity anEntity)
                       throws Exception

Save entity by saving entity bytes to entity file.

Overrides:

saveEntityImpl in class WebSite

Throws:

Exception

deleteEntityImpl

protected void deleteEntityImpl(Entity anEntity)
                         throws Exception

Delete entity file and entity table data file.

Overrides:

deleteEntityImpl in class WebSite

Throws:

Exception

getRowsImpl

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)

Inserts or updates a given row.

Specified by:

saveRowImpl in class WebSite

deleteRowImpl

protected void deleteRowImpl(Row aRow)

Deletes a given row.

Specified by:

deleteRowImpl in class WebSite

saveEntityFiles

protected void saveEntityFiles()
                        throws Exception

Save entity files for changed entities.

Throws:

Exception

saveEntityFile

protected void saveEntityFile(Entity anEntity)
                       throws Exception

Save entity files for changed entities.

Throws:

Exception

flushImpl

protected void flushImpl()
                  throws Exception

Override to Saves changes if any made.

Overrides:

flushImpl in class WebSite

Throws:

Exception

getTableEntityFile

protected WebFile getTableEntityFile(String aName,
 boolean doCreate)

Returns the file for the given entity.

getTableDataFile

protected WebFile getTableDataFile(String aName,
 boolean doCreate)

Returns the file for the given entity.

getEntityRows

protected List<Row> getEntityRows(Entity anEntity)

Returns the list of rows for a given entity.

deleteSite

public void deleteSite()
                throws Exception

Deletes this data source, assuming it corresponds to something that can be deleted, like a database.

Overrides:

deleteSite in class WebSite

Throws:

Exception

getStandardFile

protected File getStandardFile(WebFile aFile)

Returns the Java file for a WebFile.

Overrides:

getStandardFile in class WebSite

getStandardFile

protected File getStandardFile(String aPath)

Returns the Java file for RMFile.