DDMSVersion (DDMSence 2.6.0 API)

Object
- buri.ddmsence.util.DDMSVersion

```
public class DDMSVersion
extends Object
```
Manages the supported versions of DDMS.
This class is the extension point for supporting new DDMS versions in the future. DDMSVersion maintains a thread-local currentVersion variable which can be set at runtime. All DDMS component constructors which build components from scratch can then call DDMSVersion.getCurrentVersion() to access various details such as schema locations and namespace URIs. If no currentVersion has been set, a default will be used, which maps to buri.ddmsence.ddms.defaultVersion in the properties file. This defaults to 5.0 right now.

The ddmsence.properties file has a property, ddms.supportedVersions which can be a comma-separated list of version numbers. Each of these token values then has a set of properties which identify the namespace and schema locations for each DDMS version:
<versionNumber>.ddms.xmlNamespace: i.e. "urn:us:mil:ces:metadata:ddms:5"
<versionNumber>.ddms.xsdLocation: i.e. "/schemas/5.0/DDMS/ddms.xsd"
<versionNumber>.gml.xmlNamespace: i.e. "http://www.opengis.net/gml/3.2"
<versionNumber>.gml.xsdLocation: i.e. "/schemas/5.0/DDMS/gml.xsd"
<versionNumber>.ism.cveLocation: i.e. "/schemas/5.0/ISM/CVE/"
<versionNumber>.ism.xmlNamespace: i.e. "urn:us:gov:ic:ism"
<versionNumber>.ntk.xmlNamespace: i.e. "urn:us:gov:ic:ntk"
<versionNumber>.ntk.xsdLocation: i.e. "/schemas/5.0/NTK/IC-NTK.xsd"
<versionNumber>.tspi.xmlNamespace: i.e. "http://metadata.ces.mil/mdr/ns/GSIP/tspi/2.0"
<versionNumber>.tspi.xsdLocation: i.e. "/schemas/5.0/tspi/2.0.0/tspi.xsd"
<versionNumber>.virt.xmlNamespace: i.e. "urn:us:gov:ic:virt"
<versionNumber>.xlink.xmlNamespace: i.e. "http://www.w3.org/1999/xlink"

The format of an xsdLocation should generally follow /schemas/<versionNumber>/schemaLocationInDataDirectory.

Version-specific Notes:

Because DDMS 3.0.1 is syntactically identical to DDMS 3.0, requests for version 3.0.1 will simply alias to DDMS 3.0. DDMS 3.0.1 is not set up as a separate batch of schemas and namespaces, since none of the technical artifacts changed (3.0.1 was a documentation release).

Because DDMS 4.1 uses the same XML namespace as DDMS 4.0, resolving the XML namespace to a version will always return 4.1 (because it is newer). 4.0.1 is now an alias for 4.1, and warnings will appear when using new 4.1 components.

Since:: 0.9.b
Author:: Brian Uri!

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`clearCurrentVersion()` Clears the current version.
`static DDMSVersion`	`getCurrentVersion()` Accessor for the current version.
`String`	`getGmlNamespace()` Accessor for the gml namespace
`String`	`getGmlSchema()` Accessor for the gml schema location
`String`	`getIsmCveLocation()` Accessor for the ISM CVE location
`String`	`getIsmNamespace()` Accessor for the ISM namespace
`String`	`getNamespace()` Accessor for the DDMS namespace
`String`	`getNtkNamespace()` Accessor for the NTK namespace
`String`	`getNtkSchema()` Accessor for the NTK schema location
`String`	`getSchema()` Accessor for the DDMS schema location
`static List<String>`	`getSupportedVersions()` Returns a list of supported DDMS versions
`String`	`getTspiNamespace()` Accessor for the tspi namespace
`String`	`getTspiSchema()` Accessor for the tspi schema location
`String`	`getVersion()` Accessor for the version number
`static DDMSVersion`	`getVersionFor(String version)` Returns the DDMSVersion instance mapped to a particular version number.
`static DDMSVersion`	`getVersionForNamespace(String namespace)` Returns the DDMSVersion instance mapped to a particular XML namespace.
`String`	`getVirtNamespace()` Accessor for the virt namespace
`String`	`getXlinkNamespace()` Accessor for the xlink namespace
`boolean`	`isAtLeast(String version)` Convenience method to check if a DDMS version number is equal to or higher that some test number.
`static boolean`	`isSupportedDDMSNamespace(String xmlNamespace)` Checks if an XML namespace is included in the list of supported XML namespaces for DDMS
`static DDMSVersion`	`setCurrentVersion(String version)` Sets the currentVersion which will be used for by DDMS component constructors to determine the namespace and schema to use.
`String`	`toString()`

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - isAtLeast
```
public boolean isAtLeast(String version)
```
    Convenience method to check if a DDMS version number is equal to or higher that some test number. An example of where this might be used is to determine the capitalization of element names, many of which changed in DDMS 4.0.1.
    
    Parameters:
    
    version - the version number to check
    
    Returns:
    
    true if the version is equal to or greater than the test version
  - getSupportedVersions
