Package Products :: Package ZenModel :: Module GraphDefinition :: Class GraphDefinition |
[hide private]
[frames] | no frames]

# Class GraphDefinition

source code

                                                            object --+
                                                                     |
                                             ZenModelBase.ZenModelBase --+
                                                                         |
                                   ExtensionClass.Base --+               |
                                                         |               |
                             OFS.CopySupport.CopyContainer --+           |
                                                             |           |
                  ZenRelations.RelCopySupport.RelCopyContainer --+       |
                                                                 |       |
                                   ExtensionClass.Base --+       |       |
                                                         |       |       |
                             OFS.CopySupport.CopyContainer --+   |       |
                                                             |   |       |
                                   ExtensionClass.Base --+   |   |       |
                                                         |   |   |       |
                                 App.Management.Navigation --+   |       |
                                                             |   |       |
                                   ExtensionClass.Base --+   |   |       |
                                                         |   |   |       |
                                       App.Management.Tabs --+   |       |
                                                             |   |       |
                                      Acquisition.Implicit --+   |       |
                                                             |   |       |
                                    Persistence.Persistent --+   |       |
                                                             |   |       |
                               ExtensionClass.Base --+       |   |       |
                                                     |       |   |       |
                webdav.EtagSupport.EtagSupport --+   |       |   |       |
                                                 |   |       |   |       |
                      webdav.Lockable.LockableItem --+       |   |       |
                                                     |       |   |       |
                              webdav.Resource.Resource --+   |   |       |
                                                         |   |   |       |
                              webdav.Collection.Collection --+   |       |
                                                             |   |       |
                               OFS.Traversable.Traversable --+   |       |
                                                             |   |       |
                               OFS.ObjectManager.ObjectManager --+       |
                                                                 |       |
                                   ExtensionClass.Base --+       |       |
                                                         |       |       |
                               ExtensionClass.Base --+   |       |       |
                                                     |   |       |       |
                            OFS.CopySupport.CopySource --+       |       |
                                                         |       |       |
                               ExtensionClass.Base --+   |       |       |
                                                     |   |       |       |
                                   App.Management.Tabs --+       |       |
                                                         |       |       |
                           OFS.Traversable.Traversable --+       |       |
                                                         |       |       |
                             AccessControl.Owned.Owned --+       |       |
                                                         |       |       |
                                  ZenRelations.ZItem.ZItem --+   |       |
                                                             |   |       |
                                      Acquisition.Implicit --+   |       |
                                                             |   |       |
                            AccessControl.Role.RoleManager --+   |       |
                                                             |   |       |
      ZenRelations.PrimaryPathObjectManager.PrimaryPathManager --+       |
                                                                 |       |
                                       ExtensionClass.Base --+   |       |
                                                             |   |       |
                                          App.Undo.UndoSupport --+       |
                                                                 |       |
    ZenRelations.PrimaryPathObjectManager.PrimaryPathObjectManager --+   |
                                                                     |   |
                                                        object --+   |   |
                                                                 |   |   |
                                       ExtensionClass.Base --+   |   |   |
                                                             |   |   |   |
                                     OFS.ZDOM.Node --+       |   |   |   |
                                                     |       |   |   |   |
                                      OFS.ZDOM.Element --+   |   |   |   |
                                                         |   |   |   |   |
                            OFS.ZDOM.ElementWithAttributes --+   |   |   |
                                                             |   |   |   |
                           OFS.PropertyManager.PropertyManager --+   |   |
                                                                 |   |   |
                ZenRelations.ZenPropertyManager.ZenPropertyManager --+   |
                                                                     |   |
                  ZenRelations.RelationshipManager.RelationshipManager --+
                                                                         |
                                               ExtensionClass.Base --+   |
                                                                     |   |
                                                OFS.History.Historical --+
                                                                         |
                                                            object --+   |
                                                                     |   |
                                                   ZenPacker.ZenPacker --+
                                                                         |
                                                     ZenModelRM.ZenModelRM --+
                                                                             |
                                                                object --+   |
                                                                         |   |
                                                   ZenPackable.ZenPackable --+
                                                                             |
                                                                            GraphDefinition

GraphDefinition defines the global options for a graph.

