com.hedgehog.x3d.nodes
Class X3DNode

java.lang.Object
  com.hedgehog.HObject
      com.hedgehog.x3d.nodes.X3DNode

All Implemented Interfaces:

java.lang.Comparable, java.util.Comparator

Direct Known Subclasses:

Contour2DNode, NurbsTextureCoordinate, X3DAppearanceChildNode, X3DAppearanceNode, X3DChildNode, X3DFontStyleNode, X3DGeometricPropertyNode, X3DGeometryNode, X3DNurbsControlCurveNode

public abstract class X3DNode
extends HObject

Title: X3DNode - abstract base class of X3D nodes.

Description: Abstract base class of X3D nodes.

Copyright: Copyright (c) Hedgehog Software 2007-2009.

Company: Hedgehog Software.

Since:

1.0

Version:

1.1

Field Summary

protected java.lang.String	mDefine DEF string, if any.
protected X3DMetadataObject	mMetadata Metadata.

Fields inherited from class com.hedgehog.HObject

mID, mName

Constructor Summary

X3DNode()
Default constructor.

X3DNode(java.lang.String define)
Constructor.

X3DNode(X3DMetadataObject metadata)
Constructor.

X3DNode(X3DMetadataObject metadata, java.lang.String define)
Constructor.

X3DNode(X3DNode object)
Copy constructor.

Method Summary

java.lang.String	getDefine() Returns the "DEF" define string.
X3DMetadataObject	getMeatadata() Returns the metadata obejct.
boolean	hasDefine() Tests whether or not this object has a define stirng.
void	setDefine(java.lang.String define) Sets the "DEF" define string.
void	setMetadata(X3DMetadataObject metadata) Sets the metadata obejct.
abstract org.w3c.dom.Element	toXMLNode(org.w3c.dom.Document document, org.w3c.dom.Element documentRootNode) Converts this X3D node to an XML node.

Methods inherited from class com.hedgehog.HObject

clone, compare, compareTo, copy, equals, getID, getName, hashCode, hasID, hasName, setID, setName

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

mMetadata

protected X3DMetadataObject mMetadata

Metadata.

mDefine

protected java.lang.String mDefine

DEF string, if any.

Constructor Detail

X3DNode

public X3DNode()

Default constructor. Sets the metadata object to null. Sets the DEFINE string to null.

X3DNode

public X3DNode(X3DMetadataObject metadata)

Constructor.

Parameters:

metadata - Metadata object.

X3DNode

public X3DNode(java.lang.String define)

Constructor.

Parameters:

define - DEF string.

X3DNode

public X3DNode(X3DMetadataObject metadata,
               java.lang.String define)

Constructor.

Parameters:

metadata - Metadata object.

define - DEF string.

X3DNode

public X3DNode(X3DNode object)

Copy constructor.

Parameters:

object - Object to copy.

Method Detail

getMeatadata

public X3DMetadataObject getMeatadata()

Returns the metadata obejct.

Returns:

The metadata object.

setMetadata

public void setMetadata(X3DMetadataObject metadata)

Sets the metadata obejct.

Parameters:

metadata - New metadata object.

getDefine

public java.lang.String getDefine()

Returns the "DEF" define string.

Returns:

The "DEF" define string or null if none is set.

setDefine

public void setDefine(java.lang.String define)

Sets the "DEF" define string.

Parameters:

define - New "DEF" define string.

hasDefine

public boolean hasDefine()

Tests whether or not this object has a define stirng.

Returns:

Logical-true if ths obejct has a define string, else logical-false.

toXMLNode

public abstract org.w3c.dom.Element toXMLNode(org.w3c.dom.Document document,
                                              org.w3c.dom.Element documentRootNode)
                                       throws InvalidObjectException

Converts this X3D node to an XML node.

Parameters:

document - XML document.

documentRootNode - Document root node; ie .

Returns:

XML node representation of this X3D node.

Throws:

InvalidObjectException - Thrown if this object is invalid.