PREVIEW SERVICE

The PREVIEW SERVICE of DATA FORMATS ANALYZER is implemented in the DfaPreviewer.py file as a DfaPreviewer module class.

Public Interface

class DfaPreviewer.PreviewService(verbosity='IWE', filepath=None, version=None, refName=None, refVersion=None)

Provides methods to generate the updated preview from XML data files.

Concepts data are stored in the extractedConceptsdictionary with the following structure:

DICTIONARY{
    Concept name (STRING):DICTIONARY{
        attributes (STRING):LIST[Attribute name (STRING)],
        elements (STRING):LIST[Element name (STRING)],
        types (STRING):LIST[Type name (STRING)]
    }
}

Descriptions data are stored in the extractedDescriptionsdictionary with the following structure:

DICTIONARY{
    attributes (STRING):DICTIONARY{Attribute name (STRING): Attribute documentation (STRING)},
    elements (STRING):DICTIONARY{Element name (STRING): Element documentation (STRING)},
    types (STRING):DICTIONARY{Type name (STRING): Type documentation (STRING)}
}

Parameters:

  • verbosity: The string specifying verbosity. See details in INIT SERVICE.
  • filepath: The string specifying the full path to XML data files, which will be parsed.
  • version: The string specifying the output version. See details in INIT SERVICE.
  • refName: The string specifying the reference name. See details in INIT SERVICE.
  • refVersion: The string specifying the reference version. See details in INIT SERVICE.
previewData()

Generates the updated preview from XML data files.

Private Methods

PreviewService._loadData()

Loads data from XML data files.

PreviewService._updateData()

Updates the preview using data loaded from XML data files.

Table Of Contents

Previous topic

OUTPUT SERVICE