org.web3d.vrml.lang
Class WriteableSceneMetaData

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

public class WriteableSceneMetaData

extends SceneMetaData

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.1 $

Author:

Justin Couch

Field Summary

Fields inherited from class org.web3d.vrml.lang.SceneMetaData

ASCII_ENCODING, BIFS_ENCODING, BINARY_ENCODING, components, LAST_STD_ENCODING, metaData, profile, SCRIPTED_ENCODING, VRML_ENCODING, XML_ENCODING

Constructor Summary

WriteableSceneMetaData(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

void	addComponent(ComponentInfo comp) Add a component description to this meta data.
void	addMetaData(java.lang.String name, java.lang.String value) Add a meta tag data item to this scene.
void	removeMetaData(java.lang.String name) Remove the named tag from the map.
void	setProfileName(java.lang.String prof) Set the name of the profile that is used by this scene.

Methods inherited from class org.web3d.vrml.lang.SceneMetaData

getComponents, getEncoding, getMetaData, getProfileName, getVersion, isVrmlSpec

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteableSceneMetaData

public WriteableSceneMetaData(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

Method Detail

setProfileName

public void setProfileName(java.lang.String prof)

Set the name of the profile that is used by this scene. No validity checking is performed on the name.

Parameters:

prof - The profile name

addComponent

public void addComponent(ComponentInfo comp)

Add a component description to this meta data. This describes additional component capabilities over the main profile.

Parameters:

comp - The component information to add

addMetaData

public void addMetaData(java.lang.String name,
                        java.lang.String value)

Add a meta tag data item to this scene. Both name and value must be non-null.

Parameters:

name - The name of the tag to add

value - The value of the tag

Throws:

java.lang.NullPointerException - The name or value were null

removeMetaData

public void removeMetaData(java.lang.String name)

Remove the named tag from the map. If tag name does not exist, the request is silently ignored.

Parameters:

name - The name of the tag to remove