Overview   Class List   Class Hierarchy   Class Members   Functions & Constants   Defines   Header Files  

uima::XMLParser Class Reference

Inherited by uima::TextAnalysisEngineSpecifierBuilder.

List of all members.


Detailed Description

A UIMA XMLParser parses XML documents and generates UIMA component descriptor object represented in the XML.

Public Member Functions

 XMLParser ()
 ~XMLParser ()
void setErrorHandler (ErrorHandler *)
void parseAnalysisEngineDescription (AnalysisEngineDescription &aeDesc, char const *fileName)
 Enables or disables XML scheam validation.
void parseAnalysisEngineDescription (AnalysisEngineDescription &aeDesc, icu::UnicodeString const &fileName)
 Parses an AnalysisEngineDescription from an XML file.
void parseAnalysisEngineDescription (AnalysisEngineDescription &aeDesc, InputSource const &crInputSource)
 Parses an AnalysisEngineDescription from an XML input stream.
void parseTypeSystemDescription (TypeSystemDescription &aeDesc, InputSource const &crInputSource)
 Parses an TypeSystemDescription from an XML input stream.
void parseFSIndexDescription (AnalysisEngineMetaData::TyVecpFSIndexDescriptions &fsDesc, InputSource const &crInputSource)
 Parses an FSIndexDescriptions from an XML input stream.
void parseTypePriorities (AnalysisEngineMetaData::TyVecpTypePriorities &prioDesc, InputSource const &crInputSource)
 Parses an TypePriorities from an XML input stream.
void parseSofaMappings (AnalysisEngineDescription::TyVecpSofaMappings &sofaMapDesc, InputSource const &crInputSource)
 Parses an SofaMappings from an XML input stream.
OperationalPropertiesbuildOperationalProperties (DOMElement *descElem)

Protected Member Functions

void buildAnalysisEngineDescription (AnalysisEngineDescription &taeSpec, DOMElement *specElem, const icu::UnicodeString &xmlFileLoc)
void buildTypePriorities (AnalysisEngineMetaData::TyVecpTypePriorities &typePriorities, DOMElement *specElem)
void buildTypePriorities (AnalysisEngineMetaData &aeMetaData, DOMElement *specElem, icu::UnicodeString const &lastFileName, std::vector< icu::UnicodeString > &alreadyImported)
void buildFSIndexes (AnalysisEngineMetaData &aeDesc, DOMElement *specElem)
void buildFSIndexes (AnalysisEngineMetaData::TyVecpFSIndexDescriptions &desc, DOMElement *specElem)
void buildSofaMappings (AnalysisEngineDescription &taeSpec, DOMElement *specElem)
void buildSofaMappings (AnalysisEngineDescription::TyVecpSofaMappings &sofaMappings, DOMElement *specElem)
void buildConfigParams (AnalysisEngineMetaData &aeMetaData, DOMElement *specElem)
void buildConfigParamSettings (AnalysisEngineMetaData &aeMetaData, DOMElement *specElem)

Constructor & Destructor Documentation

uima::XMLParser::XMLParser (  ) 

uima::XMLParser::~XMLParser (  ) 


Member Function Documentation

void uima::XMLParser::setErrorHandler ( ErrorHandler *   ) 

void uima::XMLParser::parseAnalysisEngineDescription ( AnalysisEngineDescription aeDesc,
char const *  fileName 
)

Enables or disables XML scheam validation.

Parameters:
aEnable true to enable validation, false to disable validation Parses an AnalysisEngineDescription from an XML file.
aeDesc reference to AnalysisEngineDescription object
fileName char buffer file containing the XML document to be parsed.
Exceptions:
InvalidXMLException if the input XML is not valid or does not specify a valid AnalysisEngineDescription

void uima::XMLParser::parseAnalysisEngineDescription ( AnalysisEngineDescription aeDesc,
icu::UnicodeString const &  fileName 
)

Parses an AnalysisEngineDescription from an XML file.

Parameters:
aeDesc reference to AnalysisEngineDescription object
fileName UnicodeStrin object containing the file name of the file cotaining the XML document.
Exceptions:
InvalidXMLException if the input XML is not valid or does not specify a valid AnalysisEngineDescription

