org.web3d.vrml.lang
Class SceneMetaData

java.lang.Object
  org.web3d.vrml.lang.SceneMetaData

Direct Known Subclasses:

WriteableSceneMetaData

public class SceneMetaData

extends java.lang.Object

MetaData related to the scene.

MetaData provides setup information that is useful when trying to blend multiple scenes together. For example, it will tell you about what version and encoding the source file was in.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Field Summary

static int	ASCII_ENCODING VRML 1.0 ASCII encoding
static int	BIFS_ENCODING MPEG-4 BIFS encoding
static int	BINARY_ENCODING Binary encoding
protected java.util.ArrayList	components List of components that were used
static int	LAST_STD_ENCODING The index to use for the start of a custom encoding representation if an end user wants to build their own custom parser.
protected java.util.HashMap	metaData Map of Meta tag information in name/value pairs
protected java.lang.String	profile The profile name used, if any.
static int	SCRIPTED_ENCODING The scene was built from userland code using scripting
static int	VRML_ENCODING VRML97 classic encoding (UTF8)
static int	XML_ENCODING XML encoding

Constructor Summary

	SceneMetaData(SceneMetaData src) Create a new, non-writeable instance that copies the information from the given source
protected	SceneMetaData(java.lang.String ver, boolean vrml, int enc) Create a new metadata instance for a scene that describes the given subset of information of the specification.

Method Summary

ComponentInfo[]	getComponents() Get the list of all the components declared in the scene.
int	getEncoding() Get the encoding of the original file type.
java.util.Map	getMetaData() Get the meta data mapping from this scene.
java.lang.String	getProfileName() Get the name of the profile used by this scene.
java.lang.String	getVersion() Get the specification version name that was used to describe this scene.
boolean	isVrmlSpec() Get the flag indicating what specification this is refering to.

Methods inherited from class java.lang.Object

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

Field Detail

SCRIPTED_ENCODING

public static final int SCRIPTED_ENCODING

The scene was built from userland code using scripting

See Also:

Constant Field Values

ASCII_ENCODING

public static final int ASCII_ENCODING

VRML 1.0 ASCII encoding

See Also:

Constant Field Values

VRML_ENCODING

public static final int VRML_ENCODING

VRML97 classic encoding (UTF8)

See Also:

Constant Field Values

XML_ENCODING

public static final int XML_ENCODING

XML encoding

See Also:

Constant Field Values

BINARY_ENCODING

public static final int BINARY_ENCODING

Binary encoding

See Also:

Constant Field Values

BIFS_ENCODING

public static final int BIFS_ENCODING

MPEG-4 BIFS encoding

See Also:

Constant Field Values

LAST_STD_ENCODING

public static final int LAST_STD_ENCODING

The index to use for the start of a custom encoding representation if an end user wants to build their own custom parser.

See Also:

Constant Field Values

profile

protected java.lang.String profile

The profile name used, if any.

components

protected java.util.ArrayList components

List of components that were used

metaData

protected java.util.HashMap metaData

Map of Meta tag information in name/value pairs

Constructor Detail

SceneMetaData

protected SceneMetaData(java.lang.String ver,
                        boolean vrml,
                        int enc)

Create a new metadata instance for a scene that describes the given subset of information of the specification.

Parameters:

ver - The version string to be supported

vrml - true if this is a VRMLX spec, false for X3D

enc - The encoding type used for the source file

SceneMetaData

public SceneMetaData(SceneMetaData src)

Create a new, non-writeable instance that copies the information from the given source

Parameters:

src - The metadata to source the information from

Method Detail

getVersion

public java.lang.String getVersion()

Get the specification version name that was used to describe this scene. The version is a string that is relative to the specification used and is in the format "X.Y" where X and Y are integer values describing major and minor versions, respectively.

Returns:

The version used for this scene

isVrmlSpec

public boolean isVrmlSpec()

Get the flag indicating what specification this is refering to.

Returns:

true if this is a VRML spec, false for X3D

getEncoding

public int getEncoding()

Get the encoding of the original file type.

Returns:

The encoding description

getProfileName

public java.lang.String getProfileName()

Get the name of the profile used by this scene. If the profile is not set, will return null.

Returns:

The name of the profile, or null

getComponents

public ComponentInfo[] getComponents()

Get the list of all the components declared in the scene. If there were no components registered, this will return null.

Returns:

The components declared or null

getMetaData

public java.util.Map getMetaData()

Get the meta data mapping from this scene. The map returned cannot be changed and represents the current internal state.

Returns:

The current meta tag mappings