Package org.netxms.client.datacollection

Class GraphDefinition

java.lang.Object

org.netxms.client.datacollection.ChartConfiguration

org.netxms.client.datacollection.GraphDefinition

All Implemented Interfaces:

ObjectAction

public class GraphDefinition
extends ChartConfiguration
implements ObjectAction

Settings for predefined graph

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACCESS_READ
static final int	ACCESS_WRITE
protected ChartDciConfig[]	dciList
static final int	GF_TEMPLATE

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

area, autoRefresh, autoScale, doughnutRendering, extendedLegend, GAUGE_COLOR_MODE_CUSTOM, GAUGE_COLOR_MODE_THRESHOLD, GAUGE_COLOR_MODE_ZONE, legendPosition, lineWidth, logScale, MAX_GRAPH_ITEM_COUNT, maxYScaleValue, minYScaleValue, modifyYBase, POSITION_BOTTOM, POSITION_LEFT, POSITION_RIGHT, POSITION_TOP, refreshRate, rotation, showGrid, showHostNames, showLabels, showLegend, showTitle, showTotal, stacked, timeFrameType, timeFrom, timePeriod, timeRange, timeTo, timeUnit, title, translucent, transposed, useMultipliers, zoomEnabled

Constructor Summary

Constructors

Constructor	Description
GraphDefinition()	Create empty graph definition
GraphDefinition(long id, long ownerId, int flags, Collection<AccessListElement> accessList)	Create graph definition
GraphDefinition(GraphDefinition src)	Create copy of provided graph definition
GraphDefinition(GraphDefinition src, String title)	Create copy of provided graph definition (with template flag removed if set in source).

Method Summary

Modifier and Type	Method	Description
static GraphDefinition	createGraphSettings(NXCPMessage msg, long baseId)	Create graph settings object from NXCP message
void	fillMessage(NXCPMessage msg)	Fill NXCP message
List<AccessListElement>	getAccessList()
ChartDciConfig[]	getDciList()
String	getDisplayName()	Get display name (short name with & shortcut marks removed)
int	getFlags()	Get predefined graph flags.
long	getId()
ObjectMenuFilter	getMenuFilter()	Get menu filter associated with the tool
String	getName()
long	getOwnerId()
GraphFolder	getParent()	Get parent folder
String	getShortName()	Get short name (last part of full path separated by "->")
int	getToolType()	Get tool type
boolean	isApplicableForObject(AbstractObject object)	Check if this action is applicable to given object
boolean	isTemplate()	Checks if this graph definition is template
void	setAccessList(Collection<AccessListElement> accessList)
void	setDciList(ChartDciConfig[] dciList)
void	setFlags(int flags)	Set predefined graph flags.
void	setId(long id)
void	setMenuFilter(ObjectMenuFilter filter)	Sets menu filter for the tool
void	setName(String name)
void	setOwnerId(long ownerId)
void	setParent(GraphFolder parent)	Set parent folder
String	toString()

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

addChangeListener, areLabelsInside, areLabelsVisible, createFromXml, createXml, fireChangeNotification, getExpectedTextWidth, getFontName, getFontSize, getGaugeColorMode, getLeftRedZone, getLeftYellowZone, getLegendPosition, getLineWidth, getMaxYScaleValue, getMinYScaleValue, getRefreshRate, getRightRedZone, getRightYellowZone, getRotation, getTimeFrom, getTimePeriod, getTimeRangeMillis, getTimeTo, getTitle, getYAxisLabel, isArea, isAutoRefresh, isAutoScale, isDoughnutRendering, isElementBordersVisible, isExtendedLegend, isGridVisible, isLegendVisible, isLogScale, isModifyYBase, isShowHostNames, isShowTotal, isStacked, isTitleVisible, isTranslucent, isTransposed, isUseMultipliers, isZoomEnabled, removeChangeListener, setArea, setAutoRefresh, setAutoScale, setDoughnutRendering, setElementBordersVisible, setExpectedTextWidth, setExtendedLegend, setFontName, setFontSize, setGaugeColorMode, setGridVisible, setLabelsInside, setLabelsVisible, setLeftRedZone, setLeftYellowZone, setLegendPosition, setLegendVisible, setLineWidth, setLogScale, setMaxYScaleValue, setMinYScaleValue, setModifyYBase, setRefreshRate, setRightRedZone, setRightYellowZone, setRotation, setShowHostNames, setShowTotal, setStacked, setTimeFrom, setTimePeriod, setTimeTo, setTitle, setTitleVisible, setTranslucent, setTransposed, setUseMultipliers, setYAxisLabel, setZoomEnabled

