Package xj3d.filter.filters

Class DEFReplacerFilter

java.lang.Object

xj3d.filter.AbstractFilter

xj3d.filter.filters.DEFReplacerFilter

All Implemented Interfaces:

BinaryContentHandler, ContentHandler, ProtoHandler, RouteHandler, ScriptHandler, StringContentHandler

public class DEFReplacerFilter
extends AbstractFilter

Search for nodes matching a DEF name table. Replaces the content with the X3D content specified in a file. Params supported: -mappingFile foo.properties -- A Java properties file that maps DEF names to files. The X3D files must be a valid X3D file. The content of the DEFed node in the source file will be replaced with the content of the same DEF name in the mapped file. Any child DEF's that might match are ignored.

Version:

$Revision: 1.2 $

Author:

Alan Hudson

Field Summary

Fields inherited from class xj3d.filter.AbstractFilter

contentHandler, documentLocator, errorHandler, fieldHandler, fieldReader, fieldStack, lastErrorCode, majorVersion, minorVersion, nodeStack, parsingType, protoHandler, routeHandler, scriptHandler

Constructor Summary

Constructors

Constructor	Description
DEFReplacerFilter()	Basic constructor.

Method Summary

Modifier and Type	Method	Description
void	endExternProtoDecl()	Notification of the end of an EXTERNPROTO declaration.
void	endField()	Notification of the end of a field declaration.
void	endNode()	Notification of the end of a node declaration.
void	endProtoBody()	Notification of the end of an ordinary proto body.
void	endProtoDecl()	Notification of the end of an ordinary proto declaration statement.
void	endScriptDecl()	Notification of the end of a script declaration.
void	exportDecl(String defName, String exported)	An EXPORT declaration has been found in the document.
void	externProtoURI(String[] values)	Notification of the URI list for an EXTERNPROTO.
void	fieldValue(boolean value)	Set the value of the field at the given index as an boolean.
void	fieldValue(boolean[] value, int len)	Set the value of the field at the given index as an array of boolean.
void	fieldValue(double value)	Set the value of the field at the given index as an double.
void	fieldValue(double[] value, int len)	Set the value of the field at the given index as an array of doubles.
void	fieldValue(float value)	Set the value of the field at the given index as a float.
void	fieldValue(float[] value, int len)	Set the value of the field at the given index as an array of floats.
void	fieldValue(int value)	Set the value of the field at the given index as an integer.
void	fieldValue(int[] value, int len)	Set the value of the field at the given index as an array of integers.
void	fieldValue(long value)	Set the value of the field at the given index as an long.
void	fieldValue(long[] value, int len)	Set the value of the field at the given index as an array of longs.
void	fieldValue(String value)	The value of a normal field.
void	fieldValue(String[] values)	The value of an MFField where the underlying parser knows about how the values are broken up.
void	fieldValue(String[] value, int len)	Set the value of the field at the given index as an array of strings.
void	importDecl(String inline, String exported, String imported)	An IMPORT declaration has been found in the document.
void	loadMapping(String filename)	Load the mapping file.
void	protoFieldDecl(int access, String type, String name, Object value)	Notification of a proto's field declaration.
void	protoIsDecl(String fieldName)	Notification of a field value uses an IS statement.
void	routeDecl(String srcNodeName, String srcFieldName, String destNodeName, String destFieldName)	Notification of a ROUTE declaration in the file.
void	scriptFieldDecl(int access, String type, String name, Object value)	Notification of a script's field declaration.
void	setArguments(String[] args)	Set the argument parameters to control the filter operation.
void	startDocument(String uri, String url, String encoding, String type, String version, String comment)	Declaration of the start of the document.
void	startExternProtoDecl(String name)	Notification of the start of an EXTERNPROTO declaration of the given name.
void	startField(String name)	Notification of a field declaration.
void	startNode(String name, String defName)	Notification of the start of a node.
void	startProtoBody()	Notification of the start of an ordinary proto body.
void	startProtoDecl(String name)	Notification of the start of an ordinary (inline) proto declaration.
void	startScriptDecl()	Notification of the start of a script declaration.
void	useDecl(String defName)	The field value is a USE for the given node name.

Methods inherited from class xj3d.filter.AbstractFilter

componentDecl, endDocument, getContentHandler, getErrorReporter, getLastErrorCode, getProtoHandler, getRouteHandler, getScriptHandler, metaDecl, profileDecl, setContentHandler, setDocumentLocator, setErrorReporter, setParsingType, setProtoHandler, setRouteHandler, setScriptHandler

Methods inherited from class java.lang.Object

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

