org.plasma.sdo.xml
Interface XMLOptions

All Known Implementing Classes:

DefaultOptions

public interface XMLOptions

Method Summary

java.lang.String	getEncoding() Returns the character encoding
org.xml.sax.ErrorHandler	getErrorHandler() Returns the current XML Schema (XSD) validation error handler
java.lang.String	getRootElementName() The root element name.
java.lang.String	getRootElementNamespaceURI() The root namespace URI.
java.lang.String	getRootNamespacePrefix() The desired root namespace prefix.
org.apache.commons.logging.Log	getValidationLog() Returns the current XML Schema (XSD) validation error log.
boolean	isFailOnValidationError() Returns whether to propagate XML parser errors encountered when validating an XML document against an associated XML Schema.
boolean	isValidate() Returns whether to perform XML Schema (XSD) validation when reading XML input.
void	setEncoding(java.lang.String encoding) Sets the character encoding.
void	setErrorHandler(org.xml.sax.ErrorHandler handler) Sets the current XML Schema (XSD) validation error handler
void	setRootElementName(java.lang.String rootElementName) Sets root element name
void	setRootElementNamespaceURI(java.lang.String rootElementName) Sets root namespace URI.
void	setRootNamespacePrefix(java.lang.String rootNamespacePrefix) Sets desired root namespace prefix.
void	setValidate(boolean validate) Set whether to perform XML Schema (XSD) validation when reading XML input.
void	setValidationLog(org.apache.commons.logging.Log validationLog) Sets the current XML Schema (XSD) validation error log

Method Detail

getRootNamespacePrefix

java.lang.String getRootNamespacePrefix()

The desired root namespace prefix.

Returns:

the desired root namespace prefix

setRootNamespacePrefix

void setRootNamespacePrefix(java.lang.String rootNamespacePrefix)

Sets desired root namespace prefix.

Parameters:

rootNamespacePrefix - the desired root namespace prefix

getRootElementNamespaceURI

java.lang.String getRootElementNamespaceURI()

The root namespace URI.

Returns:

the root namespace URI

setRootElementNamespaceURI

void setRootElementNamespaceURI(java.lang.String rootElementName)

Sets root namespace URI.

Parameters:

rootElementName - the root namespace URI

getRootElementName

java.lang.String getRootElementName()

The root element name.

Returns:

the root element name

setRootElementName

void setRootElementName(java.lang.String rootElementName)

Sets root element name

Parameters:

rootElementName - the root element name

isValidate

boolean isValidate()

Returns whether to perform XML Schema (XSD) validation when reading XML input. By default, any errors encountered are logged within the context of the parsing utility unless a log is supplied.

Returns:

whether to perform XML Schema (XSD) validation when reading XML input.

See Also:

Log

setValidate

void setValidate(boolean validate)

Set whether to perform XML Schema (XSD) validation when reading XML input. By default, any errors encountered are logged within the context of the parsing utility unless a log is supplied.

Parameters:

validate - whether to perform XML Schema (XSD) validation

getValidationLog

org.apache.commons.logging.Log getValidationLog()

Returns the current XML Schema (XSD) validation error log.

Returns:

current XML Schema (XSD) validation error log

setValidationLog

void setValidationLog(org.apache.commons.logging.Log validationLog)

Sets the current XML Schema (XSD) validation error log

Parameters:

validationLog - the log

isFailOnValidationError

boolean isFailOnValidationError()

Returns whether to propagate XML parser errors encountered when validating an XML document against an associated XML Schema. Only 'ERROR' and 'FATAL' errors are propagated.

Returns:

whether to propagate XML parser errors encountered when validating an XML document against an associated XML Schema

getErrorHandler

org.xml.sax.ErrorHandler getErrorHandler()

Returns the current XML Schema (XSD) validation error handler

Returns:

the current XML Schema (XSD) validation error handler

setErrorHandler

void setErrorHandler(org.xml.sax.ErrorHandler handler)

Sets the current XML Schema (XSD) validation error handler

Parameters:

handler - the current XML Schema (XSD) validation error handler

getEncoding

java.lang.String getEncoding()

Returns the character encoding

Returns:

the character encoding

setEncoding

void setEncoding(java.lang.String encoding)

Sets the character encoding. E.g. ISO-8859-1

Parameters:

encoding - the character encoding