org.netxms.client.datacollection

Class GraphSettings

java.lang.Object

org.netxms.client.datacollection.ChartConfig

org.netxms.client.datacollection.GraphSettings

All Implemented Interfaces:

MenuFiltringObj

public class GraphSettings
extends ChartConfig
implements MenuFiltringObj

Settings for predefined graph

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCESS_READ
static int	ACCESS_WRITE
static int	GF_AUTO_SCALE
static int	GF_AUTO_UPDATE
static int	GF_ENABLE_ZOOM
static int	GF_LOG_SCALE
static int	GF_SHOW_GRID
static int	GF_SHOW_HOST_NAMES
static int	GF_SHOW_LEGEND
static int	GF_SHOW_RULER
static int	GF_SHOW_TOOLTIPS
static int	GRAPH_FLAG_TEMPLATE
static int	MAX_GRAPH_ITEM_COUNT
static int	POSITION_BOTTOM
static int	POSITION_LEFT
static int	POSITION_RIGHT
static int	POSITION_TOP
static int	TIME_FRAME_BACK_FROM_NOW
static int	TIME_FRAME_CURRENT
static int	TIME_FRAME_FIXED
static int	TIME_UNIT_DAY
static int	TIME_UNIT_HOUR
static int	TIME_UNIT_MINUTE

Fields inherited from class org.netxms.client.datacollection.ChartConfig

area, autoRefresh, autoScale, dciList, extendedLegend, legendPosition, lineWidth, logScale, maxYScaleValue, minYScaleValue, refreshRate, showGrid, showHostNames, showLegend, showTitle, stacked, timeFrameType, timeFrom, timeRange, timeTo, timeUnits, title, translucent

Constructor Summary

Constructors

Constructor and Description
GraphSettings() Create default settings
GraphSettings(GraphSettings data, String name)
GraphSettings(long id, long ownerId, int flags, Collection<AccessListElement> accessList) Create settings

Method Summary

Modifier and Type	Method and Description
static GraphSettings	createFromXml(String xml) Create chart settings object from XML document
static GraphSettings	createGraphSettings(org.netxms.base.NXCPMessage msg, long baseId) Create graph settings object from NXCP message
void	fillMessage(org.netxms.base.NXCPMessage msg)
List<AccessListElement>	getAccessList()
ObjectMenuFilter	getFilter() Returns filter
ObjectMenuFilter	getFilters()
String	getFiltersAsXML()
int	getFlags()
long	getId()
String	getName()
long	getOwnerId()
String	getShortName()
int	getType() Returns type of of object(for Object tools it is required for determining local commands)
boolean	isApplicableForNode(AbstractNode node) Checks if this graph template is applicable for node
boolean	isTemplate() Checks if this graph is template
void	setFilter(ObjectMenuFilter filter) Sets filter
void	setFilters(ObjectMenuFilter filters)
void	setFlags(int flags)
void	setName(String name)

Methods inherited from class org.netxms.client.datacollection.ChartConfig

addChangeListener, createXml, fireChangeNotification, getDciList, getLegendPosition, getLineWidth, getMaxYScaleValue, getMinYScaleValue, getRefreshRate, getTimeFrameType, getTimeFrom, getTimeRange, getTimeRangeMillis, getTimeTo, getTimeUnits, getTitle, isArea, isAutoRefresh, isAutoScale, isExtendedLegend, isLogScale, isShowGrid, isShowHostNames, isShowLegend, isShowTitle, isStacked, isTranslucent, removeChangeListener, setArea, setAutoRefresh, setAutoScale, setConfig, setDciList, setExtendedLegend, setLegendPosition, setLineWidth, setLogScale, setMaxYScaleValue, setMinYScaleValue, setRefreshRate, setShowGrid, setShowHostNames, setShowLegend, setShowTitle, setStacked, setTimeFrameType, setTimeFrom, setTimePeriod, setTimeRange, setTimeTo, setTimeUnits, setTitle, setTranslucent, timePeriod

Methods inherited from class java.lang.Object

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

Field Detail

MAX_GRAPH_ITEM_COUNT

public static final int MAX_GRAPH_ITEM_COUNT

See Also:

Constant Field Values

TIME_FRAME_FIXED

public static final int TIME_FRAME_FIXED

See Also:

Constant Field Values

TIME_FRAME_BACK_FROM_NOW

public static final int TIME_FRAME_BACK_FROM_NOW

See Also:

Constant Field Values

TIME_FRAME_CURRENT

public static final int TIME_FRAME_CURRENT

