Package xj3d.filter.filters

Class RemoveUnusedDEFFilter

java.lang.Object

xj3d.filter.AbstractFilter

xj3d.filter.BaseFilter

xj3d.filter.node.CommonEncodedBaseFilter

xj3d.filter.filters.RemoveUnusedDEFFilter

All Implemented Interfaces:

BinaryContentHandler, ContentHandler, ProtoHandler, RouteHandler, ScriptHandler, StringContentHandler

public class RemoveUnusedDEFFilter
extends CommonEncodedBaseFilter

Remove any DEF names not used in this file.

Version:

$Revision: 1.18 $

Author:

Alan Hudson

Field Summary

Fields inherited from class xj3d.filter.node.CommonEncodedBaseFilter

encMap, encodeNodes, encodeRoutes, encStack, factory, scene

Fields inherited from class xj3d.filter.BaseFilter

insideInvalidField, sceneMarker, suppressCalls

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
RemoveUnusedDEFFilter()	Create an instance of the filter.

Method Summary

Modifier and Type	Method	Description
void	endDocument()	Declaration of the end of the document.
void	routeDecl(String srcNodeName, String srcFieldName, String destNodeName, String destFieldName)	Notification of a ROUTE declaration in the file.
void	setArguments(String[] args)	Set the argument parameters to control the filter operation.
void	startNode(String name, String defName)	Notification of the start of a node.
void	useDecl(String defName)	The field value is a USE for the given node name.

Methods inherited from class xj3d.filter.node.CommonEncodedBaseFilter

encode, endExternProtoDecl, endField, endNode, endProtoBody, endProtoDecl, endScriptDecl, externProtoURI, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, protoFieldDecl, protoIsDecl, scriptFieldDecl, setDebug, startDocument, startExternProtoDecl, startProtoBody, startProtoDecl, startScriptDecl

Methods inherited from class xj3d.filter.BaseFilter

componentDecl, exportDecl, getContentHandler, getErrorReporter, getLastErrorCode, getProtoHandler, getRouteHandler, getScriptHandler, importDecl, metaDecl, profileDecl, setContentHandler, setDocumentLocator, setErrorReporter, setProtoHandler, setRouteHandler, setScriptHandler, startField, suppressCalls

Methods inherited from class xj3d.filter.AbstractFilter

setParsingType

Methods inherited from class java.lang.Object

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

Constructor Details

RemoveUnusedDEFFilter

public RemoveUnusedDEFFilter()

Create an instance of the filter.

Method Details

endDocument

public void endDocument()
                 throws SAVException,
VRMLException

Declaration of the end of the document. There will be no further parsing and hence events after this.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class CommonEncodedBaseFilter

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 CommonEncodedBaseFilter

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 - 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 CommonEncodedBaseFilter

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 - 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 CommonEncodedBaseFilter

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

setArguments

public void setArguments(String[] args)

Set the argument parameters to control the filter operation.

Overrides:

setArguments in class BaseFilter

Parameters:

args - The array of argument parameters.