org.dmd.util.parsing

Class ConfigFinder

java.lang.Object

org.dmd.util.parsing.ConfigFinder

public class ConfigFinder
extends Object

The ConfigFinder utility recursively hunts through the source directories of the current set of Eclipse projects your have on your build path, as well as any JAR files that end with a specific suffix (e.g. *DMSchema.jar) and finds configuration files that end with a specific suffix e.g. .dms .dmg etc.

Add the suffixes you're looking for by calling addSuffix(). You must provide at least one suffix, or the findConfigs() method will fail.

The ConfigFinder also understands the convention of versioning your configuration files by storing them in subfolders named v<#>dot<#>. For instance, for a versioned schema you might have schema/v0dot1, schema/v1dot23, schema/v11dot3dot1 which would represent schemas at version 0.1, 1.23 and 11.3.1 respectively.

NOTE: as indicated, the finder assumes that you're working in an Eclipse environment where you have a directory structure like: project/bin project/src. The finder will see the project/bin on the java.class.path and then try to find the src directory in the same location.

If your development environment doesn't conform to this arrangement, you can derive your own class, or, manually specify the source directories to search by priming the ConfigFinder with calls to addSourceDirectory().

Constructor Summary

Constructors

Constructor and Description
ConfigFinder()
ConfigFinder(Iterator<String> srcdirs) Constructs a new ConfigFinder that will search the specified folders for configurations.
ConfigFinder(String suffix) Convenience constructor to create a finder with the specified file suffix
ConfigFinder(String suffix, ArrayList<String> sd, boolean cp) Convenience constructor to create a finder with the specified file suffix and source directories.

Method Summary

Modifier and Type	Method and Description
void	addJarPrefix(String e) Adds a jar prefix to hunt for.
void	addSourceDirectory(String dir) Adds a source directory root to the set of paths that the finder will traverse in search of schemas.
void	addSuffix(String s) Adds a suffix to hunt for.
void	debug(boolean db)
void	findConfigs() Scans the class path (and an additional source directories) for files ending with the suffixes you've specified.
ConfigVersion	getConfig(String cn) Returns the versions of the specified config.
Iterator<ConfigLocation>	getLocations()
int	getLongestName()
String	getSearchInfo() Returns a description of where we searched for your config files.
TreeMap<String,ConfigVersion>	getVersions()
void	setSourceAndJarInfo(ArrayList<String> sd, ArrayList<String> jars) A convenience function to add source and jar search preferences in one shot.
void	setSourceInfo(ArrayList<String> sd) A convenience function to add source search preferences.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigFinder

public ConfigFinder()

ConfigFinder

public ConfigFinder(String suffix)

Convenience constructor to create a finder with the specified file suffix

Parameters:

suffix -

ConfigFinder

public ConfigFinder(String suffix,
                    ArrayList<String> sd,
                    boolean cp)

Convenience constructor to create a finder with the specified file suffix and source directories.

Parameters:

suffix - the file suffix

sd - the source directories to search

ConfigFinder

public ConfigFinder(Iterator<String> srcdirs)

Constructs a new ConfigFinder that will search the specified folders for configurations.

Parameters:

srcdirs - source directories that have been specified on the commandline.

Method Detail

setSourceInfo

public void setSourceInfo(ArrayList<String> sd)

A convenience function to add source search preferences.

Parameters:

sd - source directories to search

setSourceAndJarInfo

public void setSourceAndJarInfo(ArrayList<String> sd,
                                ArrayList<String> jars)

A convenience function to add source and jar search preferences in one shot.

Parameters:

sd - source directories to search

jars - the prefixes of jars to search

debug

public void debug(boolean db)

addSuffix

public void addSuffix(String s)

Adds a suffix to hunt for. Generally of the form ".xxx".

Parameters:

s - the suffix to hunt for.

addJarPrefix

public void addJarPrefix(String e)

Adds a jar prefix to hunt for. Any jar starting with the specified prefix will be searched for configuration files.

Parameters:

e - the JAR prefix to hunt for.

addSourceDirectory

public void addSourceDirectory(String dir)

Adds a source directory root to the set of paths that the finder will traverse in search of schemas.

Parameters:

dir - The source directory.

findConfigs

public void findConfigs()
                 throws ResultException,
                        IOException

Scans the class path (and an additional source directories) for files ending with the suffixes you've specified.

Throws:

ResultException

IOException

getConfig

public ConfigVersion getConfig(String cn)

Returns the versions of the specified config. If the config is specified in a file named stuff.xxx, the config name will be "stuff" (without the .xxx file extension).

Parameters:

cn - The config name.

Returns:

The ConfigVersion for the specified configuration.

getVersions

public TreeMap<String,ConfigVersion> getVersions()

getLocations

public Iterator<ConfigLocation> getLocations()

Returns:

An iterator over all the configs we found.

getLongestName

public int getLongestName()

Returns:

the length of the longest config name.

getSearchInfo

public String getSearchInfo()

Returns a description of where we searched for your config files.

Returns:

A string indicating the source paths and class paths searched as well as the suffixes and JAR endings we used.