Package bar :: Module atlas_indexer :: Class barIndexerElement
[hide private]
[frames] | no frames]

Class barIndexerElement


Virtual class parental to classes representing CAF dataset index file elements.

Nested Classes [hide private]
Instance Methods [hide private]
 
getXMLelement(self)
Returns: dom XML object describing the object

Inherited from barIndexerObject: __init__

Inherited from base.barObject: __str__, getElementById, writeXMLtoFile

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Methods [hide private]
retClassName
fromXML(cls, sourceXMLElement, retClassName=None, indexer=None)
Creates object from its (valid) xml representation.
Static Methods [hide private]

Inherited from base.barObject (private): _getAttributesDict

Class Variables [hide private]
[str, ...] _elementAttributes = []
names of attributes of the XML element represented by class instances
str _elementName = None
name of the XML element represented by class instances
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

getXMLelement(self)

 

A stub of method. Raise NotImplementedError.

Returns:
dom XML object describing the object
Overrides: base.barObject.getXMLelement

fromXML(cls, sourceXMLElement, retClassName=None, indexer=None)
Class Method

 

Creates object from its (valid) xml representation.

Parameters:
  • sourceXMLElement (xml.dom.Node) - XML description of the barIndexer object to be created
  • retClassName (class) - class of the object to be created
  • indexer (barIndexer) - the object encapsulating returned class instance
Returns: retClassName
object based on sourceXMLElement description (initiation of the object might be unfinished)
Overrides: barIndexerObject.fromXML

Note: method designed to be utilized only by methods overriding it in derived classes