Instance Methods | [hide private]
Inherited from `ZenModelRM.ZenModelRM`: `__init__`, `changePythonClass`, `creator`, `editableDeviceList`, `findChild`, `getCreatedTimeString`, `getDmdKey`, `getModificationTimeString`, `getSubObjects`, `getTreeItems`, `getZenRootNode`, `index_object`, `primarySortKey`, `reindex_all`, `rename`, `setTitle`, `unindex_object`, `viewName`, `zmanage_addProperty`, `zmanage_delObjects`, `zmanage_delProperties`, `zmanage_editProperties`, `zmanage_exportObject`, `zmanage_importObject`, `zmanage_importObjects` Inherited from `ZenModelBase.ZenModelBase`: `__call__`, `__hash__`, `all_meta_types`, `aqBaseHasAttr`, `callZenScreen`, `checkRemotePerm`, `createHierarchyObj`, `custPropertyIds`, `custPropertyMap`, `getBreadCrumbName`, `getBreadCrumbUrlPath`, `getDmd`, `getDmdObj`, `getDmdRoot`, `getHierarchyObj`, `getIconPath`, `getIdLink`, `getNowString`, `getObjByPath`, `getPrimaryDmdId`, `getUnusedId`, `getZopeObj`, `helpLink`, `isLocalName`, `manage_deleteObjects`, `prepId`, `saveCustProperties`, `todayDate`, `upToOrganizerBreadCrumbs`, `urlLink`, `view`, `visibleCustPropertyMap`, `yesterdayDate`, `zenScreenUrl`, `zenpathjoin`, `zenpathsplit`, `zentinelTabs` Inherited from `ZenModelBase.ZenModelBase` (private): `_selectedTabName` Inherited from `ZenRelations.RelationshipManager.RelationshipManager`: `addRelation`, `buildRelations`, `cb_isMoveable`, `checkRelations`, `exportXml`, `exportXmlProperties`, `exportXmlRelationships`, `getRelationshipManagerId`, `getRelationshipNames`, `getRelationships`, `manage_addRelation`, `manage_removeRelation`, `manage_workspace`, `moveMeBetweenRels`, `moveObject`, `removeRelation` Inherited from `ZenRelations.RelationshipManager.RelationshipManager` (private): `_getCopy`, `_notifyOfCopyTo`, `_setObject` Inherited from `ZenRelations.PrimaryPathObjectManager.PrimaryPathObjectManager` (private): `_delObject` Inherited from `ZenRelations.RelCopySupport.RelCopyContainer`: `manage_linkObjects`, `manage_unlinkObjects` Inherited from `ZenRelations.RelCopySupport.RelCopyContainer` (private): `_checkId`, `_getRelName`, `_getSourceObjects`, `_verifyObjectLink`, `_verifyObjectPaste` Inherited from `OFS.ObjectManager.ObjectManager`: `__class_init__`, `__contains__`, `__delitem__`, `__getitem__`, `__iter__`, `__len__`, `__nonzero__`, `__setitem__`, `filtered_meta_types`, `get`, `getSiteManager`, `hasObject`, `items`, `keys`, `list_imports`, `manage_FTPlist`, `manage_FTPstat`, `manage_afterAdd`, `manage_afterClone`, `manage_beforeDelete`, `manage_delObjects`, `manage_exportObject`, `manage_hasId`, `manage_importObject`, `objectIds`, `objectIds_d`, `objectItems`, `objectItems_d`, `objectMap`, `objectMap_d`, `objectValues`, `objectValues_d`, `setSiteManager`, `superValues`, `tpValues`, `values` Inherited from `OFS.ObjectManager.ObjectManager` (private): `_delOb`, `_getImportPaths`, `_getOb`, `_importObjectFromFile`, `_setOb`, `_subobject_permissions` Inherited from `OFS.CopySupport.CopyContainer`: `cb_dataItems`, `cb_dataValid`, `manage_CopyContainerAllItems`, `manage_CopyContainerFirstItem`, `manage_clone`, `manage_copyObjects`, `manage_cutObjects`, `manage_pasteObjects`, `manage_renameObject`, `manage_renameObjects`, `validClipData` Inherited from `OFS.CopySupport.CopyContainer` (private): `_get_id` Inherited from `App.Management.Navigation`: `manage_zmi_logout` Inherited from `ZenRelations.PrimaryPathObjectManager.PrimaryPathManager`: `getPrimaryId`, `getPrimaryParent`, `getPrimaryPath`, `getPrimaryUrlPath`, `primaryAq` Inherited from `ZenRelations.ZItem.ZItem`: `__repr__`, `getId`, `manage_editedDialog`, `this`, `titleOrId`, `title_and_id`, `title_or_id`, `tpURL` Inherited from `OFS.CopySupport.CopySource`: `cb_isCopyable`, `cb_userHasCopyOrMovePermission` Inherited from `OFS.CopySupport.CopySource` (private): `_canCopy`, `_postCopy`, `_setId` Inherited from `App.Management.Tabs`: `filtered_manage_options`, `tabs_path_default`, `tabs_path_info` Inherited from `webdav.Collection.Collection`: `DELETE`, `HEAD`, `PUT`, `dav__init`, `listDAVObjects` Inherited from `webdav.Resource.Resource`: `COPY`, `LOCK`, `MKCOL`, `MOVE`, `OPTIONS`, `PROPFIND`, `PROPPATCH`, `TRACE`, `UNLOCK`, `dav__simpleifhandler`, `dav__validate`, `manage_DAVget` Inherited from `webdav.Lockable.LockableItem`: `wl_clearLocks`, `wl_delLock`, `wl_getLock`, `wl_hasLock`, `wl_isLocked`, `wl_lockItems`, `wl_lockTokens`, `wl_lockValues`, `wl_lockmapping`, `wl_setLock` Inherited from `webdav.EtagSupport.EtagSupport`: `http__etag`, `http__parseMatchList`, `http__processMatchHeaders`, `http__refreshEtag` Inherited from `OFS.Traversable.Traversable`: `absolute_url`, `absolute_url_path`, `getPhysicalPath`, `restrictedTraverse`, `unrestrictedTraverse`, `virtual_url_path` Inherited from `App.Undo.UndoSupport`: `manage_undo_transactions`, `undoable_transactions` Inherited from `App.Undo.UndoSupport` (private): `_get_request_var_or_attr` Inherited from `ZenRelations.ZenPropertyManager.ZenPropertyManager`: `deleteZenProperty`, `exportZProperties`, `getOverriddenObjects`, `getProperty`, `getPropertyType`, `getZ`, `hasProperty`, `isLocal`, `manage_editProperties`, `saveZenProperties`, `setZenProperty`, `zenPropIsPassword`, `zenPropertyIds`, `zenPropertyItems`, `zenPropertyMap`, `zenPropertyOptions`, `zenPropertyPath`, `zenPropertyString` Inherited from `ZenRelations.ZenPropertyManager.ZenPropertyManager` (private): `_findParentWithProperty`, `_setPropValue`, `_setProperty`, `_updateProperty` Inherited from `OFS.History.Historical`: `manage_afterHistoryCopy`, `manage_beforeHistoryCopy`, `manage_change_history`, `manage_historicalComparison`, `manage_historyCompare`, `manage_historyCopy` Inherited from `ZenPacker.ZenPacker`: `addToZenPack`, `eligiblePacks`, `findObject` Inherited from `OFS.PropertyManager.PropertyManager`: `manage_addProperty`, `manage_changeProperties`, `manage_changePropertyTypes`, `manage_delProperties`, `propdict`, `propertyDescription`, `propertyIds`, `propertyItems`, `propertyLabel`, `propertyMap`, `propertyValues`, `valid_property_id` Inherited from `OFS.PropertyManager.PropertyManager` (private): `_delPropValue`, `_delProperty`, `_propertyMap`, `_wrapperCheck` Inherited from `OFS.ZDOM.ElementWithAttributes`: `getAttribute`, `getAttributeNode`, `getAttributes` Inherited from `OFS.ZDOM.Element`: `getChildNodes`, `getElementsByTagName`, `getFirstChild`, `getLastChild`, `getNextSibling`, `getNodeName`, `getNodeType`, `getParentNode`, `getPreviousSibling`, `getTagName` Inherited from `OFS.ZDOM.Node`: `getNodeValue`, `getOwnerDocument`, `hasChildNodes`
'id':'summary', 'type':'boolean', 'mode':'w'},
getGraphPoints(self, includeThresholds=True) Return ordered list of graph points | source code
getThresholdGraphPoints(self) Get ordered list of threshold graph points | source code
isThresholdGraphed(self, threshId) Return true if there is a thresholdgraphpoint with threshId=threshid | source code
isDataPointGraphed(self, dpName) Return true if there is at least one graphpoint with a dsName equal to dpName. | source code
list
    >>> dmd.Devices.Server.breadCrumbs()
    [('/zport/dmd/Devices', 'Devices'),
        ('/zport/dmd/Devices/Server', 'Server')]
