BasicClasses.FormulaNode

Module BasicClasses :: Class FormulaNode

[show private | hide private]

Class FormulaNode

    object --+    
             |    
      BIObject --+
                 |
    object --+   |
             |   |
BIXMLWriteable --+
                 |
                FormulaNode

Known Subclasses:: EntityNode, RelNode

The base class from which formula nodes are inherited. It implements the methods common to formula nodes.

Method Summary
	`__init__(self, oStack, attrs, **args)`
integer	`addArgument(self, argument)` Add argument to the list of arguments of this formula node.
	`computeXMLArgs(self)`
	`getEntities(self, recursive)` Return a list of all entities used as a text binding in this node and, if `recursive==True`, in the subtree rooted by this node.
	`isEntity(self)` Return `True` if the formula node represents a predicate (i.e.
	`isPredicate(self)` Return `True` if the formula node represents a predicate (i.e.
	`nestedItemsPresent(self)` True if this formula node has arguments, that is, if it is not a leaf in the formula tree.
	`setEntity(self, entityId)` Resolve entityId into an `Entity` and set the entity as the formula node text binding entity.
	`writeXMLNestedItems(self, out, indent)`
Inherited from BIXMLWriteable
	`writeXML(self, out, indent, **kwArgs)` Outputs the complete XML representation of the given object.
	`writeXMLClose(self, out, indent)` Prints the closing tag of the object: </tag>.
	`writeXMLOpen(self, out, indent, closing)` Writes opening tag into the XML output.
	`XMLAttrs(self)` Computes the string representation of the object's attributes, which are included into the XML tag.
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)
Inherited from type
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T

Instance Variable Summary
list	`arguments`: The arguments (children) of this formula node.
`Entity`	`entity`: The `Entity` used as text binding for this formula node.

Class Variable Summary
Inherited from BIObject
`NoneType`	`XMLTag` = None
Inherited from BIXMLWriteable
`list`	`persistentAttrs`: The list of attributes to be included in the XML output.

Method Details

addArgument(self, argument)

Add argument to the list of arguments of this formula node.

Parameters:: argument - The argument to be added
(type=FormulaNode)

Returns:: The position of the argument in this node (zero-based integer). The return value is used by the argument to remember its position among the arguments of the parent formula node.
(type=integer)

getEntities(self, recursive=False)

Return a list of all entities used as a text binding in this node and, if recursive==True, in the subtree rooted by this node.

isEntity(self)

Return True if the formula node represents a predicate (i.e. relationship). In the FormulaNode class, this method returns False. It overriden in the EntityNode class inherited from FormulaNode to return True.

isPredicate(self)

Return True if the formula node represents a predicate (i.e. relationship). In the FormulaNode class, this method returns False. It overriden in the relationship node classes inherited from FormulaNode to return True.

nestedItemsPresent(self)

True if this formula node has arguments, that is, if it is not a leaf in the formula tree.

setEntity(self, entityId)

Resolve entityId into an Entity and set the entity as the formula node text binding entity.

Parameters:: entityId - Id of the entity which is used as the text binding entity of this formula node.
(type=string)

Instance Variable Details

arguments

The arguments (children) of this formula node. This list remains empty for leaves in the formula tree, that is, the EntityNodes.

Type:: list

entity

The Entity used as text binding for this formula node. In the rare cases when the formula node does not have a text binding, the entity is set to None.

Type:: Entity

Generated by Epydoc 2.0 on Tue Nov 21 15:32:22 2006

http://epydoc.sf.net