org.dmd.util.parsing

Class ConfigLocation

java.lang.Object

org.dmd.util.parsing.ConfigLocation

public class ConfigLocation
extends Object

The ConfigLocation simply indicates the name of a config file (a file with a .dms suffix) and its location on the file system.

Constructor Summary

Constructors

Constructor and Description
ConfigLocation(String n, String dir, String s) Constructs a new config location.
ConfigLocation(String j, String n, String dir, String s) Constructs a new schema location that's located in a JAR file.

Method Summary

Modifier and Type	Method and Description
String	getConfigName()
String	getConfigParentDirectory()
String	getDirectory()
String	getFileName() The complete file name of this config file OR When the file is found in a JAR file, it's the URL of the file, for example "jar:file:" + jarFileName + "!/" + jarDirectory + "/" + configName + ".xxx" URL url = new URL(fileName);
String	getJarDirectory() If the schema was in a JAR, this is the name of the directory within the JAR where it was found.
String	getJarFilename() If the schema was in a JAR, this is the fully qualified name of the JAR.
String	getJustJarFilename() If the schema was in a JAR, this is just the name of the JAR.
String	getVersion()
boolean	isFromJAR()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigLocation

public ConfigLocation(String n,
                      String dir,
                      String s)

Constructs a new config location.

Parameters:

n - The name of the config file with the suffix e.g. config.suffix

dir - The directory where this file was found.

s - The config file suffix.

ConfigLocation

public ConfigLocation(String j,
                      String n,
                      String dir,
                      String s)

Constructs a new schema location that's located in a JAR file.

Parameters:

j - The JAR file name (that ends with DMSChema.jar). Example:

n - The name of the config file with the .whatever suffix in place.

dir - The sub directory in the JAR where the schema is found.

s - The config file suffix.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

isFromJAR

public boolean isFromJAR()

Returns:

true if the config was found in a jar and false otherwise.

getConfigName

public String getConfigName()

Returns:

The name of the schema (i.e. the name of the .dms file without the .dms extension).

getDirectory

public String getDirectory()

Returns:

The name of the directory where the config file resides.

getFileName

public String getFileName()

The complete file name of this config file OR When the file is found in a JAR file, it's the URL of the file, for example
"jar:file:" + jarFileName + "!/" + jarDirectory + "/" + configName + ".xxx"
URL url = new URL(fileName);

Returns:

The file name.

getConfigParentDirectory

public String getConfigParentDirectory()

Returns:

The parent directory where the config subfolder lives.

getVersion

public String getVersion()

Returns:

The version of the config in numeric form i.e. if your config was in a folder called v3dot5 the version will be "3.5". If the config file wasn't in a version directory, this will be null.

getJarFilename

public String getJarFilename()

If the schema was in a JAR, this is the fully qualified name of the JAR.

Returns:

The JAR file name.

getJarDirectory

public String getJarDirectory()

If the schema was in a JAR, this is the name of the directory within the JAR where it was found.

Returns:

The directory path segment - the file separators in this are forward slashes.

getJustJarFilename

public String getJustJarFilename()

If the schema was in a JAR, this is just the name of the JAR.

Returns:

The JAR file name.