com.serotonin.mango.view

Class View

java.lang.Object

com.serotonin.mango.view.View

All Implemented Interfaces:

com.serotonin.json.JsonSerializable, java.io.Serializable

public class View
extends java.lang.Object
implements java.io.Serializable, com.serotonin.json.JsonSerializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	anonymousAccess
private java.lang.String	backgroundFilename
private int	id
private java.lang.String	name
private static long	serialVersionUID
private int	userId
private static int	version
private java.util.List<ViewComponent>	viewComponents
private java.util.List<ShareUser>	viewUsers
private java.lang.String	xid
static java.lang.String	XID_PREFIX

Constructor Summary

Constructors

Constructor and Description
View()

Method Summary

Modifier and Type	Method and Description
void	addViewComponent(ViewComponent viewComponent)
boolean	containsValidVisibleDataPoint(int dataPointId)
DataPointVO	findDataPoint(java.lang.String viewComponentId)
int	getAnonymousAccess()
java.lang.String	getBackgroundFilename()
int	getId()
java.lang.String	getName()
int	getUserAccess(User user)
int	getUserId()
ViewComponent	getViewComponent(int index)
java.util.List<ViewComponent>	getViewComponents()
java.util.List<ShareUser>	getViewUsers()
java.lang.String	getXid()
boolean	isNew()
void	jsonDeserialize(com.serotonin.json.JsonReader reader, com.serotonin.json.JsonObject json)
void	jsonSerialize(java.util.Map<java.lang.String,java.lang.Object> map)
private void	readObject(java.io.ObjectInputStream in)
void	removeViewComponent(ViewComponent vc)
void	setAnonymousAccess(int anonymousAccess)
void	setBackgroundFilename(java.lang.String backgroundFilename)
void	setId(int id)
void	setName(java.lang.String name)
void	setUserId(int userId)
void	setViewUsers(java.util.List<ShareUser> viewUsers)
void	setXid(java.lang.String xid)
void	validate(com.serotonin.web.dwr.DwrResponseI18n response)
void	validateViewComponents(boolean makeReadOnly) This method is used before the view is displayed in order to validate: - that the given user is allowed to access points that back any components - that the points that back components still have valid data types for the components that render them
private void	writeObject(java.io.ObjectOutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

XID_PREFIX

public static final java.lang.String XID_PREFIX

See Also:

Constant Field Values

id

private int id

xid

private java.lang.String xid

name

private java.lang.String name

backgroundFilename

private java.lang.String backgroundFilename

userId

private int userId

viewComponents

private java.util.List<ViewComponent> viewComponents

anonymousAccess

private int anonymousAccess

viewUsers

private java.util.List<ShareUser> viewUsers

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

version

private static final int version

See Also:

Constant Field Values

Constructor Detail

View

public View()

Method Detail

addViewComponent

public void addViewComponent(ViewComponent viewComponent)

getViewComponent

public ViewComponent getViewComponent(int index)

removeViewComponent

public void removeViewComponent(ViewComponent vc)

isNew

public boolean isNew()

containsValidVisibleDataPoint

public boolean containsValidVisibleDataPoint(int dataPointId)

findDataPoint

public DataPointVO findDataPoint(java.lang.String viewComponentId)

getUserAccess

public int getUserAccess(User user)

validateViewComponents

public void validateViewComponents(boolean makeReadOnly)

This method is used before the view is displayed in order to validate: - that the given user is allowed to access points that back any components - that the points that back components still have valid data types for the components that render them

getBackgroundFilename

public java.lang.String getBackgroundFilename()

setBackgroundFilename

public void setBackgroundFilename(java.lang.String backgroundFilename)

getId

public int getId()

setId

public void setId(int id)

getXid

public java.lang.String getXid()

setXid

public void setXid(java.lang.String xid)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getViewComponents

public java.util.List<ViewComponent> getViewComponents()

getAnonymousAccess

public int getAnonymousAccess()

setAnonymousAccess

public void setAnonymousAccess(int anonymousAccess)

getUserId

public int getUserId()

setUserId

public void setUserId(int userId)

getViewUsers

public java.util.List<ShareUser> getViewUsers()

setViewUsers

public void setViewUsers(java.util.List<ShareUser> viewUsers)

validate

public void validate(com.serotonin.web.dwr.DwrResponseI18n response)

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Throws:

java.io.IOException

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

jsonDeserialize

public void jsonDeserialize(com.serotonin.json.JsonReader reader,
                            com.serotonin.json.JsonObject json)
                     throws com.serotonin.json.JsonException

Specified by:

jsonDeserialize in interface com.serotonin.json.JsonSerializable

Throws:

com.serotonin.json.JsonException

jsonSerialize

public void jsonSerialize(java.util.Map<java.lang.String,java.lang.Object> map)

Specified by:

jsonSerialize in interface com.serotonin.json.JsonSerializable