Methods inherited from class java.lang.Object

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

Field Details

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

GF_TEMPLATE

public static final int GF_TEMPLATE

See Also:

• Constant Field Values

dciList

protected ChartDciConfig[] dciList

Constructor Details

GraphDefinition

public GraphDefinition()

Create empty graph definition

GraphDefinition

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

Create graph definition

Parameters:

id - definition ID

ownerId - owning user ID

flags - flags

accessList - graph access list

GraphDefinition

public GraphDefinition(GraphDefinition src,
 String title)

Create copy of provided graph definition (with template flag removed if set in source).

Parameters:

src - source definition

title - new title (or null to keep original)

GraphDefinition

public GraphDefinition(GraphDefinition src)

Create copy of provided graph definition

Parameters:

src - source object

Method Details

createGraphSettings

public static GraphDefinition createGraphSettings(NXCPMessage msg,
 long baseId)

Create graph settings object from NXCP message

Parameters:

msg - NXCP message

baseId - base variable id

Returns:

The graph settings object

fillMessage

public void fillMessage(NXCPMessage msg)

Fill NXCP message

Parameters:

msg - NXCP message

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

setAccessList

public void setAccessList(Collection<AccessListElement> accessList)

Parameters:

accessList - the accessList to set

getShortName

public String getShortName()

Get short name (last part of full path separated by "->")

Returns:

short name

getDisplayName

public String getDisplayName()

Get display name (short name with & shortcut marks removed)

Returns:

display name

setName

public void setName(String name)

Parameters:

name - the name to set

setFlags

public void setFlags(int flags)

Set predefined graph flags.

Parameters:

flags - new predefined graph flags

getFlags

public int getFlags()

Get predefined graph flags.

Returns:

predefined graph flags

isTemplate

public boolean isTemplate()

Checks if this graph definition is template

Returns:

isTemplate

getParent

public GraphFolder getParent()

Get parent folder

Returns:

parent folder

setParent

public void setParent(GraphFolder parent)

Set parent folder

Parameters:

parent - new parent folder

isApplicableForObject

public boolean isApplicableForObject(AbstractObject object)

Description copied from interface: ObjectAction

Check if this action is applicable to given object

Specified by:

isApplicableForObject in interface ObjectAction

Parameters:

object - object

Returns:

true if applicable

See Also:

• ObjectAction.isApplicableForObject(org.netxms.client.objects.AbstractObject)

getMenuFilter

public ObjectMenuFilter getMenuFilter()

Description copied from interface: ObjectAction

Get menu filter associated with the tool

Specified by:

getMenuFilter in interface ObjectAction

Returns:

menu filter associated with the tool

See Also:

• ObjectAction.getMenuFilter()

setMenuFilter

public void setMenuFilter(ObjectMenuFilter filter)

Description copied from interface: ObjectAction

Sets menu filter for the tool

Specified by:

setMenuFilter in interface ObjectAction

Parameters:

filter - new menu filter

See Also:

• ObjectAction.setMenuFilter(org.netxms.client.ObjectMenuFilter)

getToolType

public int getToolType()

Description copied from interface: ObjectAction

Get tool type

Specified by:

getToolType in interface ObjectAction

Returns:

tool type

See Also:

• ObjectAction.getToolType()

setId

public void setId(long id)

Parameters:

id - the id to set

setOwnerId

public void setOwnerId(long ownerId)

Parameters:

ownerId - the ownerId to set

getDciList

public ChartDciConfig[] getDciList()

Returns:

the dciList

setDciList

public void setDciList(ChartDciConfig[] dciList)

Parameters:

dciList - the dciList to set

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()