Package org.xj3d.sai

Class X3DNodeTypeMapper

java.lang.Object

org.xj3d.sai.X3DNodeTypeMapper

public class X3DNodeTypeMapper
extends Object

A utility class for handling abstract node type functions, Including:

• Associating abstract node type names with their enumerated type constants and vice versa.
• Obtaining the inherited abstract node types of both abstract nodes and 'real' nodes.
• Producing the set of enumerated type constants suitable for return from the X3DNode.getNodeType() method.

Version:

$Revision: 1.2 $

Author:

Rex Melton

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	X3DNodeTypeMapper()	Protected Constructor

Method Summary

Modifier and Type	Method	Description
static X3DNodeTypeMapper	getInstance()	Return the instance of the X3DNodeTypeMapper
Map<String,String[]>	getInterfaceMap()	Return an unmodifiable interface map.
String[]	getInterfaces(String node_name)	Return the array of interface names for the named argument node
int[]	getInterfaceTypes(String node_name)	Return the array of abstract node types for the named argument node
int	getType(String typeName)	Return the X3DNodeType constant that corresponds to the abstract node type name.
String	getTypeName(int type)	Return the abstract node type name that corresponds to the X3DNodeType constant.
static void	main(String[] arg)	Test routine to echo out the nodes and inherited types in "spec" format.

Methods inherited from class java.lang.Object

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

Constructor Details

X3DNodeTypeMapper

protected X3DNodeTypeMapper()

Protected Constructor

Method Details

getInstance

public static X3DNodeTypeMapper getInstance()

Return the instance of the X3DNodeTypeMapper

Returns:

the instance of the X3DNodeTypeMapper

getInterfaces

public String[] getInterfaces(String node_name)

Return the array of interface names for the named argument node

Parameters:

node_name - The node for which to determine the interfaces

Returns:

The array of interface names. If the named node does not inherit from any known interfaces, an empty String array is returned. If the named node is unknown, null is returned.

getInterfaceTypes

public int[] getInterfaceTypes(String node_name)

Return the array of abstract node types for the named argument node

Parameters:

node_name - The node for which to determine the interfaces

Returns:

The array of abstract node types. If the named node does not inherit from any known interfaces, an empty array is returned. If the named node is unknown, an array containing a single value of -1 is returned.

getInterfaceMap

public Map<String,String[]> getInterfaceMap()

Return an unmodifiable interface map. The map key is the named node. The map value is an array of interface names.

Returns:

The interface map.

getTypeName

public String getTypeName(int type)

Return the abstract node type name that corresponds to the X3DNodeType constant.

Parameters:

type - The X3DNodeType constant

Returns:

The abstract node type name. If the constant does not correspond to a known type, null is returned.

getType

public int getType(String typeName)

Return the X3DNodeType constant that corresponds to the abstract node type name.

Parameters:

typeName - The abstract node type name.

Returns:

the X3DNodeType constant that corresponds to the named abstract node type. If the named node type is unknown, -1 is returned.

main

public static void main(String[] arg)

Test routine to echo out the nodes and inherited types in "spec" format. Will complain if an unknown abstract type is encountered.

Parameters:

arg -