void uima::XMLParser::parseAnalysisEngineDescription ( AnalysisEngineDescription aeDesc,
InputSource const &  crInputSource 
)

Parses an AnalysisEngineDescription from an XML input stream.

Parameters:
aeDesc reference to AnalysisEngineDescription object.
crInputSource the input source from which to read the XML document.
Exceptions:
InvalidXMLException if the input XML is not valid or does not specify a valid AnalysisEngineDescription

void uima::XMLParser::parseTypeSystemDescription ( TypeSystemDescription aeDesc,
InputSource const &  crInputSource 
)

Parses an TypeSystemDescription from an XML input stream.

Parameters:
aeDesc reference to TypeSystemDescription object.
crInputSource the input source from which to read the XML document.
Exceptions:
InvalidXMLException if the input XML is not valid or does not specify a valid AnalysisEngineDescription

void uima::XMLParser::parseFSIndexDescription ( AnalysisEngineMetaData::TyVecpFSIndexDescriptions fsDesc,
InputSource const &  crInputSource 
)

Parses an FSIndexDescriptions from an XML input stream.

Caller assumes ownership of objects in the vector.

Parameters:
fsDesc reference to TyVecpFSIndexDescriptions object.
crInputSource the input source from which to read the XML document.
Exceptions:
InvalidXMLException if the input XML is not valid or does not specify a valid AnalysisEngineDescription

void uima::XMLParser::parseTypePriorities ( AnalysisEngineMetaData::TyVecpTypePriorities prioDesc,
InputSource const &  crInputSource 
)

Parses an TypePriorities from an XML input stream.

Caller assumes ownership of objects in the vector.

Parameters:
prioDesc reference to TyVecpTypePriorities object.
crInputSource the input source from which to read the XML document.
Exceptions:
InvalidXMLException if the input XML is not valid or does not specify a valid AnalysisEngineDescription

void uima::XMLParser::parseSofaMappings ( AnalysisEngineDescription::TyVecpSofaMappings sofaMapDesc,
InputSource const &  crInputSource 
)

Parses an SofaMappings from an XML input stream.

Caller assumes ownership of objects in the vector.

Parameters:
sofaMapDesc reference to TyVecpTypePriorities object.
crInputSource the input source from which to read the XML document.
Exceptions:
InvalidXMLException if the input XML is not valid or does not specify a valid AnalysisEngineDescription

OperationalProperties* uima::XMLParser::buildOperationalProperties ( DOMElement *  descElem  ) 

void uima::XMLParser::buildAnalysisEngineDescription ( AnalysisEngineDescription taeSpec,
DOMElement *  specElem,
const icu::UnicodeString &  xmlFileLoc 
) [protected]

void uima::XMLParser::buildTypePriorities ( AnalysisEngineMetaData::TyVecpTypePriorities typePriorities,
DOMElement *  specElem 
) [protected]

void uima::XMLParser::buildTypePriorities ( AnalysisEngineMetaData aeMetaData,
DOMElement *  specElem,
icu::UnicodeString const &  lastFileName,
std::vector< icu::UnicodeString > &  alreadyImported 
) [protected]

void uima::XMLParser::buildFSIndexes ( AnalysisEngineMetaData aeDesc,
DOMElement *  specElem 
) [protected]

void uima::XMLParser::buildFSIndexes ( AnalysisEngineMetaData::TyVecpFSIndexDescriptions desc,
DOMElement *  specElem 
) [protected]

void uima::XMLParser::buildSofaMappings ( AnalysisEngineDescription taeSpec,
DOMElement *  specElem 
) [protected]

void uima::XMLParser::buildSofaMappings ( AnalysisEngineDescription::TyVecpSofaMappings sofaMappings,
DOMElement *  specElem 
) [protected]

void uima::XMLParser::buildConfigParams ( AnalysisEngineMetaData aeMetaData,
DOMElement *  specElem 
) [protected]

void uima::XMLParser::buildConfigParamSettings ( AnalysisEngineMetaData aeMetaData,
DOMElement *  specElem 
) [protected]


The documentation for this class was generated from the following file:

Generated on Mon Oct 1 11:15:08 2012 for UIMACPP API by  doxygen 1.5.6