Package org.web3d.x3d.sai

Interface ComponentInfo

public interface ComponentInfo

Description of a single component.

A component description contains many useful pieces of information about the requirements. At the basic level, it is just a name and a level. In addition to that, we can include supplemental information, such as who the provider of that component is, URL information and more.

Version:

$Revision: 1.3 $

Author:

Justin Couch

Method Summary

Modifier and Type	Method	Description
int	getLevel()	Get the level of the component.
String	getName()	Get the name of this component.
String	getProviderURL()	Get the URL of the provider.
String	getTitle()	Get the title of this component.
String	toX3DString()	Return a formatted string version of this component that conforms to the X3D 1.0 specification for VRML file encoding.

Method Details

getName

String getName()

Get the name of this component.

Returns:

name The name of the component

getLevel

int getLevel()

Get the level of the component. A level is always greater than zero. The level information may represent one of two things, depending on how the component info was created. When created as part of a file that is requesting a specific level of support, the level will indicate the requested level, not the maximum available on the system. When this is returned from a query of the system to see what components are available then the level is maximum supported by the implementation.

Returns:

The level indicator

getTitle

String getTitle()

Get the title of this component. This is a long-form version that could be used in a UI. If no title is set, will return null.

Returns:

The title string of this component

getProviderURL

String getProviderURL()

Get the URL of the provider. This is used for user interface information to point an end user at someone who has implemented this bit of functionality. It is not used by the system to download the component or its definition.

Returns:

The URL of the provider as a string

toX3DString

String toX3DString()

Return a formatted string version of this component that conforms to the X3D 1.0 specification for VRML file encoding. The string will start with the COMPONENT keyword, as per spec.

Returns:

A correctly formatted string.