Logo Search packages:      
Sourcecode: uimaj version File versions  Download package

Classes | Public Member Functions | Static Public Attributes

org::apache::uima::util::XMLParser Interface Reference

Inheritance diagram for org::apache::uima::util::XMLParser:
Inheritance graph
[legend]

List of all members.

Classes

class  ParsingOptions

Public Member Functions

void addMapping (String aElementName, String aClassName) throws ClassNotFoundException
XMLizable buildObject (Element aElement) throws InvalidXMLException
XMLizable buildObject (Element aElement, ParsingOptions aOptions) throws InvalidXMLException
Object buildObjectOrPrimitive (Element aElement, ParsingOptions aOptions) throws InvalidXMLException
void enableSchemaValidation (boolean aEnable)
SaxDeserializer newSaxDeserializer (ParsingOptions aOptions)
SaxDeserializer newSaxDeserializer ()
XMLizable parse (XMLInputSource aInput) throws InvalidXMLException
XMLizable parse (XMLInputSource aInput, String aNamespaceForSchema, URL aSchemaUrl) throws InvalidXMLException
XMLizable parse (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
XMLizable parse (XMLInputSource aInput, String aNamespaceForSchema, URL aSchemaUrl, ParsingOptions aOptions) throws InvalidXMLException
AnalysisEngineDescription parseAnalysisEngineDescription (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
AnalysisEngineDescription parseAnalysisEngineDescription (XMLInputSource aInput) throws InvalidXMLException
CasConsumerDescription parseCasConsumerDescription (XMLInputSource aInput) throws InvalidXMLException
CasConsumerDescription parseCasConsumerDescription (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
CasInitializerDescription parseCasInitializerDescription (XMLInputSource aInput) throws InvalidXMLException
CasInitializerDescription parseCasInitializerDescription (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
CollectionReaderDescription parseCollectionReaderDescription (XMLInputSource aInput) throws InvalidXMLException
CollectionReaderDescription parseCollectionReaderDescription (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
CpeDescription parseCpeDescription (XMLInputSource aInput) throws InvalidXMLException
CustomResourceSpecifier parseCustomResourceSpecifier (XMLInputSource aInput) throws InvalidXMLException
CustomResourceSpecifier parseCustomResourceSpecifier (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
FlowControllerDescription parseFlowControllerDescription (XMLInputSource aInput) throws InvalidXMLException
FlowControllerDescription parseFlowControllerDescription (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
FsIndexCollection parseFsIndexCollection (XMLInputSource aInput) throws InvalidXMLException
FsIndexCollection parseFsIndexCollection (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
IndexBuildSpecification parseIndexBuildSpecification (XMLInputSource aInput) throws InvalidXMLException
IndexBuildSpecification parseIndexBuildSpecification (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
PearSpecifier parsePearSpecifier (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
PearSpecifier parsePearSpecifier (XMLInputSource aInput) throws InvalidXMLException
ResourceManagerConfiguration parseResourceManagerConfiguration (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
ResourceManagerConfiguration parseResourceManagerConfiguration (XMLInputSource aInput) throws InvalidXMLException
ResourceMetaData parseResourceMetaData (XMLInputSource aInput) throws InvalidXMLException
ResourceMetaData parseResourceMetaData (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
ResourceSpecifier parseResourceSpecifier (XMLInputSource aInput) throws InvalidXMLException
ResourceSpecifier parseResourceSpecifier (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
ResultSpecification parseResultSpecification (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
ResultSpecification parseResultSpecification (XMLInputSource aInput) throws InvalidXMLException
TaeDescription parseTaeDescription (XMLInputSource aInput) throws InvalidXMLException
TaeDescription parseTaeDescription (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
TypePriorities parseTypePriorities (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
TypePriorities parseTypePriorities (XMLInputSource aInput) throws InvalidXMLException
TypeSystemDescription parseTypeSystemDescription (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
TypeSystemDescription parseTypeSystemDescription (XMLInputSource aInput) throws InvalidXMLException
URISpecifier parseURISpecifier (XMLInputSource aInput, ParsingOptions aOptions) throws InvalidXMLException
URISpecifier parseURISpecifier (XMLInputSource aInput) throws InvalidXMLException

Static Public Attributes

static final String RESOURCE_SPECIFIER_NAMESPACE = "http://uima.apache.org/resourceSpecifier"
static final String RESOURCE_SPECIFIER_SCHEMA_NAME = "/resourceSpecifierSchema.xsd"

Detailed Description

A UIMA XMLParser parses XML documents and generates UIMA components represented by the XML.

An application obtains a reference to the XMLParser by calling the org.apache.uima.UIMAFramework#getXMLParser() method. The application then uses the XMLParser by passing an InputStream to one of its parse methods - for example parseAnalysisEngineDescription(XMLInputSource) for parsing an AnalysisEngineDescription from its XML representation.

XML schema validation is off by default; it can be turned on by calling the method enableSchemaValidation(boolean).

UIMA developers who provide new types of XMLizable components must configure the XML parser by using the addMapping(String,String) method to specify mappings between XML Element names and the class names of the objects to be built from elements with those names. All objects to be built by the XML parser must implement XMLizable and provide an implementation of XMLizable#buildFromXMLElement(Element,XmlParserBak).

Note that we are considering replacing this ad-hoc XML data binding interface with the java standard extension JAXB. See http://java.sun.com/xml/jaxb for details on JAXB.

Definition at line 70 of file XMLParser.java.


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

Generated by  Doxygen 1.6.0   Back to index