MetadataBoolean (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DMetadataObject, X3DNode

All Known Implementing Classes:

MetadataBooleanObject
```
public interface MetadataBoolean
extends X3DMetadataObject, X3DNode
```
The metadata provided by this node is contained in the Boolean values of the value field.

X3D node tooltip: (X3D version 3.3 or later) [X3DNode,X3DMetadataObject] MetadataBoolean contains a typed list of values providing metadata information about its parent node. Further information about this specific Metadata* node may be provided by a single child Metadata* node with containerField="metadata".
- Hint: use containerField="value" if the parent node is MetadataSet.
- Hint: if a metadata node is needed as a top-level root node for the scene, first insert a parent WorldInfo (or WorldInfo/MetadataSet) to contain it.
- Hint: if present, an IS statement is the first child within any other node.
- Hint: an IS statement precedes any sibling Metadata* node, which in turn precedes any other sibling nodes.
- Hint: comments are not readable when a model file is loaded for viewing, but WorldInfo and Metadata* nodes are persistent and inspectable at run time.
- Hint: X3D for Web Authors, Chapter 15, Metadata Information
  http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.html
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

SAI Java Specification: TODO, X3D Abstract Specification: MetadataBoolean, X3D Tooltips: MetadataBoolean, X3D Scene Authoring Hints: Metadata

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`java.lang.String`	`getName()` Provide String value from inputOutput SFString field named name.
`java.lang.String`	`getReference()` Provide String value from inputOutput SFString field named reference.
`boolean[]`	`getValue()` Provide array of boolean results from inputOutput MFBool field named value.
`MetadataBoolean`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`MetadataBoolean`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`MetadataBoolean`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`MetadataBoolean`	`setName(java.lang.String newValue)` Assign String value to inputOutput SFString field named name.
`MetadataBoolean`	`setReference(java.lang.String newValue)` Assign String value to inputOutput SFString field named reference.
`MetadataBoolean`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`MetadataBoolean`	`setValue(boolean[] newValue)` Assign boolean array to inputOutput MFBool field named value.

- Method Detail
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
MetadataBoolean setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    MetadataBoolean - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getName
```
java.lang.String getName()
```
    Provide String value from inputOutput SFString field named name.
    
    Tooltip: Depending on the metadata vocabulary, the attribute name is usually required for metadata nodes.
    - Warning: name is not included if this instance is a USE node.
    - Hint: well-defined names can simplify design and debugging through improved author understanding.
    - Hint: X3D Scene Authoring Hints, Naming Conventions
      http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    Specified by:
    
    getName in interface X3DMetadataObject
    
    Returns:
    
    value of name field
  - setName
```
MetadataBoolean setName(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named name.
    
    Tooltip: Depending on the metadata vocabulary, the attribute name is usually required for metadata nodes. Warning: name is not included if this instance is a USE node. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    @see X3D Scene Authoring Hints: Naming Conventions
    
    Specified by:
    
    setName in interface X3DMetadataObject
    
    Parameters:
    
    newValue - is new value for the name field.
    
    Returns:
    
    MetadataBoolean - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getReference
```
java.lang.String getReference()
```
    Provide String value from inputOutput SFString field named reference.
    
    Tooltip: Reference to the metadata standard or definition defining this particular metadata value. *
    
    Specified by:
    
    getReference in interface X3DMetadataObject
    
    Returns:
    
    value of reference field
  - setReference
```
MetadataBoolean setReference(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named reference.
    
    Tooltip: Reference to the metadata standard or definition defining this particular metadata value.
    
    Specified by:
    
    setReference in interface X3DMetadataObject
    
    Parameters:
    
    newValue - is new value for the reference field.
    
    Returns:
    
    MetadataBoolean - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getValue
```
boolean[] getValue()
```
    Provide array of boolean results from inputOutput MFBool field named value.
    
    Tooltip: The value attribute is a strictly typed data array providing relevant metadata information.
    - Warning: use lower-case values ("true false") for .x3d XML encoding, and upper-case values ("TRUE FALSE") for .x3dv ClassicVRML encoding.
    Returns:
    
    value of value field
  - setValue
```
MetadataBoolean setValue(boolean[] newValue)
```
    Assign boolean array to inputOutput MFBool field named value.
    
    Tooltip: The value attribute is a strictly typed data array providing relevant metadata information. Warning: use lower-case values ("true false") for .x3d XML encoding, and upper-case values ("TRUE FALSE") for .x3dv ClassicVRML encoding.
    
    Parameters:
    
    newValue - is new value for the value field.
    
    Returns:
    
    MetadataBoolean - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setDEF
```
MetadataBoolean setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    MetadataBoolean - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setUSE
```
MetadataBoolean setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    MetadataBoolean - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setCssClass
```
MetadataBoolean setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    MetadataBoolean - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes

Interface MetadataBoolean

Method Summary

Method Detail

getMetadata

setMetadata

getName

setName

getReference

setReference

getValue

setValue

setDEF

setUSE

setCssClass