cmsHarvester.DBSXMLHandler Class Reference

Helper class: DBSXMLHandler. More...

Inheritance diagram for cmsHarvester.DBSXMLHandler:

Public Member Functions
def	__init__ (self, tag_names)
def	characters (self, content)
def	check_results_validity (self)
def	current_element (self)
def	endElement (self, name)
def	startElement (self, name, attrs)

Public Attributes
	current_value
	element_position
	results
	tag_names

Static Public Attributes
	mapping

Detailed Description

Helper class: DBSXMLHandler.

XML handler class to parse DBS results.

The tricky thing here is that older DBS versions (2.0.5 and
earlier) return results in a different XML format than newer
versions. Previously the result values were returned as attributes
to the `result' element. The new approach returns result values as
contents of named elements.

The old approach is handled directly in startElement(), the new
approach in characters().

NOTE: All results are returned in the form of string values of
      course!

Definition at line 187 of file cmsHarvester.py.

Constructor & Destructor Documentation

__init__()

def cmsHarvester.DBSXMLHandler.__init__	(		self,
			tag_names
	)

Definition at line 220 of file cmsHarvester.py.

    def __init__(self, tag_names):
        # This is a list used as stack to keep track of where we are
        # in the element tree.
        self.element_position = []
        self.tag_names = tag_names
        self.results = {}

Member Function Documentation

characters()

def cmsHarvester.DBSXMLHandler.characters	(		self,
			content
	)

Definition at line 259 of file cmsHarvester.py.

References mps_setup.append, cmsHarvester.DBSXMLHandler.current_element(), cmsHarvester.DBSXMLHandler.current_value, and cmsHarvester.DBSXMLHandler.tag_names.

    def characters(self, content):
        # NOTE: It is possible that the actual contents of the tag
        # gets split into multiple pieces. This method will be called
        # for each of the pieces. This means we have to concatenate
        # everything ourselves.
        if self.current_element() in self.tag_names:
            self.current_value.append(content)

check_results_validity()

def cmsHarvester.DBSXMLHandler.check_results_validity

(

self

)

Make sure that all results arrays have equal length.

We should have received complete rows from DBS. I.e. all
results arrays in the handler should be of equal length.

Definition at line 270 of file cmsHarvester.py.

References relativeConstraints.keys, and cmsHarvester.DBSXMLHandler.results.

    def check_results_validity(self):
        """Make sure that all results arrays have equal length.

        We should have received complete rows from DBS. I.e. all
        results arrays in the handler should be of equal length.

        """

        results_valid = True

        res_names = self.results.keys()
        if len(res_names) > 1:
            for res_name in res_names[1:]:
                res_tmp = self.results[res_name]
                if len(res_tmp) != len(self.results[res_names[0]]):
                    results_valid = False

        return results_valid

current_element()

def cmsHarvester.DBSXMLHandler.current_element

(

self

)

Definition at line 267 of file cmsHarvester.py.

References cmsHarvester.DBSXMLHandler.element_position.

Referenced by cmsHarvester.DBSXMLHandler.characters(), and cmsHarvester.DBSXMLHandler.endElement().

    def current_element(self):
        return self.element_position[-1]

endElement()

def cmsHarvester.DBSXMLHandler.endElement	(		self,
			name
	)

Definition at line 246 of file cmsHarvester.py.

References mps_setup.append, cmsHarvester.DBSXMLHandler.current_element(), cmsHarvester.DBSXMLHandler.current_value, cmsHarvester.DBSXMLHandler.element_position, join(), cmsHarvester.DBSXMLHandler.results, and cmsHarvester.DBSXMLHandler.tag_names.

    def endElement(self, name):
        assert self.current_element() == name, \
               "closing unopenend element `%s'" % name

        if self.current_element() in self.tag_names:
            contents = "".join(self.current_value)
            if self.current_element() in self.results:
                self.results[self.current_element()].append(contents)
            else:
                self.results[self.current_element()] = [contents]

        self.element_position.pop()

startElement()

def cmsHarvester.DBSXMLHandler.startElement	(		self,
			name,
			attrs
	)

Definition at line 227 of file cmsHarvester.py.

References mps_setup.append, and cmsHarvester.DBSXMLHandler.element_position.

    def startElement(self, name, attrs):
        self.element_position.append(name)

        self.current_value = []

        #----------

        # This is to catch results from DBS 2.0.5 and earlier.
        if name == "result":
            for name in self.tag_names:
                key = DBSXMLHandler.mapping[name]
                value = str(attrs[key])
                try:
                    self.results[name].append(value)
                except KeyError:
                    self.results[name] = [value]

        #----------

Member Data Documentation

current_value

cmsHarvester.DBSXMLHandler.current_value

Definition at line 230 of file cmsHarvester.py.

Referenced by cmsHarvester.DBSXMLHandler.characters(), and cmsHarvester.DBSXMLHandler.endElement().

element_position

cmsHarvester.DBSXMLHandler.element_position

Definition at line 223 of file cmsHarvester.py.

Referenced by cmsHarvester.DBSXMLHandler.current_element(), cmsHarvester.DBSXMLHandler.endElement(), and cmsHarvester.DBSXMLHandler.startElement().

mapping

cmsHarvester.DBSXMLHandler.mapping

static

Definition at line 208 of file cmsHarvester.py.

Referenced by progressbar.FormatLabel.update().

results

cmsHarvester.DBSXMLHandler.results

Definition at line 225 of file cmsHarvester.py.

Referenced by cmsHarvester.DBSXMLHandler.check_results_validity(), and cmsHarvester.DBSXMLHandler.endElement().

tag_names

cmsHarvester.DBSXMLHandler.tag_names

Definition at line 224 of file cmsHarvester.py.

Referenced by cmsHarvester.DBSXMLHandler.characters(), and cmsHarvester.DBSXMLHandler.endElement().