gov.llnl.babel.config
Class Metadata
java.lang.Object
gov.llnl.babel.config.Metadata
public class Metadata
extends java.lang.Object
The Metadata
class contains information from the machine
configuration database XML metadata file. It defines the languages
supported by the Babel compiler, the configuration options allowed
for each language, and the valid parameters for each option. A
Metadata
object is required to confirm the validity
of the configurations read from the machine configuration XML files.
Metadata(String uri) - The constructor for the
Metadata class initializes the
internal data structures and parses the specified XML document.
|
String | getOptionDescription(String language, String option) - Return a long description of the option for the specified language.
|
String | getOptionSummary(String language, String option) - Return a short summary of the option for the specified language.
|
Set | getValidLanguages() - Return the valid language names supported by the Babel compiler as
a set of strings.
|
Set | getValidOptionParameters(String language, String option) - Return the set of valid option parameter string associated with a
language and option.
|
Set | getValidOptions(String language) - Given a particular language, return the valid configuration option
strings supported by that language.
|
Metadata
public Metadata(String uri)
throws IOException,
SAXException
The constructor for the Metadata
class initializes the
internal data structures and parses the specified XML document.
getOptionDescription
public String getOptionDescription(String language,
String option)
Return a long description of the option for the specified language.
A null will be returned if the language or option are invalid or if
a description was not provided.
getOptionSummary
public String getOptionSummary(String language,
String option)
Return a short summary of the option for the specified language.
A null will be returned if the language or option are invalid.
getValidLanguages
public Set getValidLanguages()
Return the valid language names supported by the Babel compiler as
a set of strings.
getValidOptionParameters
public Set getValidOptionParameters(String language,
String option)
Return the set of valid option parameter string associated with a
language and option. This routine will return null if the language
or option are invalid.
getValidOptions
public Set getValidOptions(String language)
Given a particular language, return the valid configuration option
strings supported by that language. This routine will return null
if the language is not supported or if there are no options associated
with the language.