Constructor Details

DEFReplacerFilter

public DEFReplacerFilter()

Basic constructor.

Method Details

startDocument

public void startDocument(String uri,
 String url,
 String encoding,
 String type,
 String version,
 String comment)
                   throws SAVException,
VRMLException

Declaration of the start of the document. The parameters are all of the values that are declared on the header line of the file after the # start. The type string contains the representation of the first few characters of the file after the #. This allows us to work out if it is VRML97 or the later X3D spec.

Version numbers change from VRML97 to X3D and aren't logical. In the first, it is #VRML V2.0 and the second is #X3D V1.0 even though this second header represents a later spec.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class AbstractFilter

Parameters:

uri - The URI of the file.

url - The base URL of the file for resolving relative URIs contained in the file

encoding - The encoding of this document - utf8 or binary

type - The bytes of the first part of the file header

version - The VRML version of this document

comment - Any trailing text on this line. If there is none, this is null.

Throws:

SAVException - This call is taken at the wrong time in the structure of the document

VRMLException - The content provided is invalid for this part of the document or can't be parsed

importDecl

public void importDecl(String inline,
 String exported,
 String imported)
                throws SAVException,
VRMLException

An IMPORT declaration has been found in the document. All three parameters will always be provided, regardless of whether the AS keyword has been used or not. The parser implementation will automatically set the local import name as needed.

Specified by:

importDecl in interface ContentHandler

Overrides:

importDecl in class AbstractFilter

Parameters:

inline - The name of the inline DEF nodes

exported - The exported name from the inlined file

imported - The local name to use for the exported name

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

exportDecl

public void exportDecl(String defName,
 String exported)
                throws SAVException,
VRMLException

An EXPORT declaration has been found in the document. Both parameters will always be provided regardless of whether the AS keyword has been used. The parser implementation will automatically set the exported name as needed.

Specified by:

exportDecl in interface ContentHandler

Overrides:

exportDecl in class AbstractFilter

Parameters:

defName - The DEF name of the nodes to be exported

exported - The name to be exported as

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

endField

public void endField()
              throws SAVException,
VRMLException

Notification of the end of a field declaration. This is called only at the end of an MFNode declaration. All other fields are terminated by either useDecl(String) or fieldValue(String).

Specified by:

endField in interface ContentHandler

Overrides:

endField in class AbstractFilter

Throws:

SAVException - This call is taken at the wrong time in the structure of the document

VRMLException - The content provided is invalid for this part of the document or can't be parsed

fieldValue

public void fieldValue(String[] values)
                throws SAVException,
VRMLException

The value of an MFField where the underlying parser knows about how the values are broken up. The parser is not required to support this callback, but implementors of this interface should understand it. The most likely time we will have this method called is for MFString or URL lists. If called, it is guaranteed to split the strings along the SF node type boundaries.

Specified by:

fieldValue in interface StringContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

values - The list of string representing the values

Throws:

SAVException - This call is taken at the wrong time in the structure of the document

VRMLException - The content provided is invalid for this part of the document or can't be parsed

fieldValue

public void fieldValue(int value)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an integer. This would be used to set SFInt32 field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

value - The new value to use for the node

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(int[] value,
 int len)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an array of integers. This would be used to set MFInt32 field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

value - The new value to use for the node

len - The number of valid entries in the value array

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(boolean value)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an boolean. This would be used to set SFBool field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

value - The new value to use for the node

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(boolean[] value,
 int len)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an array of boolean. This would be used to set MFBool field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

value - The new value to use for the node

len - The number of valid entries in the value array

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(float value)
                throws SAVException,
VRMLException

Set the value of the field at the given index as a float. This would be used to set SFFloat field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

value - The new value to use for the node

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(float[] value,
 int len)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an array of floats. This would be used to set MFFloat, SFVec2f, SFVec3f and SFRotation field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

value - The new value to use for the node

len - The number of valid entries in the value array

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(long value)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an long. This would be used to set SFTime field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

value - The new value to use for the node

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(long[] value,
 int len)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an array of longs. This would be used to set MFTime field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

value - The new value to use for the node

len - The number of valid entries in the value array

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(double value)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an double. This would be used to set SFDouble field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

value - The new value to use for the node

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(double[] value,
 int len)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an array of doubles. This would be used to set MFDouble, SFVec2d and SFVec3d field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

value - The new value to use for the node

len - The number of valid entries in the value array

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(String[] value,
 int len)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an array of strings. This would be used to set MFString field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

value - The new value to use for the node

len - The number of valid entries in the value array

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