```
public static List<String> getSupportedVersions()
```
    Returns a list of supported DDMS versions
    
    Returns:
    
    List of string version numbers
  - isSupportedDDMSNamespace
```
public static boolean isSupportedDDMSNamespace(String xmlNamespace)
```
    Checks if an XML namespace is included in the list of supported XML namespaces for DDMS
    
    Parameters:
    
    xmlNamespace - the namespace to test
    
    Returns:
    
    true if the namespace is supported
  - getVersionFor
```
public static DDMSVersion getVersionFor(String version)
```
    Returns the DDMSVersion instance mapped to a particular version number.
    
    Parameters:
    
    version - a version number
    
    Returns:
    
    the instance
    
    Throws:
    
    UnsupportedVersionException - if the version number is not supported
  - getVersionForNamespace
```
public static DDMSVersion getVersionForNamespace(String namespace)
```
    Returns the DDMSVersion instance mapped to a particular XML namespace. If the namespace is shared by multiple versions of DDMS, the most recent will be returned.
    
    Parameters:
    
    namespace - the XML namespace
    
    Returns:
    
    the instance
    
    Throws:
    
    UnsupportedVersionException - if the version number is not supported
  - setCurrentVersion
```
public static DDMSVersion setCurrentVersion(String version)
```
    Sets the currentVersion which will be used for by DDMS component constructors to determine the namespace and schema to use.
    
    Parameters:
    
    version - the new version, which must be supported by DDMSence
    
    Returns:
    
    the version which was just set, as a full-fledged DDMSVersion object
    
    Throws:
    
    UnsupportedVersionException - if the version is not supported
  - getCurrentVersion
```
public static DDMSVersion getCurrentVersion()
```
    Accessor for the current version. If not set, returns the default from the properties file.
  - clearCurrentVersion
```
public static void clearCurrentVersion()
```
    Clears the current version.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - getVersion
```
public String getVersion()
```
    Accessor for the version number
  - getNamespace
```
public String getNamespace()
```
    Accessor for the DDMS namespace
  - getSchema
```
public String getSchema()
```
    Accessor for the DDMS schema location
  - getGmlNamespace
```
public String getGmlNamespace()
```
    Accessor for the gml namespace
  - getGmlSchema
```
public String getGmlSchema()
```
    Accessor for the gml schema location
  - getIsmCveLocation
```
public String getIsmCveLocation()
```
    Accessor for the ISM CVE location
  - getIsmNamespace
```
public String getIsmNamespace()
```
    Accessor for the ISM namespace
  - getNtkNamespace
```
public String getNtkNamespace()
```
    Accessor for the NTK namespace
  - getNtkSchema
```
public String getNtkSchema()
```
    Accessor for the NTK schema location
  - getTspiNamespace
```
public String getTspiNamespace()
```
    Accessor for the tspi namespace
  - getTspiSchema
```
public String getTspiSchema()
```
    Accessor for the tspi schema location
  - getVirtNamespace
```
public String getVirtNamespace()
```
    Accessor for the virt namespace
  - getXlinkNamespace
```
public String getXlinkNamespace()
```
    Accessor for the xlink namespace

Class DDMSVersion

Method Summary

Methods inherited from class Object

Method Detail

isAtLeast

getSupportedVersions

isSupportedDDMSNamespace

getVersionFor

getVersionForNamespace

setCurrentVersion

getCurrentVersion

clearCurrentVersion

toString

getVersion

getNamespace

getSchema

getGmlNamespace

getGmlSchema

getIsmCveLocation

getIsmNamespace

getNtkNamespace

getNtkSchema

getTspiNamespace

getTspiSchema

getVirtNamespace

getXlinkNamespace