net.officefloor.model.impl.repository.xml

Class XmlConfigurationContext

java.lang.Object

net.officefloor.model.impl.repository.xml.XmlConfigurationContext

All Implemented Interfaces:

ResourceSource, ConfigurationContext

public class XmlConfigurationContext
extends Object
implements ConfigurationContext, ResourceSource

ConfigurationContext obtaining ConfigurationItem instances from a single XML file.

This reduces the number of files required for unit testing.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
XmlConfigurationContext(Object offsetObject, String singleXmlFileName) Obtains the ConfigurationContext contained in the XML file found in the package of the offset object.

Method Summary

Modifier and Type	Method and Description
void	addTag(String tagName, String tagReplaceValue) Adds tag replacement of the raw XML text before it is parsed and divided into ConfigurationItem instances.
ConfigurationItem	createConfigurationItem(String relativeLocation, InputStream configuration) Creates a new ConfigurationItem at the relative location.
void	deleteConfigurationItem(String relativeLocation) Deletes the ConfigurationItem at the relative location.
ConfigurationItem	getConfigurationItem(String relativeLocation) Obtains the ConfigurationItem at the relative location.
String	getLocation() Obtains the location for this ConfigurationContext.
boolean	isReadOnly() Indicates if the configuration is read-only.
InputStream	sourceResource(String location) Attempts to source the resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlConfigurationContext

public XmlConfigurationContext(Object offsetObject,
                               String singleXmlFileName)
                        throws Exception

Obtains the ConfigurationContext contained in the XML file found in the package of the offset object.

Parameters:

offsetObject - Offset object identifying the package containing the XML file. This is typically the TestCase class.

singleXmlFileName - Name of the XML file.

Throws:

Exception - If fails to initialise.

Method Detail

addTag

public void addTag(String tagName,
                   String tagReplaceValue)

Adds tag replacement of the raw XML text before it is parsed and divided into ConfigurationItem instances.

Parameters:

tagName - Name of the tag. This will replace ${tagName} text with the tag replace value.

tagReplaceValue - Value to replace the tag with.

sourceResource

public InputStream sourceResource(String location)

Description copied from interface: ResourceSource

Attempts to source the resource.

Specified by:

sourceResource in interface ResourceSource

Parameters:

location - Location of the resource.

Returns:

InputStream to the content of the resource or null if not able to source the resource.

getLocation

public String getLocation()

Description copied from interface: ConfigurationContext

Obtains the location for this ConfigurationContext.

This value is used in the equality of ConfigurationContext instances.

Specified by:

getLocation in interface ConfigurationContext

Returns:

Location for this ConfigurationContext.

getConfigurationItem

public ConfigurationItem getConfigurationItem(String relativeLocation)
                                       throws Exception

Description copied from interface: ConfigurationContext

Obtains the ConfigurationItem at the relative location.

Specified by:

getConfigurationItem in interface ConfigurationContext

Parameters:

relativeLocation - Relative location of the ConfigurationItem to obtain.

Returns:

ConfigurationItem.

Throws:

Exception - If can not obtain a ConfigurationItem at the relative location.

isReadOnly

public boolean isReadOnly()

Description copied from interface: ConfigurationContext

Indicates if the configuration is read-only.

Specified by:

isReadOnly in interface ConfigurationContext

Returns:

true should the configuration be read-only.

createConfigurationItem

public ConfigurationItem createConfigurationItem(String relativeLocation,
                                                 InputStream configuration)
                                          throws Exception

Description copied from interface: ConfigurationContext

Creates a new ConfigurationItem at the relative location.

Specified by:

createConfigurationItem in interface ConfigurationContext

Parameters:

relativeLocation - Relative location of the ConfigurationItem to create.

configuration - Configuration for the ConfigurationItem.

Returns:

The created ConfigurationItem.

Throws:

Exception - If fails to create the ConfigurationItem.

ReadOnlyConfigurationException - Should the underlying implementation be read-only.

deleteConfigurationItem

public void deleteConfigurationItem(String relativeLocation)
                             throws Exception,
                                    ReadOnlyConfigurationException

Description copied from interface: ConfigurationContext

Deletes the ConfigurationItem at the relative location.

Specified by:

deleteConfigurationItem in interface ConfigurationContext

Parameters:

relativeLocation - Relative location of the ConfigurationItem to delete.

Throws:

Exception - If can not delete the ConfigurationItem at the relative location.

ReadOnlyConfigurationException - Should the underlying implementation be read-only.