EaseXML.Node.Node

Package EaseXML :: Module Node :: Class Node

[show private | hide private]

Type Node

object --+
         |
        Node

Known Subclasses:: ChoiceNode, CommentNode, ItemNode, ListNode, ProcessingInstructionNode, RawNode, TextNode

This is the base class for XMLObject's content. Each node has:

a type (string)
an itemType (string) : used by ListNode so that it remembers what kind of items it has to store.
a default value
a optional boolean switch
a noLimit boolean switch
a main boolean switch indicating wether the Node is main One of the XMLObject

For each of these properties, there are getters and setters.

xmlrepr is the method responsible of giving a string representing the node. User defined nodes should override it.
getValueFromDom is used to build a Node given its DOM tree.
checkType is responsible for node type checking during assignment. It returns True when assignment is legitim, False either.

Method Summary
	`__init__(self, main, itemType, default, optional, noLimit, name)`
	`checkType(self, val)` Type checking.
	`getDefaultValue(self)`
	`getItemType(self)`
	`getName(self)`
	`getParentType(self)`
	`getRegistry(self)`
	`getType(self)`
	`getValue(self)`
	`getValueFromDom(self, dom, attrName, **kw)`
	`isMain(self)`
	`isNoLimit(self)`
	`isOptional(self)`
	`resetValue(self)`
	`setDefaultValue(self, default)`
	`setItemType(self, type)`
	`setMain(self, m)`
	`setName(self, name)`
	`setNoLimit(self, val)`
	`setOptional(self, val)`
	`setParentType(self, parentType)`
	`setRegistry(self, reg)`
	`setType(self, type)`
	`setValue(self, value)`
	`xmlrepr(self, parentInstance)` XML representation of the Node
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__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)

Method Details

checkType(self, val)

Type checking.

val is object to check. If checkType returns False, a TypeError is raised to claim that Node value assignment is not valid. Either, checkType should return an optionally modified version of val (usefull when dealing with lists assignements where items should be XMLObject instances).

xmlrepr(self, parentInstance=None)

XML representation of the Node

Returns a string representing the Node as XML data.

Generated by Epydoc 2.1 on Sun Dec 12 17:20:24 2004

http://epydoc.sf.net