Package xj3d.filter.filters

Class RemoveNodeFilter

java.lang.Object

xj3d.filter.AbstractFilter

xj3d.filter.NewAbstractFilter

xj3d.filter.filters.RemoveNodeFilter

All Implemented Interfaces:

BinaryContentHandler, ContentHandler, ProtoHandler, RouteHandler, ScriptHandler, StringContentHandler

public class RemoveNodeFilter
extends NewAbstractFilter

Removes a node from a stream.

Version:

$Revision: 1.0 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected SimpleStack	defStack	A stack of node def names

Fields inherited from class xj3d.filter.NewAbstractFilter

fieldHasEndedImplicitly, parentTypeStack, 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
RemoveNodeFilter()	Basic constructor.

Method Summary

Modifier and Type	Method	Description
void	endNode()	Notification of the end of a node declaration.
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	setArguments(String[] args)	Set the argument parameters to control the filter operation.
void	startField(String name)	Notification of a field declaration.
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.NewAbstractFilter

componentDecl, endDocument, endExternProtoDecl, endField, endProtoBody, endProtoDecl, endScriptDecl, exportDecl, externProtoURI, getContentHandler, getErrorReporter, getLastErrorCode, getProtoHandler, getRouteHandler, getScriptHandler, importDecl, metaDecl, profileDecl, protoFieldDecl, protoIsDecl, routeDecl, scriptFieldDecl, setContentHandler, setDebug, setDocumentLocator, setErrorReporter, setProtoHandler, setRouteHandler, setScriptHandler, startDocument, startExternProtoDecl, startProtoBody, startProtoDecl, startScriptDecl, 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

Field Details

defStack

protected SimpleStack defStack

A stack of node def names

Constructor Details

RemoveNodeFilter

public RemoveNodeFilter()

Basic constructor.

Method Details

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 NewAbstractFilter

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 NewAbstractFilter

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 NewAbstractFilter

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

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 NewAbstractFilter

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 NewAbstractFilter

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 NewAbstractFilter

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 NewAbstractFilter

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 NewAbstractFilter

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 NewAbstractFilter

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 NewAbstractFilter

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 NewAbstractFilter

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 NewAbstractFilter

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 NewAbstractFilter

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 NewAbstractFilter

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 NewAbstractFilter

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.

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 NewAbstractFilter

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.

Specified by:

endNode in interface ContentHandler

Overrides:

endNode in class NewAbstractFilter

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.

setArguments

public void setArguments(String[] args)

Set the argument parameters to control the filter operation.

Overrides:

setArguments in class NewAbstractFilter

Parameters:

args - The array of argument parameters.