startProtoDecl

public void startProtoDecl(String name)
                    throws SAVException,
VRMLException

Notification of the start of an ordinary (inline) proto declaration. The proto has the given node name.

Specified by:

startProtoDecl in interface ProtoHandler

Overrides:

startProtoDecl in class AbstractFilter

Parameters:

name - The name of the proto

Throws:

SAVException - Always thrown

VRMLException - Never thrown

endProtoDecl

public void endProtoDecl()
                  throws SAVException,
VRMLException

Notification of the end of an ordinary proto declaration statement.

Specified by:

endProtoDecl in interface ProtoHandler

Overrides:

endProtoDecl in class AbstractFilter

Throws:

SAVException - Always thrown

VRMLException - Never thrown

protoFieldDecl

public void protoFieldDecl(int access,
 String type,
 String name,
 Object value)
                    throws SAVException,
VRMLException

Notification of a proto's field declaration. This is used for both external and ordinary protos. Externprotos don't allow the declaration of a value for the field. In this case, the parameter value will be null.

Specified by:

protoFieldDecl in interface ProtoHandler

Overrides:

protoFieldDecl in class AbstractFilter

Parameters:

access - The access type (eg exposedField, field etc)

type - The field type (eg SFInt32, MFVec3d etc)

name - The name of the field

value - The default value of the field. Null if not allowed.

Throws:

SAVException - Always thrown

VRMLException - Never thrown

protoIsDecl

public void protoIsDecl(String fieldName)
                 throws SAVException,
VRMLException

Notification of a field value uses an IS statement. If we are running in VRML97 mode, this will throw an exception if the field access types do not match.

Specified by:

protoIsDecl in interface ProtoHandler

Overrides:

protoIsDecl in class AbstractFilter

Parameters:

fieldName - The name of the field that is being IS'd

Throws:

SAVException - Always thrown

VRMLException - Never thrown

startProtoBody

public void startProtoBody()
                    throws SAVException,
VRMLException

Notification of the start of an ordinary proto body. All nodes contained between here and the corresponding endProtoBody() statement form the body and not the normal scenegraph information.

Specified by:

startProtoBody in interface ProtoHandler

Overrides:

startProtoBody in class AbstractFilter

Throws:

SAVException - Always thrown

VRMLException - Never thrown

endProtoBody

public void endProtoBody()
                  throws SAVException,
VRMLException

Notification of the end of an ordinary proto body. Parsing now returns to ordinary node declarations.

Specified by:

endProtoBody in interface ProtoHandler

Overrides:

endProtoBody in class AbstractFilter

Throws:

SAVException - Always thrown

VRMLException - Never thrown

startExternProtoDecl

public void startExternProtoDecl(String name)
                          throws SAVException,
VRMLException

Notification of the start of an EXTERNPROTO declaration of the given name. Between here and the matching endExternProtoDecl() call you should only receive protoFieldDecl(int, java.lang.String, java.lang.String, java.lang.Object) calls.

Specified by:

startExternProtoDecl in interface ProtoHandler

Overrides:

startExternProtoDecl in class AbstractFilter

Parameters:

name - The node name of the extern proto

Throws:

SAVException - Always thrown

VRMLException - Never thrown

endExternProtoDecl

public void endExternProtoDecl()
                        throws SAVException,
VRMLException

Notification of the end of an EXTERNPROTO declaration.

Specified by:

endExternProtoDecl in interface ProtoHandler

Overrides:

endExternProtoDecl in class AbstractFilter

Throws:

SAVException - Always thrown

VRMLException - Never thrown

externProtoURI

public void externProtoURI(String[] values)
                    throws SAVException,
VRMLException

Notification of the URI list for an EXTERNPROTO. This is a complete list of URIs. The calling application is required to interpret the incoming strings. Even if the externproto has no URIs registered, this method shall be called. If there are none available, this will be called with a zero length list of values.

Specified by:

externProtoURI in interface ProtoHandler

Overrides:

externProtoURI in class AbstractFilter

Parameters:

values - A list of strings representing all of the URI values

Throws:

SAVException - Always thrown

VRMLException - Never thrown

startScriptDecl

public void startScriptDecl()
                     throws SAVException,
VRMLException

Notification of the start of a script declaration. All calls between now and the corresponding endScriptDecl() call belong to this script node. This method will be called after the ContentHandler startNode() method call. All DEF information is contained in that method call and this just signifies the start of script processing so that we know to treat the field parsing callbacks a little differently.

Specified by:

startScriptDecl in interface ScriptHandler

Overrides:

startScriptDecl in class AbstractFilter

