com.serotonin.mango.web.dwr

Class BaseDwr

java.lang.Object

com.serotonin.mango.web.dwr.BaseDwr

Direct Known Subclasses:

CompoundEventsDwr, CustomViewDwr, DataPointDetailsDwr, DataPointEditDwr, DataSourceListDwr, EmportDwr, EventHandlersDwr, EventsDwr, MailingListsDwr, MaintenanceEventsDwr, MiscDwr, PointLinksDwr, PublisherEditDwr, PublisherListDwr, ReportsDwr, ScheduledEventsDwr, ScriptsDwr, SystemSettingsDwr, UsersDwr, ViewDwr, WatchListDwr

public abstract class BaseDwr
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ResourceBundle	changeSnippetMap
protected java.util.ResourceBundle	chartSnippetMap
protected static EventDao	EVENT_DAO
static java.lang.String	MODEL_ATTR_EVENTS
static java.lang.String	MODEL_ATTR_HAS_UNACKED_EVENT
static java.lang.String	MODEL_ATTR_RESOURCE_BUNDLE

Constructor Summary

Constructors

Constructor and Description
BaseDwr()

Method Summary

Modifier and Type	Method and Description
UserComment	addUserComment(int typeId, int referenceId, java.lang.String comment) Logs a user comment after validation.
protected org.joda.time.DateTime	createDateTime(int year, int month, int day, int hour, int minute, int second, boolean none)
void	forcePointRead(int pointId)
static java.lang.String	generateContent(javax.servlet.http.HttpServletRequest request, java.lang.String snippet, java.util.Map<java.lang.String,java.lang.Object> model)
java.util.Map<java.lang.String,java.lang.Object>	getDateRangeDefaults(int periodType, int period)
protected java.lang.String	getMessage(com.serotonin.web.i18n.LocalizableMessage message)
protected java.lang.String	getMessage(java.lang.String key)
protected java.util.List<DataPointBean>	getReadablePoints()
protected java.util.ResourceBundle	getResourceBundle()
protected java.util.List<User>	getShareUsers(User excludeUser)
static void	initialize()
protected PointValueTime	prepareBasePointState(java.lang.String componentId, BasePointState state, DataPointVO pointVO, DataPointRT point, java.util.Map<java.lang.String,java.lang.Object> model) Base method for preparing information in a state object and returning a point value.
protected void	setChange(DataPointVO pointVO, BasePointState state, DataPointRT point, javax.servlet.http.HttpServletRequest request, java.util.Map<java.lang.String,java.lang.Object> model)
protected void	setChange(DataPointVO pointVO, BasePointState state, DataPointRT point, javax.servlet.http.HttpServletRequest request, java.util.Map<java.lang.String,java.lang.Object> model, User user)
protected void	setChart(DataPointVO point, BasePointState state, javax.servlet.http.HttpServletRequest request, java.util.Map<java.lang.String,java.lang.Object> model)
protected void	setEvents(DataPointVO pointVO, User user, java.util.Map<java.lang.String,java.lang.Object> model)
protected void	setMessages(BasePointState state, javax.servlet.http.HttpServletRequest request, java.lang.String snippet, java.util.Map<java.lang.String,java.lang.Object> model)
int	setPoint(int pointId, int componentId, java.lang.String valueStr) Allows the setting of a given data point.
protected void	setPointImpl(DataPointVO point, java.lang.String valueStr, SetPointSource source)
protected void	setPrettyText(WatchListState state, DataPointVO pointVO, java.util.Map<java.lang.String,java.lang.Object> model, PointValueTime pointValue)

Methods inherited from class java.lang.Object

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

Field Detail

MODEL_ATTR_EVENTS

public static final java.lang.String MODEL_ATTR_EVENTS

See Also:

Constant Field Values

MODEL_ATTR_HAS_UNACKED_EVENT

public static final java.lang.String MODEL_ATTR_HAS_UNACKED_EVENT

See Also:

Constant Field Values

MODEL_ATTR_RESOURCE_BUNDLE

public static final java.lang.String MODEL_ATTR_RESOURCE_BUNDLE

See Also:

Constant Field Values

EVENT_DAO

protected static EventDao EVENT_DAO

changeSnippetMap

protected java.util.ResourceBundle changeSnippetMap

chartSnippetMap

protected java.util.ResourceBundle chartSnippetMap

Constructor Detail

BaseDwr

public BaseDwr()

Method Detail

initialize

public static void initialize()

prepareBasePointState

protected PointValueTime prepareBasePointState(java.lang.String componentId,
                                               BasePointState state,
                                               DataPointVO pointVO,
                                               DataPointRT point,
                                               java.util.Map<java.lang.String,java.lang.Object> model)

Base method for preparing information in a state object and returning a point value.

Parameters:

componentId - a unique id for the browser side component. Required for set point snippets.

state -

point -

status -

model -

Returns:

setEvents

protected void setEvents(DataPointVO pointVO,
                         User user,
                         java.util.Map<java.lang.String,java.lang.Object> model)

setPrettyText

protected void setPrettyText(WatchListState state,
                             DataPointVO pointVO,
                             java.util.Map<java.lang.String,java.lang.Object> model,
                             PointValueTime pointValue)

setChange

protected void setChange(DataPointVO pointVO,
                         BasePointState state,
                         DataPointRT point,
                         javax.servlet.http.HttpServletRequest request,
                         java.util.Map<java.lang.String,java.lang.Object> model,
                         User user)

setChange

protected void setChange(DataPointVO pointVO,
                         BasePointState state,
                         DataPointRT point,
                         javax.servlet.http.HttpServletRequest request,
                         java.util.Map<java.lang.String,java.lang.Object> model)

setChart

protected void setChart(DataPointVO point,
                        BasePointState state,
                        javax.servlet.http.HttpServletRequest request,
                        java.util.Map<java.lang.String,java.lang.Object> model)

setMessages

protected void setMessages(BasePointState state,
                           javax.servlet.http.HttpServletRequest request,
                           java.lang.String snippet,
                           java.util.Map<java.lang.String,java.lang.Object> model)

setPoint

public int setPoint(int pointId,
                    int componentId,
                    java.lang.String valueStr)

Allows the setting of a given data point. Used by the watch list and point details pages. Views implement their own version to accommodate anonymous users.

Parameters:

pointId -

valueStr -

Returns:

setPointImpl

protected void setPointImpl(DataPointVO point,
                            java.lang.String valueStr,
                            SetPointSource source)

forcePointRead

public void forcePointRead(int pointId)

addUserComment

public UserComment addUserComment(int typeId,
                                  int referenceId,
                                  java.lang.String comment)

Logs a user comment after validation.

Parameters:

eventId -

comment -

Returns:

getReadablePoints

protected java.util.List<DataPointBean> getReadablePoints()

getDateRangeDefaults

public java.util.Map<java.lang.String,java.lang.Object> getDateRangeDefaults(int periodType,
                                                                             int period)

getMessage

protected java.lang.String getMessage(java.lang.String key)

getMessage

protected java.lang.String getMessage(com.serotonin.web.i18n.LocalizableMessage message)

getResourceBundle

protected java.util.ResourceBundle getResourceBundle()

generateContent

public static java.lang.String generateContent(javax.servlet.http.HttpServletRequest request,
                                               java.lang.String snippet,
                                               java.util.Map<java.lang.String,java.lang.Object> model)

getShareUsers

protected java.util.List<User> getShareUsers(User excludeUser)

createDateTime

protected org.joda.time.DateTime createDateTime(int year,
                                                int month,
                                                int day,
                                                int hour,
                                                int minute,
                                                int second,
                                                boolean none)