flumotion.common.config.FlumotionConfigXML

Package flumotion :: Package common :: Module config :: Class FlumotionConfigXML

[show private | hide private]

Class FlumotionConfigXML

Loggable --+        
           |        
      Parser --+    
               |    
BaseConfigParser --+
                   |
                  FlumotionConfigXML

I represent a planet configuration file for Flumotion.

Method Summary
	`__init__(self, file)`
dictionary of /parent/name -> `ConfigEntryComponent`	`getComponentEntries(self)` Get all component entries from both atmosphere and all flows from the configuration.
	`parse(self, noRegistry)`
Inherited from BaseConfigParser
	`add(self, file)`
	`export(self)`
	`get_bool_values(self, nodes)`
	`get_float_values(self, nodes)`
	`get_fraction_values(self, nodes)`
	`get_int_values(self, nodes)`
	`get_long_values(self, nodes)`
	`get_raw_string_values(self, nodes)`
	`get_string_values(self, nodes)`
	`getPath(self)`
	`parsePlug(self, node)`
	`parsePlugs(self, node, sockets)`
	`parseProperties(self, node, properties, error)` Parse a <property>-containing node in a configuration XML file.
Inherited from Parser
	`checkAttributes(self, node, required, optional)` Checks that a given XML node has all of the required attributes, and no unknown attributes.
	`getRoot(self, file)` Return the root of the XML tree for the the string or filename passed as an argument.
tuple of string or None, as long as the combined length of the required and optional attributes.	`parseAttributes(self, node, required, optional)` Checks the validity of the attributes on an XML node, via Parser.checkAttributes, then parses them out and returns them all as a tuple.
	`parseFromTable(self, parent, parsers)` A data-driven verifying XML parser.
Inherited from Loggable
	`debug(self, *args)` Log a debug message.
dict	`doLog(self, level, where, format, args, *kwargs)` Log a message at the given level, with the possibility of going higher up in the stack.
	`error(self, *args)` Log an error.
	`info(self, *args)` Log an informational message.
	`log(self, *args)` Log a log message.
	`logFunction(self, *args)` Overridable log function.
	`logObjectName(self)` Overridable object name function.
	`warning(self, *args)` Log a warning.
	`warningFailure(self, failure, swallow)` Log a warning about a Failure.

Instance Variable Summary
	`atmosphere`: A `ConfigEntryAtmosphere`, filled in when parse() is called.
	`flows`: A list of `ConfigEntryFlow`, filled in when parse() is called.
	`manager`: A `ConfigEntryManager` containing options for the manager section, filled in at construction time.

Class Variable Summary
`str`	`logCategory`: Implementors can provide a category to log their messages under.
Inherited from Loggable
`Implements`	`__implemented__` = `<implementedBy flumotion.common.log.Lo...`
`ClassProvides`	`__providedBy__` = `<zope.interface.declarations.ClassProvi...`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`

Method Details

init(self, file)
(Constructor)

Parameters:: file - The file to parse, either as an open file object, or as the name of a file to open.
(type=str or file.)

Overrides:: flumotion.common.config.BaseConfigParser.__init__ (inherited documentation)

getComponentEntries(self)

Get all component entries from both atmosphere and all flows from the configuration.

Returns:: dictionary of /parent/name -> ConfigEntryComponent

Instance Variable Details

atmosphere

A ConfigEntryAtmosphere, filled in when parse() is called.

flows

A list of ConfigEntryFlow, filled in when parse() is called.

manager

A ConfigEntryManager containing options for the manager section, filled in at construction time.

Class Variable Details

logCategory

Implementors can provide a category to log their messages under.

Type:: str
Value:: 'config'

Generated by Epydoc 2.1 on Sun Oct 26 16:39:16 2008

http://epydoc.sf.net