org.exolab.castor.util

Class LocalConfiguration


public final class LocalConfiguration
extends Configuration

Provides default configuration for Castor components from the castor.properties configuration file. All Castor features rely on the central configuration file.

The configuration file is loaded from the Java lib directory, the classpath and the Castor JAR. Properties set in the classpath file takes precedence over properties set in the Java library configuration file and properties set in the Castor JAR, allowing for each customization. All three files are named castor.properties.

For example, to change the parser in use, specify that all documents should be printed with identantion or turn debugging on, create a new configuration file in the current directory, instead of modifying the global one.

Version:
$Revision: 1.3 $ $Date: 2003/05/01 07:06:32 $
Authors:
Keith Visco
Assaf Arkin

Nested Class Summary

Nested classes/interfaces inherited from class org.exolab.castor.util.Configuration

Configuration.ConfigValues, Configuration.Features, Configuration.Property

Field Summary

Fields inherited from class org.exolab.castor.util.Configuration

ON_VALUE, TRUE_VALUE

Constructor Summary

LocalConfiguration()
Creates a new instance of LocalConfiguration

Method Summary

boolean
debug()
Returns true if the current configuration has enabled debugging.
static LocalConfiguration
getInstance()
Returns an instance of the LocalConfiguration, if a previous configuration has already been loaded for local resource, it will be returned.
OutputFormat
getOutputFormat()
Returns the default OutputFormat for use with a Serializer.
Parser
getParser()
Return an XML document parser implementing the feature list specified in the configuration file.
Parser
getParser(String features)
Returns an XML document parser implementing the requested set of features.
NodeType
getPrimitiveNodeType()
Returns the NodeType to use for Java primitives.
Properties
getProperties()
Returns the current properties from the configuration file(s).
RegExpEvaluator
getRegExpEvaluator()
Returns a new instance of the specified Regular Expression Evaluator, or null if no validator was specified
Serializer
getSerializer()
Returns a default serializer for producing an XML document.
DocumentHandler
getSerializer(OutputStream output)
Returns a default serializer for producing an XML document to the designated output stream using the default serialization format.
DocumentHandler
getSerializer(Writer output)
Returns a default serializer for producing an XML document to the designated output stream using the default serialization format.
XMLNaming
getXMLNaming()
Returns the naming conventions to use for the XML framework
protected void
load()
Calls LocalConfiguration to load the configuration the first time and then looks for a local configuration to merge in with the defaults.
void
loadProperties(String fileOrResourceName)
Load the configuration will not complain about inability to load configuration file from one of the default directories, but if it cannot find the JAR's configuration file, will throw a run time exception.
boolean
marshallingValidation()
Returns true if the default configuration specified validation in the marshalling framework.
boolean
strictElements()
Access to the property specifying whether to apply strictness to elements when unmarshalling.

Methods inherited from class org.exolab.castor.util.Configuration

debug, getDefault, getDefaultDebug, getDefaultMarshallingValidation, getDefaultOutputFormat, getDefaultParser, getDefaultParser, getDefaultPrimitiveNodeType, getDefaultProperty, getDefaultRegExpEvaluator, getDefaultSerializer, getDefaultSerializer, getDefaultSerializer, getDefaultStrictElements, getDefaultXMLNaming, getOutputFormat, getParser, getPrimitiveNodeType, getProperties, getProperty, getRegExpEvaluator, getSerializer, getSerializer, getSerializer, getXMLNaming, loadDefaults, loadProperties, marshallingValidation, strictElements

Constructor Details

LocalConfiguration

public LocalConfiguration()
Creates a new instance of LocalConfiguration

Method Details

debug

public boolean debug()
Returns true if the current configuration has enabled debugging.
Overrides:
debug in interface Configuration
Returns:
true if the current configuration has enabled debugging, otherwise false.

getInstance

public static LocalConfiguration getInstance()
Returns an instance of the LocalConfiguration, if a previous configuration has already been loaded for local resource, it will be returned.
Returns:
the LocalConfiguration

getOutputFormat

public OutputFormat getOutputFormat()
Returns the default OutputFormat for use with a Serializer.
Overrides:
getOutputFormat in interface Configuration
Returns:
the default OutputFormat

getParser

public Parser getParser()
Return an XML document parser implementing the feature list specified in the configuration file.
Overrides:
getParser in interface Configuration
Returns:
A suitable XML parser

getParser

public Parser getParser(String features)
Returns an XML document parser implementing the requested set of features. The feature list is a comma separated list of features that parser may or may not support. No errors are generated for unsupported features. If the feature list is not null, it overrides the default feature list specified in the configuration file, including validation and Namespaces.
Parameters:
features - The requested feature list, null for the defaults
Returns:
A suitable XML parser

getPrimitiveNodeType

public NodeType getPrimitiveNodeType()
Returns the NodeType to use for Java primitives. A null value will be returned if no NodeType was specified, indicating the default NodeType should be used.
Overrides:
getPrimitiveNodeType in interface Configuration
Returns:
the NodeType assigned to Java primitives, or null if no NodeType was specified.

getProperties

public Properties getProperties()
Returns the current properties from the configuration file(s). The Properties returned may be empty, but never null.
Overrides:
getProperties in interface Configuration
Returns:
The current set of configuration properties.

getRegExpEvaluator

public RegExpEvaluator getRegExpEvaluator()
Returns a new instance of the specified Regular Expression Evaluator, or null if no validator was specified
Overrides:
getRegExpEvaluator in interface Configuration
Returns:
the regular expression evaluator,

getSerializer

public Serializer getSerializer()
Returns a default serializer for producing an XML document. The caller can specify an alternative output format, may reuse this serializer across several streams, and may serialize both DOM and SAX events. If such control is not required, it is recommended to call one of the other two methods.
Overrides:
getSerializer in interface Configuration
Parameters:
Returns:
A suitable serializer

getSerializer

public DocumentHandler getSerializer(OutputStream output)
            throws IOException
Returns a default serializer for producing an XML document to the designated output stream using the default serialization format.
Overrides:
getSerializer in interface Configuration
Parameters:
output - The output stream
Returns:
A suitable serializer

getSerializer

public DocumentHandler getSerializer(Writer output)
            throws IOException
Returns a default serializer for producing an XML document to the designated output stream using the default serialization format.
Overrides:
getSerializer in interface Configuration
Parameters:
output - The output stream
Returns:
A suitable serializer

getXMLNaming

public XMLNaming getXMLNaming()
Returns the naming conventions to use for the XML framework
Overrides:
getXMLNaming in interface Configuration
Returns:
the naming conventions to use for the XML framework

load

protected void load()
Calls LocalConfiguration to load the configuration the first time and then looks for a local configuration to merge in with the defaults. Will not complain about inability to load local configuration file from one of the default directories, but if it cannot find the JAR's configuration file, will throw a run time exception.

loadProperties

public void loadProperties(String fileOrResourceName)
            throws FileNotFoundException
Load the configuration will not complain about inability to load configuration file from one of the default directories, but if it cannot find the JAR's configuration file, will throw a run time exception.

marshallingValidation

public boolean marshallingValidation()
Returns true if the default configuration specified validation in the marshalling framework.
Overrides:
marshallingValidation in interface Configuration

strictElements

public boolean strictElements()
Access to the property specifying whether to apply strictness to elements when unmarshalling. Default is true which means that elements appearing in the XML Documnt which cannot be mapped to a class cause a SAXException to be thrown. If set to false, these 'unknown' elements are ignored
Overrides:
strictElements in interface Configuration
Returns:
true if element processing should be "strict".

Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com