Class OutletConfigurationSaxHandler
java.lang.Object
org.xml.sax.helpers.DefaultHandler
org.apache.torque.generator.configuration.outlet.OutletConfigurationSaxHandler
- All Implemented Interfaces:
ContentHandler,DTDHandler,EntityResolver,ErrorHandler
A SAX handler which parses Outlet configuration files.
Relies on delegate handlers for parsing the configuration for
the different outlet types.
-
Constructor Summary
ConstructorsConstructorDescriptionOutletConfigurationSaxHandler(ConfigurationProvider configurationProvider, UnitDescriptor unitDescriptor, ConfigurationHandlers configurationHandlers) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoidcharacters(char[] ch, int start, int length) voidendElement(String uri, String localName, String rawName) voiderror(SAXParseException exception) voidfatalError(SAXParseException exception) Returns all mergepoint mappings which were configured outside the outlets in the parsed outlet configuration file.getOutletHandler(QualifiedName outletName, String outletType) Returns the correct handler for a outlet tag.Returns all outlets which were configured in the parsed outlet configuration file.static StringgetOutletType(Attributes attributes) Reads the outlet type from the attributes of the outlet XML tag.resolveEntity(String publicId, String systemId) EntityResolver implementation.voidstartElement(String uri, String localName, String qName, Attributes attributes) voidwarning(SAXParseException exception) Methods inherited from class org.xml.sax.helpers.DefaultHandler
endDocument, endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDeclMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.xml.sax.ContentHandler
declaration
-
Constructor Details
-
OutletConfigurationSaxHandler
public OutletConfigurationSaxHandler(ConfigurationProvider configurationProvider, UnitDescriptor unitDescriptor, ConfigurationHandlers configurationHandlers) Constructor.- Parameters:
configurationProvider- The access object for the configuration files, not null.unitDescriptor- The description of the generation unit, not null.configurationHandlers- The available configuration handlers, not null.- Throws:
NullPointerException- if an argument is null.
-
-
Method Details
-
getOutlets
Returns all outlets which were configured in the parsed outlet configuration file.- Returns:
- all created outlets, not null.
-
getMergepointMappings
Returns all mergepoint mappings which were configured outside the outlets in the parsed outlet configuration file.- Returns:
- all created mergepoint mappings, not null.
-
startElement
public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException - Specified by:
startElementin interfaceContentHandler- Overrides:
startElementin classDefaultHandler- Throws:
SAXException
-
endElement
- Specified by:
endElementin interfaceContentHandler- Overrides:
endElementin classDefaultHandler- Throws:
SAXException
-
characters
- Specified by:
charactersin interfaceContentHandler- Overrides:
charactersin classDefaultHandler- Throws:
SAXException
-
getOutletHandler
public OutletSaxHandler getOutletHandler(QualifiedName outletName, String outletType) throws SAXException Returns the correct handler for a outlet tag. The method uses the type attribute to determine which handler is needed. I.e. it looks up the handler factory type in the outlet types, and asks the factory for a handler.- Parameters:
outletName- the name for the outlet which configuration will be read in by the generated SaxHandlerFactory, or null if the name of the outlet should be determined from the parsed XML.outletType- the type of the outlet, not null.- Returns:
- the handler for the tag, not null.
- Throws:
SAXException- if no matching handler can be identified, or if an error occurs while creating the handler.
-
getOutletType
Reads the outlet type from the attributes of the outlet XML tag.- Parameters:
attributes- the attributes of the XML tag, not null.- Returns:
- the outlet type, not null.
- Throws:
SAXException- if the xsi:type attribute is not set.
-
resolveEntity
EntityResolver implementation. Called by the XML parser- Specified by:
resolveEntityin interfaceEntityResolver- Overrides:
resolveEntityin classDefaultHandler- Parameters:
publicId- The public identifier of the external entity.systemId- The system identifier of the external entity.- Returns:
- an InputSource for the entity, or null if the URI is not known.
- Throws:
SAXExceptionIOException- See Also:
-
error
- Specified by:
errorin interfaceErrorHandler- Overrides:
errorin classDefaultHandler- Throws:
SAXParseException
-
fatalError
- Specified by:
fatalErrorin interfaceErrorHandler- Overrides:
fatalErrorin classDefaultHandler- Throws:
SAXParseException
-
warning
- Specified by:
warningin interfaceErrorHandler- Overrides:
warningin classDefaultHandler- Throws:
SAXParseException
-