Package org.netxms.client.datacollection
Class GraphDefinition
java.lang.Object
org.netxms.client.datacollection.ChartConfiguration
org.netxms.client.datacollection.GraphDefinition
- All Implemented Interfaces:
ObjectAction
Settings for predefined graph
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
protected ChartDciConfig[]
static final int
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
ConstructorDescriptionCreate empty graph definitionGraphDefinition
(long id, long ownerId, int flags, Collection<AccessListElement> accessList) Create graph definitionCreate copy of provided graph definitionGraphDefinition
(GraphDefinition src, String title) Create copy of provided graph definition (with template flag removed if set in source). -
Method Summary
Modifier and TypeMethodDescriptionstatic GraphDefinition
createGraphSettings
(NXCPMessage msg, long baseId) Create graph settings object from NXCP messagevoid
fillMessage
(NXCPMessage msg) Fill NXCP messageGet display name (short name with & shortcut marks removed)int
getFlags()
Get predefined graph flags.long
getId()
Get menu filter associated with the toolgetName()
long
Get parent folderGet short name (last part of full path separated by "->")int
Get tool typeboolean
isApplicableForObject
(AbstractObject object) Check if this action is applicable to given objectboolean
Checks if this graph definition is templatevoid
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 toolvoid
void
setOwnerId
(long ownerId) void
setParent
(GraphFolder parent) Set parent foldertoString()
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, 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, setZoomEnabled
-
Field Details
-
ACCESS_READ
public static final int ACCESS_READ- See Also:
-
ACCESS_WRITE
public static final int ACCESS_WRITE- See Also:
-
GF_TEMPLATE
public static final int GF_TEMPLATE- See Also:
-
dciList
-
-
Constructor Details
-
GraphDefinition
public GraphDefinition()Create empty graph definition -
GraphDefinition
Create graph definition- Parameters:
id
- definition IDownerId
- owning user IDflags
- flagsaccessList
- graph access list
-
GraphDefinition
Create copy of provided graph definition (with template flag removed if set in source).- Parameters:
src
- source definitiontitle
- new title (or null to keep original)
-
GraphDefinition
Create copy of provided graph definition- Parameters:
src
- source object
-
-
Method Details
-
createGraphSettings
Create graph settings object from NXCP message- Parameters:
msg
- NXCP messagebaseId
- base variable id- Returns:
- The graph settings object
-
fillMessage
Fill NXCP message- Parameters:
msg
- NXCP message
-
getId
public long getId()- Returns:
- the id
-
getOwnerId
public long getOwnerId()- Returns:
- the ownerId
-
getName
- Returns:
- the name
-
getAccessList
- Returns:
- the accessList
-
setAccessList
- Parameters:
accessList
- the accessList to set
-
getShortName
Get short name (last part of full path separated by "->")- Returns:
- short name
-
getDisplayName
Get display name (short name with & shortcut marks removed)- Returns:
- display name
-
setName
- 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
Get parent folder- Returns:
- parent folder
-
setParent
Set parent folder- Parameters:
parent
- new parent folder
-
isApplicableForObject
Description copied from interface:ObjectAction
Check if this action is applicable to given object- Specified by:
isApplicableForObject
in interfaceObjectAction
- Parameters:
object
- object- Returns:
- true if applicable
- See Also:
-
getMenuFilter
Description copied from interface:ObjectAction
Get menu filter associated with the tool- Specified by:
getMenuFilter
in interfaceObjectAction
- Returns:
- menu filter associated with the tool
- See Also:
-
setMenuFilter
Description copied from interface:ObjectAction
Sets menu filter for the tool- Specified by:
setMenuFilter
in interfaceObjectAction
- Parameters:
filter
- new menu filter- See Also:
-
getToolType
public int getToolType()Description copied from interface:ObjectAction
Get tool type- Specified by:
getToolType
in interfaceObjectAction
- Returns:
- tool type
- See Also:
-
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
- Returns:
- the dciList
-
setDciList
- Parameters:
dciList
- the dciList to set
-
toString
-