Modeling.Join.Join

Package Modeling :: Module Join :: Class Join

[show private | hide private]

Class Join

XMLCapability --+
                |
               Join

Describe a join

Method Summary
	`__init__(self, aSrcAttribute, aDestAttribute)` Initializes a join.
	`__eq__(self, aJoin)` Tests two joins for equality
	`destinationAttribute(self)` Returns the destination attribute referenced by the join
	`destinationAttributeIdentifier(self)` Returns the destination attribute's string identifier referenced by the join.
	`destinationAttributeName(self)` Returns the destination attribute's name See also: destinationAttribute, destinationAttributeIdentifier
	`getXMLDOM(self, doc, parentNode, encoding)` Returns the (DOM) DocumentObject for the receiver.
	`initWithXMLDOMNode(self, aNode, encoding)` Cannot be called: initialization from XML is made by relationships.
	`isReciprocicalToJoin(self, aJoin)` Tells whether the supplied join is reciprocical to the receiver.
	`sourceAttribute(self)` Returns the source attribute referenced by the join
	`sourceAttributeIdentifier(self)` Returns the source attribute's string identifier referenced by the join.
	`sourceAttributeName(self)` Returns the source attribute's name See also: sourceAttribute, sourceAttributeIdentifier
	`validateObject(self, aJoin)` Checks whether the supplied object is valid
	`xmlAttributesDict(self)` .
Inherited from XMLCapability
	`getXMLNodeName(self)` Returns the node name corresponding to the receiver
	`xmlAttributeType(self, attributeName)`
	`xmlGetAttribute(self, attributeName)`
	`xmlSetAttribute(self, attributeName)`

Method Details

init(self, aSrcAttribute, aDestAttribute)
(Constructor)

Initializes a join.

eq(self, aJoin)
(Equality operator)

Tests two joins for equality

destinationAttribute(self)

Returns the destination attribute referenced by the join

destinationAttributeIdentifier(self)

Returns the destination attribute's string identifier referenced by the join. See also: Attribute.__str__

destinationAttributeName(self)

Returns the destination attribute's name See also: destinationAttribute, destinationAttributeIdentifier

getXMLDOM(self, doc=None, parentNode=None, encoding='iso-8859-1')

Returns the (DOM) DocumentObject for the receiver.

Parameters 'doc' and 'parentDoc' should be both omitted or supplied. If they are omitted, a new DocumentObject is created. If they are supplied, elements are added to the parentNode.

Returns: the (possibly new) DocumentObject.

Overrides:: Modeling.XMLutils.XMLCapability.getXMLDOM

initWithXMLDOMNode(self, aNode, encoding='iso-8859-1')

Cannot be called: initialization from XML is made by relationships. Raises NotImplementedError.

isReciprocicalToJoin(self, aJoin)

Tells whether the supplied join is reciprocical to the receiver. Two joins are reciprocical iff aJoin's source (resp. destination) is equal to the receiver's destination (resp. source). Returns integer '1' for true, '0' for false

sourceAttribute(self)

Returns the source attribute referenced by the join

sourceAttributeIdentifier(self)

Returns the source attribute's string identifier referenced by the join. See also: Attribute.__str__

sourceAttributeName(self)

Returns the source attribute's name See also: sourceAttribute, sourceAttributeIdentifier

validateObject(self, aJoin)

Checks whether the supplied object is valid

xmlAttributesDict(self)

Overrides:: Modeling.XMLutils.XMLCapability.xmlAttributesDict

Generated by Epydoc 2.1 on Sat Mar 4 13:36:23 2006

http://epydoc.sf.net