gnue.reports Private API - GNU Enterprise

Package gnue :: Package reports :: Package base :: Module GRParameters :: Class GRParameter

[show private | hide private]

Type GRParameter

GTriggerCore --+    
               |    
  object --+   |    
           |   |    
   ParserObj --+    
               |    
            GObj --+
                   |
                  GRParameter

Method Summary
	`__init__(self, parent)`
	`_buildObject(self)` This function is called after the parsers have completely constructed.
Inherited from GObj
	`__getitem__(self, key)`
	`__setitem__(self, key, value)`
	`_dumpXML_(self, lookupDict, treeDump, gap, xmlnamespaces, textEncoding, stripPrefixes, escape)` Dumps an XML representation of the object
	`buildAndInitObject(self, **params)` This is a convenience function for applications NOT using GParser to load an object tree.
	`buildObject(self, **params)` A convenience function for applications NOT using GParser to load an object tree.
string	`getXmlTag(self, stripPrefixes)` Returns the xml tag to be used to represent the object.
	`iterator(self, test, types, includeSelf)` Return a python iterator of child objects.
	`maxInits(self)` maxInits returns the maximum size of all the _inits list from this object or it's children
	`phaseInit(self, iterations)` Starts GNUe's phased initialization system from this object down.
	`showTree(self, indent)` A recusive function to print an indented text representation of the GObj tree from this object down.
	`walk(self, function, args, *parms)` Function that recursively walks down through a tree of `ParserObj` instances and applies a function to them.
	`_phaseInit(self, phase)` Used internally by phaseInit to walk through the object tree initializing objects.
	`_setItemHook(self, key, value)` This bit of nastiness is here to let GNUe Designer capture the setting of GObject properties.
Inherited from GTriggerCore
	`__repr__(self)`
	`create_namespace_object(self, global_namespace, namespace_name)` Construct a namespace object tree from an XML (`definitions.GObjects.GObj`) object tree.
	`get_namespace_object(self)` Return the namespace object that mirrors this object in the action/trigger namespace.
Inherited from ParserObj
	`_diffActionWalker_(self, obj, action)` Set the action attribute of a given object to the specified action.
	`_getAsContents_(self)` Get the contents of this object.
	`_id_(self, maxIdLength)` Return a compareable and identifying id of an object within a tree.
	`_set_initial_attributes_(self, attributes)` Set attributes loaded by GParser.
	`addChild(self, child)` Add an object to the list of children
	`assign(self, source, recursive)` Assign all attributes from a given object to this one.
	`diff(self, goal, maxIdLength)` Build an object tree representing the difference between two object trees.
	`dumpXML(self, lookupDict, treeDump, gap, xmlnamespaces, textEncoding, stripPrefixes, escape)` Return a XML representation of the object.
	`findChildNamed(self, name, childType)` Moves downward though the children of an object till it finds the child with the specified name.
	`findChildOfType(self, childType, includeSelf, allowAllChildren)` Moves downward through the children of an object till it finds the child of the specified type.
	`findChildrenOfType(self, childType, includeSelf, allowAllChildren)` Find all children of a specific type.
	`findParentOfType(self, parentType, includeSelf)` Moves upward though the parents of an object till it finds the parent of the specified type.
	`getChildrenAsContent(self)` Returns the content of any GContent objects that are children of this object.
	`getDescription(self)` Return a useful description of the object.
any	`getParent(self)` Returns the immediate parent of an object instance in a GObj tree.
	`merge(self, other, maxIdLength, overwrite)` Merge another object tree into this tree.
	`setParent(self, newParent)` Set the immediate parent of an object instance in a GObj tree
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` Return hash(x)...
	`__new__(T, S, ...)` Return a new object with type S, a subtype of T...
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` Return str(x)...

Instance Variable Summary
Inherited from GTriggerCore
	`_triggerFunctions`: Dictionary defining the functions this object should present in action/trigger code.
	`_triggerGet`: Can be set to a method that returns the string value of the object.
	`_triggerGlobal`: If set to True, this object is added to the global namespace.
	`_triggerProperties`: Dictionary defining the properties this object should present in action/trigger code.
	`_triggerSet`: Can be set to a method that sets the value of this object.

Method Details

init(self, parent)
(Constructor)

Overrides:: gnue.common.definitions.GObjects.GObj.__init__

_buildObject(self)

This function is called after the parsers have completely constructed. All children should be in place and attributes and content should be set at this point. Return the number of phaseInit iterations your object will need.

NOTE: Do not initialize datasources, etc at this point. This is only so content can be set, etc, after loading from XML.

Returns:: number of the phaseInit iterations needed by this object

Overrides:: gnue.common.definitions.GObjects.GObj._buildObject (inherited documentation)

Type GRParameter

init(self, parent)
(Constructor)

_buildObject(self)

GNUe Home

Private API

Developer's Corner

Type GRParameter

__init__(self, parent) (Constructor)

_buildObject(self)

GNUe Home

Private API

Developer's Corner

init(self, parent)
(Constructor)