breadCrumbs(self, terminator='dmd') Return the breadcrumb links for this object add ActionRules list. | source code
boolean
    >>> dmd.Devices.checkValidId('^*')
    'The id "^*" contains characters illegal in URLs.'
    >>> dmd.Devices.checkValidId('Server')
    'The id "Server" is invalid - it is already in use.'
    >>> dmd.Devices.checkValidId('ZenTestId')
    True
checkValidId(self, id, prep_id=False) Checks a valid id | source code
getGraphPointDescriptions(self) | source code
getGraphPointsNames(self) Return list of graph point ids | source code
getGraphPointNamesString(self) Return a string that lists the names of the graphpoints used in this graph definition. | source code
getGraphPointOptions(self) Used by dialog_addGraphPoint to construct the list of available graphpoint types. | source code
createGraphPoint(self, cls, newId) Create the graphpoint with the given id or something similar and add to self.graphPoints | source code
manage_addCustomGraphPoint(self, new_id, flavor, REQUEST=None) Create a new graphpoint of the given class and id | source code
manage_addDataPointGraphPoints(self, dpNames=None, includeThresholds=False, REQUEST=None) Create new graph points The migrate script graphDefinitions and friends depends on the first element in newGps being the DataPointGraphPoint when only one name is passed in dpNames. | source code
addThresholdsForDataPoint(self, dpName) Make sure that Threshold graph points exist for all thresholds that use the given dpName. | source code
manage_addThresholdGraphPoints(self, threshNames, REQUEST=None) Create new threshold graph points | source code
manage_deleteGraphPoints(self, ids=(), REQUEST=None) Deleted given graphpoints | source code
manage_resequenceGraphPoints(self, seqmap=(), origseq=(), REQUEST=None) Reorder the sequence of the GraphPoints. | source code
getDataPointOptions(self) Return a list of (value, name) tuples for the list of datapoints which the user selects from to create new graphpoints. | source code
getThresholdOptions(self) Return a list of (value, name) tuples for the list of thresholds which the user selects from to create new graphpoints. | source code
getGraphCmds(self, context, rrdDir, multiid=-1, upToPoint=None, includeSetup=True, includeThresholds=True, prefix='', cmds=None, idxOffset=0) build the graph opts for a single rrdfile | source code
getRRDVariables(self, upToPoint=None) Return list of rrd variable names that are defined by DEF, CDEF or VDEF statements in the rrd commands. | source code
getFakeGraphCmds(self, upToPoint=None) Used to display the graph commands (or a reasonable likeness) to the user | source code
graphsetup(self) Setup global graph parameters. | source code
getDataPointGraphPoints(self, dpName) Return a list of DataPointGraphPoints that use the given dpName | source code
getUniqueDpNames(self, limit=None) Get a list of all unique datapoint names | source code
getUniqueThresholdNames(self, limit=100) Get a list of all unique threshold names | source code

