Class CopyOutletSaxHandlerFactory
java.lang.Object
org.apache.torque.generator.configuration.outlet.CopyOutletSaxHandlerFactory
- All Implemented Interfaces:
TypedOutletSaxHandlerFactory
Creates copy outlet SAX handlers.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateOutletForTemplate(String templatePath, ConfigurationProvider configurationProvider) Creates an outlet for a template with the given file name.final OutletSaxHandlergetOutletSaxHandler(QualifiedName outletName, ConfigurationProvider configurationProvider, UnitDescriptor unitDescriptor, ConfigurationHandlers configurationHandlers) Returns a JavaOutletSaxHandler for reading the configuration of Java outlets.Returns the filename extensions for templates which define outlets of this type.getType()Returns the outlet type which can be handled by the OutletSaxHandlers created by this factory.
-
Constructor Details
-
CopyOutletSaxHandlerFactory
public CopyOutletSaxHandlerFactory()
-
-
Method Details
-
getType
Returns the outlet type which can be handled by the OutletSaxHandlers created by this factory.- Specified by:
getTypein interfaceTypedOutletSaxHandlerFactory- Returns:
- "copyOutlet".
-
getTemplatesFilenameExtensionsForScan
Returns the filename extensions for templates which define outlets of this type. These extensions are used for scanning the templates tree.- Specified by:
getTemplatesFilenameExtensionsForScanin interfaceTypedOutletSaxHandlerFactory- Returns:
- the empty list, as this outlet type is not described by templates.
-
createOutletForTemplate
public Outlet createOutletForTemplate(String templatePath, ConfigurationProvider configurationProvider) Creates an outlet for a template with the given file name. This implementation throws a UnsupportedOperationException as java outlets are not template based.- Specified by:
createOutletForTemplatein interfaceTypedOutletSaxHandlerFactory- Parameters:
templatePath- the path to the template, relative to the templates directory, not null.configurationProvider- the configuration provider.- Returns:
- always throws an Exception
- Throws:
UnsupportedOperationException- always.
-
getOutletSaxHandler
public final OutletSaxHandler getOutletSaxHandler(QualifiedName outletName, ConfigurationProvider configurationProvider, UnitDescriptor unitDescriptor, ConfigurationHandlers configurationHandlers) throws SAXException Returns a JavaOutletSaxHandler for reading the configuration of Java outlets. This implementation uses the provided name as outlet name.- Specified by:
getOutletSaxHandlerin interfaceTypedOutletSaxHandlerFactory- 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.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.- Returns:
- a new JavaOutletSaxHandler.
- Throws:
SAXException- if the SAX Handler for the outlet can not be created from the given XML element.
-