See Also:

Constant Field Values

TIME_UNIT_MINUTE

public static final int TIME_UNIT_MINUTE

See Also:

Constant Field Values

TIME_UNIT_HOUR

public static final int TIME_UNIT_HOUR

See Also:

Constant Field Values

TIME_UNIT_DAY

public static final int TIME_UNIT_DAY

See Also:

Constant Field Values

GF_AUTO_UPDATE

public static final int GF_AUTO_UPDATE

See Also:

Constant Field Values

GF_AUTO_SCALE

public static final int GF_AUTO_SCALE

See Also:

Constant Field Values

GF_SHOW_GRID

public static final int GF_SHOW_GRID

See Also:

Constant Field Values

GF_SHOW_LEGEND

public static final int GF_SHOW_LEGEND

See Also:

Constant Field Values

GF_SHOW_RULER

public static final int GF_SHOW_RULER

See Also:

Constant Field Values

GF_SHOW_HOST_NAMES

public static final int GF_SHOW_HOST_NAMES

See Also:

Constant Field Values

GF_LOG_SCALE

public static final int GF_LOG_SCALE

See Also:

Constant Field Values

GF_SHOW_TOOLTIPS

public static final int GF_SHOW_TOOLTIPS

See Also:

Constant Field Values

GF_ENABLE_ZOOM

public static final int GF_ENABLE_ZOOM

See Also:

Constant Field Values

POSITION_LEFT

public static final int POSITION_LEFT

See Also:

Constant Field Values

POSITION_RIGHT

public static final int POSITION_RIGHT

See Also:

Constant Field Values

POSITION_TOP

public static final int POSITION_TOP

See Also:

Constant Field Values

POSITION_BOTTOM

public static final int POSITION_BOTTOM

See Also:

Constant Field Values

ACCESS_READ

public static final int ACCESS_READ

See Also:

Constant Field Values

ACCESS_WRITE

public static final int ACCESS_WRITE

See Also:

Constant Field Values

GRAPH_FLAG_TEMPLATE

public static final int GRAPH_FLAG_TEMPLATE

See Also:

Constant Field Values

Constructor Detail

GraphSettings

public GraphSettings()

Create default settings

GraphSettings

public GraphSettings(long id,
                     long ownerId,
                     int flags,
                     Collection<AccessListElement> accessList)

Create settings

GraphSettings

public GraphSettings(GraphSettings data,
                     String name)

Method Detail

createFromXml

public static GraphSettings createFromXml(String xml)
                                   throws Exception

Create chart settings object from XML document

Parameters:

xml - XML document

Returns:

deserialized object

Throws:

Exception - if the object cannot be fully deserialized

createGraphSettings

public static GraphSettings createGraphSettings(org.netxms.base.NXCPMessage msg,
                                                long baseId)

Create graph settings object from NXCP message

Parameters:

msg - NXCP message

baseId - base variable id

fillMessage

public void fillMessage(org.netxms.base.NXCPMessage msg)

getId

public long getId()

Returns:

the id

getOwnerId

public long getOwnerId()

Returns:

the ownerId

getName

public String getName()

Returns:

the name

getAccessList

public List<AccessListElement> getAccessList()

Returns:

the accessList

getShortName

public String getShortName()

Returns:

the shortName

setName

public void setName(String name)

Parameters:

name - the name to set

getFlags

public int getFlags()

Returns:

the flags

setFlags

public void setFlags(int flags)

Parameters:

flags - the flags to set

getFilters

public ObjectMenuFilter getFilters()

Returns:

the filters

getFiltersAsXML

public String getFiltersAsXML()

Returns:

the filters as string

setFilters

public void setFilters(ObjectMenuFilter filters)

Parameters:

filters - the filters to set

isApplicableForNode

public boolean isApplicableForNode(AbstractNode node)

Checks if this graph template is applicable for node

Parameters:

node -

Returns:

isTemplate

public boolean isTemplate()

Checks if this graph is template

Returns:

isTemplate

getFilter

public ObjectMenuFilter getFilter()

Description copied from interface: MenuFiltringObj

Returns filter

Specified by:

getFilter in interface MenuFiltringObj

setFilter

public void setFilter(ObjectMenuFilter filter)

Description copied from interface: MenuFiltringObj

Sets filter

Specified by:

setFilter in interface MenuFiltringObj

getType

public int getType()

Description copied from interface: MenuFiltringObj

Returns type of of object(for Object tools it is required for determining local commands)

Specified by:

getType in interface MenuFiltringObj