org.apache.tools.ant.taskdefs.optional.ejb

Class DescriptorHandler


public class DescriptorHandler
extends org.xml.sax.HandlerBase

Inner class used by EjbJar to facilitate the parsing of deployment descriptors and the capture of appropriate information. Extends HandlerBase so it only implements the methods needed. During parsing creates a hashtable consisting of entries mapping the name it should be inserted into an EJB jar as to a File representing the file on disk. This list can then be accessed through the getFiles() method.

Field Summary

protected String
currentElement
Instance variable used to store the name of the current element being processed by the SAX parser.
protected String
currentText
The text of the current element
protected Hashtable
ejbFiles
Instance variable that stores the names of the files as they will be put into the jar file, mapped to File objects Accessed by the SAX parser call-back method characters().
protected String
ejbName
Instance variable that stores the value found in the <ejb-name> element

Constructor Summary

DescriptorHandler(Task task, File srcDir)

Method Summary

void
characters(char[] ch, int start, int length)
SAX parser call-back method invoked whenever characters are located within an element.
void
endElement(String name)
SAX parser call-back method that is invoked when an element is exited.
String
getEjbName()
Getter method that returns the value of the <ejb-name> element.
Hashtable
getFiles()
Getter method that returns the set of files to include in the EJB jar.
String
getPublicId()
Get the publicId of the DTD
protected void
processElement()
void
registerDTD(String publicId, String location)
InputSource
resolveEntity(String publicId, String systemId)
void
startDocument()
SAX parser call-back method that is used to initialize the values of some instance variables to ensure safe operation.
void
startElement(String name, AttributeList attrs)
SAX parser call-back method that is invoked when a new element is entered into.

Field Details

currentElement

protected String currentElement
Instance variable used to store the name of the current element being processed by the SAX parser. Accessed by the SAX parser call-back methods startElement() and endElement().


currentText

protected String currentText
The text of the current element


ejbFiles

protected Hashtable ejbFiles
Instance variable that stores the names of the files as they will be put into the jar file, mapped to File objects Accessed by the SAX parser call-back method characters().


ejbName

protected String ejbName
Instance variable that stores the value found in the <ejb-name> element

Constructor Details

DescriptorHandler

public DescriptorHandler(Task task,
                         File srcDir)

Method Details

characters

public void characters(char[] ch,
                       int start,
                       int length)
            throws SAXException
SAX parser call-back method invoked whenever characters are located within an element. currentAttribute (modified by startElement and endElement) tells us whether we are in an interesting element (one of the up to four classes of an EJB). If so then converts the classname from the format org.apache.tools.ant.Parser to the convention for storing such a class, org/apache/tools/ant/Parser.class. This is then resolved into a file object under the srcdir which is stored in a Hashtable.

Parameters:
ch - A character array containing all the characters in the element, and maybe others that should be ignored.
start - An integer marking the position in the char array to start reading from.
length - An integer representing an offset into the char array where the current data terminates.


endElement

public void endElement(String name)
            throws SAXException
SAX parser call-back method that is invoked when an element is exited. Used to blank out (set to the empty string, not nullify) the name of the currentAttribute. A better method would be to use a stack as an instance variable, however since we are only interested in leaf-node data this is a simpler and workable solution.

Parameters:
name - The name of the attribute being exited. Ignored in this implementation.


getEjbName

public String getEjbName()
Getter method that returns the value of the <ejb-name> element.


getFiles

public Hashtable getFiles()
Getter method that returns the set of files to include in the EJB jar.


getPublicId

public String getPublicId()
Get the publicId of the DTD


processElement

protected void processElement()


registerDTD

public void registerDTD(String publicId,
                        String location)


resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
            throws SAXException


startDocument

public void startDocument()
            throws SAXException
SAX parser call-back method that is used to initialize the values of some instance variables to ensure safe operation.


startElement

public void startElement(String name,
                         AttributeList attrs)
            throws SAXException
SAX parser call-back method that is invoked when a new element is entered into. Used to store the context (attribute name) in the currentAttribute instance variable.

Parameters:
name - The name of the element being entered.
attrs - Attributes associated to the element.


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.