XmlParser (tutorials-common 0.0.1-SNAPSHOT API)

java.lang.Object
- bradleyross.common.XmlParser

```
public class XmlParser
extends Object
```
The purpose of this class is to provide a set of tools for parsing XML documents.
When you create a class for parsing XML files, it is necessary to create a subclass of org.xml.sax.ContentHandler for a content handler object. The XML parser calls methods in this class when various events occur while reading the XML files. Events would be such things as the start or end of a tagged element.

In order to use this class, this class it is necessary to have xercesImpl.jar and xml-apis.jar from the Apache Xerces project in the CLASSPATH.

There are two sets of source code for this class, one for versions previous to Java 5 and the other for Java 5 and later.

When constructing code using Vector classes, it is necessary to code differently for Java 5 and later versions because version 5 introduced the idea of parameterizing Vector objects.
- For Java 5 and later, you will see the syntax Vector<String>. This means objects making up the Vector are all of type String.
- For versions before Java 5, the syntax is simply Vector. This is because there is no method in the earlier versions of restricting Vectors and other list to a single class.
The following is an example of a file to be processed by this object.

<html><head></head>
<body>aaaa</body></html>
Author:

Bradley Ross

See Also:

getTags, parseFile, ContentHandler

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class XmlParser.MyHandler
This class provides the means of responding to the Xerces parser from the Apache Xerces parser.

Nested Classes
Modifier and Type	Class and Description
`protected class`	`XmlParser.MyHandler` This class provides the means of responding to the Xerces parser from the Apache Xerces parser.

Field Summary

Fields
Modifier and Type Field and Description

static int LISTTAGS
Option for listing tags in document.

static int SEARCH
Option for searching for strings with specified tags.

Fields
Modifier and Type	Field and Description
`static int`	`LISTTAGS` Option for listing tags in document.
`static int`	`SEARCH` Option for searching for strings with specified tags.

Constructor Summary

Constructors
Constructor and Description

XmlParser()

Constructors
Constructor and Description
`XmlParser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getMode()` Getter for mode
`Vector<String>`	`listTags(File document)` This method lists tags contained in an XML document.
`Vector<String>`	`listTags(String document)` List strings contained in document.
`Vector<String>`	`listTags(Vector<String> start, File document)` This method lists tags contained in an XML document.
`Vector<String>`	`listTags(Vector<String> start, String document)` List tags contained in an XML document.
`Vector<String>`	`parseString(File document, String search)` This method parses an XML document for strings
`Vector<String>`	`parseString(String document, String search)` This method parses an XML document for strings
`Vector<String>`	`parseString(Vector<String> start, File document, String search)` This method parses an XML document for strings
`Vector<String>`	`parseString(Vector<String> start, String document, String search)` This method parses an XML document for strings
`void`	`setDebugLevel(int level)` Determine amount of diagnostic output.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LISTTAGS
```
public static final int LISTTAGS
```
    Option for listing tags in document.
    
    See Also:
    
    Constant Field Values
  - SEARCH
```
public static final int SEARCH
```
    Option for searching for strings with specified tags.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XmlParser
```
public XmlParser()
```
- Method Detail
  - getMode
```
public int getMode()
```
    Getter for mode
    
    Returns:
    
    mode value
  - setDebugLevel
```
public void setDebugLevel(int level)
```
    Determine amount of diagnostic output.
    
    Parameters:
    
    level - Amount of diagnostic material to be printed. 0 is default and results in no diagnostic messages. Higher values produce more diagnostic messages.
  - parseString
```
public Vector<String> parseString(Vector<String> start,
                                  String document,
                                  String search)
```
    This method parses an XML document for strings
    
    Parameters:
    
    start - Initial Vector of String objects
    
    document - This string contains the document to be parsed
    
    search - This string indicates the set of tags to be searched for. If the value is <Envelope><Body><FetchHandle>, the program will return the contents of all FetchHandle tags which are within Body tags which are within Envelope tags.
    
    Returns:
    
    Vector of String objects that contains all of the objects from the initial list plus the items found in document.
  - parseString
```
public Vector<String> parseString(String document,
                                  String search)
```
    This method parses an XML document for strings
    
    Parameters:
    
    document - This string contains the document to be parsed
    
    search - This string indicates the set of tags to be searched for. If the value is <Envelope><Body><FetchHandle>, the program will return the contents of all FetchHandle tags which are within Body tags which are within Envelope tags.
    
    Returns:
    
    Vector of String objects that contains all of the objects found in document.
  - parseString
```
public Vector<String> parseString(File document,
                                  String search)
```
    This method parses an XML document for strings
    
    Parameters:
    
    document - This string contains the File object representing the file to be parsed.
    
    search - This string indicates the set of tags to be searched for. If the value is <Envelope><Body><FetchHandle>, the program will return the contents of all FetchHandle tags which are within Body tags which are within Envelope tags.
    
    Returns:
    
    Vector of String objects that contains all of the objects found in document.
  - parseString
```
public Vector<String> parseString(Vector<String> start,
                                  File document,
                                  String search)
```
    This method parses an XML document for strings
    
    Parameters:
    
    start - Vector containing the String objects at the start executing the method
    
    document - This string is the File object to be parsed
    
    search - This string indicates the set of tags to be searched for. If the value is <Envelope><Body><FetchHandle>, the program will return the contents of all FetchHandle tags which are within Body tags which are within Envelope tags.
    
    Returns:
    
    Vector of String objects that contains all of the objects found in document.
  - listTags
```
public Vector<String> listTags(Vector<String> start,
                               String document)
```
    List tags contained in an XML document.
    This method returns a Vector containing String objects.
    
    Each String object contains a sequence of tags found in the document.
    
    Parameters:
    
    start - Initial vector of String objects to which items are to be appended.
    
    document - Document to be parsed.
    
    Returns:
    
    Vector of String objects containing list of tag combinations
  - listTags
```
public Vector<String> listTags(String document)
```
    List strings contained in document. This method returns a Vector containing String objects. Each String object contains a sequence of tags found in the document.
    
    Parameters:
    
    document - Document to be parsed.
    
    Returns:
    
    Vector of String objects containing list of tag combinations.
  - listTags
```
public Vector<String> listTags(File document)
```
    This method lists tags contained in an XML document.
    
    Parameters:
    
    document - This string contains the File object representing the file to be parsed.
    
    Returns:
    
    Vector of String objects that contains a listing of the tags in the document
  - listTags
```
public Vector<String> listTags(Vector<String> start,
                               File document)
```
    This method lists tags contained in an XML document.
    
    Parameters:
    
    start - Vector containing the String objects at the start executing the method
    
    document - Object containing the file to be parsed
    
    Returns:
    
    Vector of String objects that contains all of the tags found in the document.

Class XmlParser

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LISTTAGS

SEARCH

Constructor Detail

XmlParser

Method Detail

getMode

setDebugLevel

parseString

parseString

parseString

parseString

listTags

listTags

listTags

listTags