| Home | Trees | Indices | Help | 
 | 
|---|
|  | 
object --+
         |
        LocalConfig
Class representing this extension's configuration document.
This is not a general-purpose configuration object like the main Cedar
  Backup configuration object.  Instead, it just knows how to parse and 
  emit Mbox-specific configuration values.  Third parties who need to read 
  and write configuration related to this extension should access it 
  through the constructor, validate and addConfig
  methods.
Note: Lists within this class are "unordered" for equality comparisons.
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| Inherited from  | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| mbox Mbox configuration in terms of a MboxConfigobject. | |||
| Inherited from  | |||
| 
 | |||
| 
 Initializes a configuration object. If you initialize the object without passing either 
   No reference to the original XML data or original path is saved off by this class. Once the data has been parsed (successfully or not) this original information is discarded. Unless the  
 Note:
        It is strongly suggested that the  | 
| 
 Official string representation for class instance. 
 | 
| 
 Informal string representation for class instance. 
 | 
| 
 Definition of equals operator for this class. Lists within this class are "unordered" for equality comparisons. 
 | 
| 
 Validates configuration represented by the object. Mbox configuration must be filled in. Within that, the collect mode and compress mode are both optional, but the list of repositories must contain at least one entry. Each configured file or directory must contain an absolute path, and 
  then must be either able to take collect mode and compress mode 
  configuration from the parent  
 | 
| 
 Adds an <mbox> configuration section as the next child of a parent. Third parties should use this function to write configuration related to this extension. We add the following fields to the document: collectMode //cb_config/mbox/collectMode compressMode //cb_config/mbox/compressMode We also add groups of the following items, one list element per item: mboxFiles //cb_config/mbox/file mboxDirs //cb_config/mbox/dir The mbox files and mbox directories are added by _addMboxFile and _addMboxDir. 
 | 
| 
 Property target used to set the mbox configuration value. If not 
   
 | 
| 
 Internal method to parse an XML string into the object. This method parses the XML document into a DOM tree 
  ( 
 | 
| 
 Parses an mbox configuration section. We read the following individual fields: collectMode //cb_config/mbox/collect_mode compressMode //cb_config/mbox/compress_mode We also read groups of the following item, one list element per item: mboxFiles //cb_config/mbox/file mboxDirs //cb_config/mbox/dir The mbox files are parsed by _parseMboxFiles and the mbox directories are parsed by _parseMboxDirs. 
 | 
| 
 Reads a list of  We read the following individual fields: absolutePath abs_path collectMode collect_mode compressMode compess_mode 
 | 
| 
 Reads a list of  We read the following individual fields: absolutePath abs_path collectMode collect_mode compressMode compess_mode We also read groups of the following items, one list element per item: relativeExcludePaths exclude/rel_path excludePatterns exclude/pattern The exclusions are parsed by _parseExclusions. 
 | 
| 
 Reads exclusions data from immediately beneath the parent. We read groups of the following items, one list element per item: relative exclude/rel_path patterns exclude/pattern If there are none of some pattern (i.e. no relative path items) then 
   
 | 
| 
 Adds an mbox file container as the next child of a parent. We add the following fields to the document: absolutePath file/abs_path collectMode file/collect_mode compressMode file/compress_mode The <file> node itself is created as the next child of the 
  parent node. This method only adds one mbox file node.  The parent must 
  loop for each mbox file in the  If  
 | 
| 
 Adds an mbox directory container as the next child of a parent. We add the following fields to the document: absolutePath dir/abs_path collectMode dir/collect_mode compressMode dir/compress_mode We also add groups of the following items, one list element per item: relativeExcludePaths dir/exclude/rel_path excludePatterns dir/exclude/pattern The <dir> node itself is created as the next child of the parent
  node. This method only adds one mbox directory node.  The parent must 
  loop for each mbox directory in the  If  
 | 
| 
 | |||
| mboxMbox configuration in terms of a  | 
| Home | Trees | Indices | Help | 
 | 
|---|
| Generated by Epydoc 3.0.1 | http://epydoc.sourceforge.net |