gnue.reports Public API - GNU Enterprise

Package gnue :: Package common :: Package datasources :: Module GConditions :: Class GCParam

[show private | hide private]

Type GCParam

GTriggerCore --+            
               |            
  object --+   |            
           |   |            
   ParserObj --+            
               |            
            GObj --+        
                   |        
          GCondition --+    
                       |    
       GConditionElement --+
                           |
                          GCParam

Known Subclasses:: GRStubParam

Abstract class for parameters. Must be overridden by a descendant to handle actual parameter values.

Method Summary
	`__init__(self, parent, name, datatype)`
	`asSQL(self, paramDict)` Add another key to the parameter dictionary holding the parameter's value and return an apropriate place holder for it.
	`evaluate(self, lookup)` A parameter element evaluates to it's value.
	`getValue(self)` Descendants override this function to return the value of the parameter.
	`prefixNotation(self)` The prefix notation of a parameter object is a 'constant' with the parameters' value
Inherited from GCondition
	`buildFromList(self, prefixList)` This function creates a (partial) condition tree from a prefix notation list.
	`validate(self)` This function calls validate () on all it's children.
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.
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 GCondition
	`_maxChildren_`: if not None specifies the maximum number of children allowed for a condition element.
	`_operator_`: unicode string defining the operator used for SQL transformation of a condition element.

Method Details

init(self, parent, name=None, datatype='char')
(Constructor)

Overrides:: gnue.common.datasources.GConditions.GConditionElement.__init__

asSQL(self, paramDict)

Add another key to the parameter dictionary holding the parameter's value and return an apropriate place holder for it.

Parameters:: paramDict - parameter dictionary which will be extended

Returns:: placeholder for the parameter, i.e. '%(p0)s'

Overrides:: gnue.common.datasources.GConditions.GCondition.asSQL

evaluate(self, lookup)

A parameter element evaluates to it's value.

Parameters:: lookup - dictionary used for lookups

Returns:: the parameter's value

Overrides:: gnue.common.datasources.GConditions.GCondition.evaluate

getValue(self)

Descendants override this function to return the value of the parameter.

prefixNotation(self)

The prefix notation of a parameter object is a 'constant' with the parameters' value

Returns:: ['Const', value]

Overrides:: gnue.common.datasources.GConditions.GCondition.prefixNotation

Type GCParam

init(self, parent, name=None, datatype='char')
(Constructor)

asSQL(self, paramDict)

evaluate(self, lookup)

getValue(self)

prefixNotation(self)

GNUe Home

Public API

Developer's Corner

Type GCParam

__init__(self, parent, name=None, datatype='char') (Constructor)

asSQL(self, paramDict)

evaluate(self, lookup)

getValue(self)

prefixNotation(self)

GNUe Home

Public API

Developer's Corner

init(self, parent, name=None, datatype='char')
(Constructor)