Class Methods | [hide private]
Inherited from `ZenRelations.RelationshipManager.RelationshipManager`: `lookupSchema`

Class Variables | [hide private]
| meta_type = `'GraphDefinition'`
| height = `100`
| width = `500`
| units = `""`
| log = `False`
| base = `False`
| miny = `-1`
| maxy = `-1`
| custom = `""`
| hasSummary = `True`
| sequence = `0`
Inherited from `ZenModelRM.ZenModelRM`: `default_catalog`, `isInTree` Inherited from `ZenModelBase.ZenModelBase`: `index_html`, `sub_meta_types` Inherited from `ZenModelBase.ZenModelBase` (private): `_zendoc` Inherited from `ZenRelations.RelationshipManager.RelationshipManager`: `manage_main`, `manage_options` Inherited from `ZenRelations.RelationshipManager.RelationshipManager` (private): `_operation` Inherited from `OFS.ObjectManager.ObjectManager`: `has_order_support`, `isAnObjectManager`, `isPrincipiaFolderish`, `manage_addProduct`, `manage_importExportForm`, `manage_index_main`, `meta_types` Inherited from `OFS.ObjectManager.ObjectManager` (private): `_components`, `_objects` Inherited from `OFS.CopySupport.CopyContainer`: `manage_renameForm` Inherited from `App.Management.Navigation`: `manage`, `manage_copyright`, `manage_form_title`, `manage_menu`, `manage_page_footer`, `manage_page_header`, `manage_top_frame`, `manage_zmi_prefs`, `zope_quick_start` Inherited from `ZenRelations.ZItem.ZItem`: `REQUEST`, `__allow_access_to_unprotected_subobjects__`, `__name__`, `__propsets__`, `getId__roles__`, `icon`, `id`, `isTopLevelPrincipiaApplicationObject`, `title` Inherited from `ZenRelations.ZItem.ZItem` (private): `_manage_editedDialog` Inherited from `App.Management.Tabs`: `manage_tabs`, `manage_workspace__roles__` Inherited from `webdav.Collection.Collection`: `__dav_collection__` Inherited from `webdav.Resource.Resource`: `__dav_resource__`, `__http_methods__` Inherited from `OFS.Traversable.Traversable`: `getPhysicalRoot` Inherited from `App.Undo.UndoSupport`: `manage_UndoForm` Inherited from `ZenRelations.ZenPropertyManager.ZenPropertyManager`: `__pychecker__`, `manage_propertiesForm` Inherited from `ZenRelations.ZenPropertyManager.ZenPropertyManager` (private): `_onlystars` Inherited from `OFS.History.Historical`: `HistoricalRevisions`, `manage_change_history_page` Inherited from `OFS.History.Historical` (private): `_manage_historyComparePage` Inherited from `OFS.PropertyManager.PropertyManager`: `manage_propertyTypeForm`, `propertysheets` Inherited from `OFS.PropertyManager.PropertyManager` (private): `_reserved_names`
'id':'summary', 'type':'boolean', 'mode':'w'},
| _properties = `{'id': 'height', 'type': 'int', 'mode': 'w'}, {'`...``
| _relations = `"rrdTemplate", ToOne(ToManyCont, "Products.ZenMod`...``
| factory_type_information = `{'immediate_view': 'editGraphDefini`...``
| security = `ClassSecurityInfo()`

