org.weborganic.bastille.xml
Class XMLConfiguration

java.lang.Object
  extended by org.weborganic.bastille.xml.XMLConfiguration

public final class XMLConfiguration
extends Object

Centralises the configuration options for this package.

This class is used to ensure that the same configuration options are used by all generators in this package.

Since:
0.6.1

Field Summary
static String BASTILLE_XML_EXTENSION
          The key for the extension used by XML files.
static String BASTILLE_XML_ROOT
          The key for the location of the XML path.
 
Method Summary
static String getXMLExtension(ContentRequest req)
          Returns the XML extension used by generators in this package.
static File getXMLRootFolder(ContentRequest req)
          Returns the XML Root folder used by generators in this package.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BASTILLE_XML_ROOT

public static final String BASTILLE_XML_ROOT
The key for the location of the XML path.

See Also:
Constant Field Values

BASTILLE_XML_EXTENSION

public static final String BASTILLE_XML_EXTENSION
The key for the extension used by XML files.

See Also:
Constant Field Values
Method Detail

getXMLRootFolder

public static File getXMLRootFolder(ContentRequest req)
Returns the XML Root folder used by generators in this package.

The XML root folder can be defined in the config-[mode].xml using the key "bastille.xml.root".

Parameters:
req - The content request.
Returns:
the XML Root folder as defined in the configuration or "xml" if undefined.

getXMLExtension

public static String getXMLExtension(ContentRequest req)
Returns the XML extension used by generators in this package.

The XML extension can be defined in the config-[mode].xml using the key "bastille.xml.extension".

Parameters:
req - The content request.
Returns:
the XML extension as defined in the configuration or ".xml" if undefined.