net.sourceforge.groboutils.pmti.v1.autodoc.v1.xml
Class XMLFileParserGenerator

java.lang.Object
  extended bynet.sourceforge.groboutils.pmti.v1.autodoc.v1.xml.XMLFileParserGenerator
All Implemented Interfaces:
IParserGenerator

public class XMLFileParserGenerator
extends java.lang.Object
implements IParserGenerator

Parses the directory or directories containing the output of XMLFileServer into individual IParsers, one for each file.

Since:
March 17, 2002
Version:
$Date: 2003/02/10 22:51:57 $
Author:
Matt Albrecht groboclown@users.sourceforge.net

Field Summary
static java.lang.String DEFAULT_POSTFIX
           
static java.lang.String DEFAULT_PREFIX
           
 
Constructor Summary
XMLFileParserGenerator()
           
XMLFileParserGenerator(java.io.File dir)
           
XMLFileParserGenerator(java.io.File[] dirs)
           
XMLFileParserGenerator(java.io.File[] dirs, java.lang.String prefix, java.lang.String postfix)
           
XMLFileParserGenerator(java.io.File dir, java.lang.String prefix, java.lang.String postfix)
           
 
Method Summary
 void addSourceDir(java.io.File dir)
          Adds dir to the internal list of directories to check for issue XML files.
 void addSourceDirs(java.io.File[] dirs)
          Adds the given directories to the internal list of directories to check for issue XML files.
protected  java.io.FilenameFilter createFilter()
           
protected  IParser createParser(java.io.File issueFile)
           
 IParser[] createParsers()
          Generate a collection of parsers which know how to create test records.
protected  java.io.File[] findIssueFiles(java.io.File dir)
           
 void setFilePostfix(java.lang.String postfix)
          Set the text that all XML Issue file names must end with.
 void setFilePrefix(java.lang.String prefix)
          Set the text that all XML Issue file names must begin with.
 void setSAXParser(org.xml.sax.Parser p)
          Sets the SAX 1.0 parser.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_PREFIX

public static final java.lang.String DEFAULT_PREFIX
See Also:
Constant Field Values

DEFAULT_POSTFIX

public static final java.lang.String DEFAULT_POSTFIX
See Also:
Constant Field Values
Constructor Detail

XMLFileParserGenerator

public XMLFileParserGenerator()

XMLFileParserGenerator

public XMLFileParserGenerator(java.io.File dir)

XMLFileParserGenerator

public XMLFileParserGenerator(java.io.File dir,
                              java.lang.String prefix,
                              java.lang.String postfix)

XMLFileParserGenerator

public XMLFileParserGenerator(java.io.File[] dirs)

XMLFileParserGenerator

public XMLFileParserGenerator(java.io.File[] dirs,
                              java.lang.String prefix,
                              java.lang.String postfix)
Method Detail

setSAXParser

public void setSAXParser(org.xml.sax.Parser p)
Sets the SAX 1.0 parser.


setFilePrefix

public void setFilePrefix(java.lang.String prefix)
Set the text that all XML Issue file names must begin with. Unlike the XMLFileServer, the prefix must not contain path information due to the detection methods used. If a null is passed in, then the default value ("ISSUE-") is used instead. The string will be considered case-insensitive for searching purposes.

Parameters:
prefix - the new prefix value to use.

setFilePostfix

public void setFilePostfix(java.lang.String postfix)
Set the text that all XML Issue file names must end with. If a null is passed in, then the default value (".xml") is used instead. The string will be considered case-insensitive for searching purposes.

Parameters:
postfix - the new postfix value to use.

addSourceDir

public void addSourceDir(java.io.File dir)
Adds dir to the internal list of directories to check for issue XML files. Subdirectories will not be inspected, unless they are explicitly added.

Parameters:
dir - additional directory to search for issue files. null values, non-directories, and non-existent files will be ignored.
See Also:
addSourceDirs( File[] )

addSourceDirs

public void addSourceDirs(java.io.File[] dirs)
Adds the given directories to the internal list of directories to check for issue XML files. Subdirectories will not be inspected, unless they are explicitly added.

Parameters:
dirs - additional directories to search for issue files. null values, non-directories, and non-existent files will be ignored.
See Also:
addSourceDir( File )

createParsers

public IParser[] createParsers()
Generate a collection of parsers which know how to create test records.

Specified by:
createParsers in interface IParserGenerator

findIssueFiles

protected java.io.File[] findIssueFiles(java.io.File dir)

createParser

protected IParser createParser(java.io.File issueFile)

createFilter

protected java.io.FilenameFilter createFilter()


Copyright © 2001-2003 by The GroboUtils Project