Package xj3d.filter.node

Class BaseEncodable

java.lang.Object

xj3d.filter.node.BaseEncodable

All Implemented Interfaces:

Encodable

Direct Known Subclasses:

Appearance, BaseGeometry, BaseGroup, BaseMetadata, BaseTexture2D, Color, ColorRGBA, Coordinate, FillProperties, LineProperties, Material, MultiTexture, MultiTextureCoordinate, MultiTextureTransform, Normal, Scene, Shape, TextureCoordinate, TextureProperties, TextureTransform, Viewpoint

public abstract class BaseEncodable
extends Object
implements Encodable

Common impl for encoding node representations in this package.

Version:

$Revision: 1.2 $

Author:

Rex Melton

Field Summary

Fields

Modifier and Type	Field	Description
protected BinaryContentHandler	bch	Binary Content Handler reference
String	defName	The node's DEF name
protected VRMLFieldReader	fieldReader	The field parser
protected ContentHandler	handler	Content Handler reference
static final int	HANDLER_BINARY	Content Handler Types
static final int	HANDLER_NULL
static final int	HANDLER_STRING
protected int	handlerType	Flag indicating that the content handler is an instance of a BinaryContentHandler, a StringContentHandler, or null
final String	nodeName	The name of this node
protected StringContentHandler	sch	String Content Handler reference
String	useName	The node's USE name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseEncodable(String nodeName)	Constructor
protected	BaseEncodable(String nodeName, String defName)	Constructor

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear the node fields to their initial values
Encodable	clone(boolean full)	Create and return a copy of this object.
protected void	copy(BaseEncodable enc, boolean deep)	Copy the working objects of this into the argument.
boolean	deepEquals(Encodable enc)	Compares this appearance to another and checks if all fields are the same and that all children fields are the same.
void	encode()	Push the node contents to the ContentHandler
String	getDefName()	Return the DEF name of the node
Encodable	getMetadata()	Get the Metadata node wrapper
String	getNodeName()	Return the name of the node
String	getUseName()	Return the USE name of the node
void	setContentHandler(ContentHandler handler)	Set the content handler.
void	setDefName(String defName)	Set the DEF name of the node
void	setFieldReader(VRMLFieldReader fieldReader)	Set the reader to use for parsing field values.
void	setMetadata(Encodable metadata)	Set the Metadata node wrapper
void	setUseName(String useName)	Set the USE name of the node
void	setValue(String name, Object value)	Set the value of the named field.
void	setValue(String name, Object value, int len)	Set the value of the named field.

Methods inherited from class java.lang.Object

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

Field Details

HANDLER_BINARY

public static final int HANDLER_BINARY

Content Handler Types

See Also:

• Constant Field Values

HANDLER_STRING

public static final int HANDLER_STRING

See Also:

• Constant Field Values

HANDLER_NULL

public static final int HANDLER_NULL

See Also:

• Constant Field Values

nodeName

public final String nodeName

The name of this node

defName

public String defName

The node's DEF name

useName

public String useName

The node's USE name

fieldReader

protected VRMLFieldReader fieldReader

The field parser

handlerType

protected int handlerType

Flag indicating that the content handler is an instance of a BinaryContentHandler, a StringContentHandler, or null

handler

protected ContentHandler handler

Content Handler reference

bch

protected BinaryContentHandler bch

Binary Content Handler reference

sch

protected StringContentHandler sch

String Content Handler reference

Constructor Details

BaseEncodable

protected BaseEncodable(String nodeName)

Constructor

Parameters:

nodeName -

BaseEncodable

protected BaseEncodable(String nodeName,
 String defName)

Constructor

Parameters:

defName -

Method Details

getNodeName

public String getNodeName()

Return the name of the node

Specified by:

getNodeName in interface Encodable

Returns:

the name of the node

getDefName

public String getDefName()

Return the DEF name of the node

Specified by:

getDefName in interface Encodable

Returns:

the DEF name of the node

setDefName

public void setDefName(String defName)

Set the DEF name of the node

Specified by:

setDefName in interface Encodable

Parameters:

defName - the DEF name of the node

getUseName

public String getUseName()

Return the USE name of the node

Specified by:

getUseName in interface Encodable

Returns:

the USE name of the node

setUseName

public void setUseName(String useName)

Set the USE name of the node

Specified by:

setUseName in interface Encodable

Parameters:

useName - the USE name of the node

clear

public void clear()

Clear the node fields to their initial values

Specified by:

clear in interface Encodable

encode

public void encode()

Push the node contents to the ContentHandler

Specified by:

encode in interface Encodable

setValue

public void setValue(String name,
 Object value)

Set the value of the named field.

Specified by:

setValue in interface Encodable

Parameters:

name - The name of the field to set.

value - The value of the field.

setValue

public void setValue(String name,
 Object value,
 int len)

Set the value of the named field.

Specified by:

setValue in interface Encodable

Parameters:

name - The name of the field to set.

value - The value of the field.

len - The number of values in the array.

setFieldReader

public void setFieldReader(VRMLFieldReader fieldReader)

Set the reader to use for parsing field values.

Specified by:

setFieldReader in interface Encodable

Parameters:

fieldReader - The reader

setContentHandler

public void setContentHandler(ContentHandler handler)

Set the content handler.

Specified by:

setContentHandler in interface Encodable

Parameters:

handler - The ContentHandler instance to use

clone

public Encodable clone(boolean full)

Create and return a copy of this object. Must be overridden, by default returns null.

Specified by:

clone in interface Encodable

Parameters:

full - true if the clone should contain a copy of the complete contents of this node and it's children, false returns a new instance of this node type.

Returns:

a copy of this.

setMetadata

public void setMetadata(Encodable metadata)

Set the Metadata node wrapper

Parameters:

metadata - The Metadata node wrapper

getMetadata

public Encodable getMetadata()

Get the Metadata node wrapper

Returns:

The Metadata node wrapper

copy

protected void copy(BaseEncodable enc,
 boolean deep)

Copy the working objects of this into the argument. Used by subclasses to initialize a clone. The defName and useName are never copied. The deep flag has no effect on this level, the base objects are always copied.

Parameters:

enc - The encodable to initialize.

deep - true to initialize this nodes fields, false otherwise.

deepEquals

public boolean deepEquals(Encodable enc)

Compares this appearance to another and checks if all fields are the same and that all children fields are the same.

Specified by:

deepEquals in interface Encodable

Returns: