org.web3d.x3d.jaxp
Class XMLReader

java.lang.Object
  org.web3d.x3d.jaxp.XMLReader

All Implemented Interfaces:

VRMLReader

public class XMLReader
extends java.lang.Object
implements VRMLReader

Common reader implementation that can be either strict or lenient in the parsing.

This parser supports the following properties:

• "conformance": ["weak", "strict"]. String values. Defaults to weak
• "useNamespaces": [true, false]. Boolean values. Defaults to false

Weak parsing is defined to mean not using validation on the document. Strong parsing will enforce validation.

Version:

$Revision: 1.3 $

Author:

Justin Couch

Constructor Summary

XMLReader()
Create a new instance of the reader.

Method Summary

ContentHandler	getContentHandler() Get the currently set ContentHandler instance.
ErrorReporter	getErrorHandler() Get the currently set ErrorHandler instance.
java.lang.Object	getProperty(java.lang.String prop) Get the value of the named property.
ProtoHandler	getProtoHandler() Get the currently set ProtoHandler instance.
RouteHandler	getRouteHandler() Get the currently set RouteHandler instance.
ScriptHandler	getScriptHandler() Get the currently set ScriptHandler instance.
void	parse(InputSource input) Parse a VRML document represented by the given input source.
void	setContentHandler(ContentHandler ch) Set the content handler to the given instance.
void	setErrorHandler(ErrorHandler eh) Set the error handler to the given instance.
void	setErrorReporter(ErrorReporter eh) Set the error reporter instance.
void	setHeaderIgnore(boolean enable) Tell the reader that it should not look for the header.
void	setProperty(java.lang.String name, java.lang.Object value) Set the value of the named property to the given value.
void	setProtoHandler(ProtoHandler ph) Set the proto handler to the given instance.
void	setRouteHandler(RouteHandler rh) Set the route handler to the given instance.
void	setScriptHandler(ScriptHandler sh) Set the script handler to the given instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLReader

public XMLReader()
          throws FactoryConfigurationError

Create a new instance of the reader. Does not initialise anything until we know what sort of input file we have.

Throws:

FactoryConfigurationError

Method Detail

parse

public void parse(InputSource input)
           throws java.io.IOException,
                  VRMLException

Parse a VRML document represented by the given input source. This method should not be called while currently processing a stream. If multiple concurrent streams need to be parsed then multiple instances of this interface should be used.

Specified by:

parse in interface VRMLReader

Parameters:

input - The input source to be used

Throws:

java.io.IOException - An I/O error while reading the stream

VRMLParseException - A parsing error occurred in the file

SAVNotSupportedException - The input file is not XML encoded.

VRMLException

getProperty

public java.lang.Object getProperty(java.lang.String prop)
                             throws SAVNotSupportedException

Get the value of the named property. VRMLReaders are not required to support any specific property names.

Specified by:

getProperty in interface VRMLReader

Parameters:

prop - The name of the property to get the value of

Returns:

The value of the set property or null if not set

Throws:

SAVNotSupportedException - The VRMLReader does not recognize or does not support this property name.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws SAVNotSupportedException

Set the value of the named property to the given value. VRMLReaders are not required to support any specific property names. Using a value of null will clear the currently set property value.

Specified by:

setProperty in interface VRMLReader

Parameters:

name - The name of the property to set

value - The value of this property

Throws:

SAVNotSupportedException - The VRMLReader does not recognize or does not support this property name.

setHeaderIgnore

public void setHeaderIgnore(boolean enable)

Tell the reader that it should not look for the header. This is needed to deal with createVrmlFromString() calls that do not include the header as part of the stream and would otherwise cause an error.

Specified by:

setHeaderIgnore in interface VRMLReader

Parameters:

enable - true to stop looking for a header

getErrorHandler

public ErrorReporter getErrorHandler()

Get the currently set ErrorHandler instance. If nothing is set it will return null.

Specified by:

getErrorHandler in interface VRMLReader

Returns:

The currently set error handler.

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

Set the error handler to the given instance. If the value is null it will clear the currently set instance.

Specified by:

setErrorHandler in interface VRMLReader

Parameters:

eh - The error handler instance to use

setErrorReporter

public void setErrorReporter(ErrorReporter eh)

Set the error reporter instance. If this is also an ErrorHandler instance, the document locator will also be set.

Specified by:

setErrorReporter in interface VRMLReader

Parameters:

eh - The error handler instance to use

getContentHandler

public ContentHandler getContentHandler()

Get the currently set ContentHandler instance. If nothing is set it will return null.

Specified by:

getContentHandler in interface VRMLReader

Returns:

The currently set node handler.

setContentHandler

public void setContentHandler(ContentHandler ch)

Set the content handler to the given instance. If the value is null it will clear the currently set instance.

Specified by:

setContentHandler in interface VRMLReader

Parameters:

ch - The content handler instance to use

getScriptHandler

public ScriptHandler getScriptHandler()

Get the currently set ScriptHandler instance. If nothing is set it will return null.

Specified by:

getScriptHandler in interface VRMLReader

Returns:

The currently set script handler.

setScriptHandler

public void setScriptHandler(ScriptHandler sh)

Set the script handler to the given instance. If the value is null it will clear the currently set instance.

Specified by:

setScriptHandler in interface VRMLReader

Parameters:

sh - The script handler instance to use

getProtoHandler

public ProtoHandler getProtoHandler()

Get the currently set ProtoHandler instance. If nothing is set it will return null.

Specified by:

getProtoHandler in interface VRMLReader

Returns:

The currently set proto handler.

setProtoHandler

public void setProtoHandler(ProtoHandler ph)

Set the proto handler to the given instance. If the value is null it will clear the currently set instance.

Specified by:

setProtoHandler in interface VRMLReader

Parameters:

ph - The proto handler instance to use

getRouteHandler

public RouteHandler getRouteHandler()

Get the currently set RouteHandler instance. If nothing is set it will return null.

Specified by:

getRouteHandler in interface VRMLReader

Returns:

The currently set route handler.

setRouteHandler

public void setRouteHandler(RouteHandler rh)

Set the route handler to the given instance. If the value is null it will clear the currently set instance.

Specified by:

setRouteHandler in interface VRMLReader

Parameters:

rh - The route handler instance to use