Method Details | [hide private]

### breadCrumbs(self, terminator='dmd') | source code
Return the breadcrumb links for this object add ActionRules list. [('url','id'), ...] Returns: list
    >>> dmd.Devices.Server.breadCrumbs()
    [('/zport/dmd/Devices', 'Devices'),
        ('/zport/dmd/Devices/Server', 'Server')]
List of tuples to create a bread crumbs Overrides: ZenModelBase.ZenModelBase.breadCrumbs

### checkValidId(self, id, prep_id=False) | source code
Checks a valid id Returns: boolean
    >>> dmd.Devices.checkValidId('^*')
    'The id "^*" contains characters illegal in URLs.'
    >>> dmd.Devices.checkValidId('Server')
    'The id "Server" is invalid - it is already in use.'
    >>> dmd.Devices.checkValidId('ZenTestId')
    True
Overrides: ZenModelBase.ZenModelBase.checkValidId

### getGraphPointNamesString(self) | source code
Return a string that lists the names of the graphpoints used in this graph definition. If this graph definition has a perf template then note in the string which graphpoints are broken (in that they refer to nonexistent datapoints.)

### addThresholdsForDataPoint(self, dpName) | source code
Make sure that Threshold graph points exist for all thresholds that use the given dpName. Return a list of all graphpoints created by this call.

### getRRDVariables(self, upToPoint=None) | source code
Return list of rrd variable names that are defined by DEF, CDEF or VDEF statements in the rrd commands. If upToPoint is not None then only consider statements generated by graphoints where sequence < upToPoint

Class Variable Details | [hide private]

  ### _properties Value:
      {'id': 'height', 'type': 'int', 'mode': 'w'}, {'id': 'width', 'type':
      'int', 'mode': 'w'}, {'id': 'units', 'type': 'string', 'mode': 'w'}, {
      'id': 'log', 'type': 'boolean', 'mode': 'w'}, {'id': 'base', 'type': '
      boolean', 'mode': 'w'}, {'id': 'miny', 'type': 'int', 'mode': 'w'}, {'
      id': 'maxy', 'type': 'int', 'mode': 'w'}, {'id': 'custom', 'type': 'te
      xt', 'mode': 'w'}, {'id': 'hasSummary', 'type': 'boolean', 'mode': 'w'
      }, {'id': 'sequence', 'type': 'long', 'mode': 'w'},

  ### _relations Value:
      "rrdTemplate", ToOne(ToManyCont, "Products.ZenModel.RRDTemplate", "gra
      phDefs"), ('report', ToOne(ToManyCont, 'Products.ZenModel.MultiGraphRe
      port', 'graphDefs')), ('graphPoints', ToManyCont(ToOne, 'Products.ZenM
      odel.GraphPoint', 'graphDef')), ('reportClass', ToOne(ToManyCont, 'Pro
      ducts.ZenModel.MultiGraphReportClass', 'graphDefs')),

  ### factory_type_information Value:
      {'immediate_view': 'editGraphDefinition', 'actions':({'id': 'edit', 'n
      ame': 'Graph Definition', 'action': 'editGraphDefinition', 'permission
      s':(Permissions.view,)}, {'id': 'editCustom', 'name': 'Graph Custom De
      finition', 'action': 'editCustGraphDefinition', 'permissions':(Permiss
      ions.view,)}, {'id': 'viewCommands', 'name': 'Graph Commands', 'action
      ': 'viewGraphCommands', 'permissions':(Permissions.view,)},)},