Throws:

SAVException - This call is taken at the wrong time in the structure of the document

VRMLException - The content provided is invalid for this part of the document or can't be parsed

endScriptDecl

public void endScriptDecl()
                   throws SAVException,
VRMLException

Notification of the end of a script declaration. This is guaranteed to be called before the ContentHandler endNode() callback.

Specified by:

endScriptDecl in interface ScriptHandler

Overrides:

endScriptDecl in class AbstractFilter

Throws:

SAVException - This call is taken at the wrong time in the structure of the document

VRMLException - The content provided is invalid for this part of the document or can't be parsed

scriptFieldDecl

public void scriptFieldDecl(int access,
 String type,
 String name,
 Object value)
                     throws SAVException,
VRMLException

Notification of a script's field declaration. This is used for all fields except url, mustEvaluate and directOutput fields. These fields use the normal field callbacks of ContentHandler.

Specified by:

scriptFieldDecl in interface ScriptHandler

Overrides:

scriptFieldDecl in class AbstractFilter

Parameters:

access - The access type (eg exposedField, field etc)

type - The field type (eg SFInt32, MFVec3d etc)

name - The name of the field

value - The default value of the field

Throws:

SAVException - This call is taken at the wrong time in the structure of the document

VRMLException - The content provided is invalid for this part of the document or can't be parsed

routeDecl

public void routeDecl(String srcNodeName,
 String srcFieldName,
 String destNodeName,
 String destFieldName)
               throws SAVException,
VRMLException

Notification of a ROUTE declaration in the file. The context of this route should be assumed from the surrounding calls to start and end of proto and node bodies.

Specified by:

routeDecl in interface RouteHandler

Overrides:

routeDecl in class AbstractFilter

Parameters:

srcNodeName - The name of the DEF of the source node

srcFieldName - The name of the field to route values from

destNodeName - The name of the DEF of the destination node

destFieldName - The name of the field to route values to

Throws:

SAVException - This call is taken at the wrong time in the structure of the document

VRMLException - The content provided is invalid for this part of the document or can't be parsed

startNode

public void startNode(String name,
 String defName)
               throws SAVException,
VRMLException

Notification of the start of a node. This is the opening statement of a node and it's DEF name. USE declarations are handled in a separate method.

Specified by:

startNode in interface ContentHandler

Overrides:

startNode in class AbstractFilter

Parameters:

name - The name of the node that we are about to parse

defName - The string associated with the DEF name. Null if not given for this node.

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

startField

public void startField(String name)
                throws SAVException,
VRMLException

Notification of a field declaration. This notification is only called if it is a standard node. If the node is a script or PROTO declaration then the ScriptHandler or ProtoHandler methods are used.

Specified by:

startField in interface ContentHandler

Overrides:

startField in class AbstractFilter

Parameters:

name - The name of the field declared

Throws:

SAVException - This call is taken at the wrong time in the structure of the document

VRMLException - The content provided is invalid for this part of the document or can't be parsed

fieldValue

public void fieldValue(String value)
                throws SAVException,
VRMLException

The value of a normal field. This is a string that represents the entire value of the field. MFStrings will have to be parsed. This is a terminating call for startField as well. The next call will either be another startField() or endNode().

If this field is an SFNode with a USE declaration you will have the useDecl(String) method called rather than this method.

Specified by:

fieldValue in interface BinaryContentHandler

Specified by:

fieldValue in interface StringContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

value - The value of this field

Throws:

SAVException - This call is taken at the wrong time in the structure of the document

VRMLException - The content provided is invalid for this part of the document or can't be parsed

useDecl

public void useDecl(String defName)
             throws SAVException,
VRMLException

The field value is a USE for the given node name. This is a terminating call for startField as well. The next call will either be another startField() or endNode().

Specified by:

useDecl in interface ContentHandler

Overrides:

useDecl in class AbstractFilter

Parameters:

defName - The name of the DEF string to use

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

endNode

public void endNode()
             throws SAVException,
VRMLException

Notification of the end of a node declaration. If boolean addMaterial is set to TRUE, then when a Shape node ends we reset materialAdded, so that future Shapes can also have Material nodes added if necessary.

Specified by:

endNode in interface ContentHandler

Overrides:

endNode in class AbstractFilter

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

loadMapping

public void loadMapping(String filename)

Load the mapping file.

Parameters:

filename - The mapping file to load

setArguments

public void setArguments(String[] args)

Set the argument parameters to control the filter operation.

Overrides:

setArguments in class AbstractFilter

Parameters:

args - The array of argument parameters.