MetadataBooleanObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.Core.MetadataBooleanObject

All Implemented Interfaces:

MetadataBoolean, X3DMetadataObject, X3DNode
```
public class MetadataBooleanObject
extends X3DConcreteNode
implements MetadataBoolean
```
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 org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:

X3D Abstract Specification: MetadataBoolean, X3D Tooltips: MetadataBoolean, X3D Scene Authoring Hints: Metadata

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the MetadataBoolean element: Core
`static java.lang.String`	`containerField_DEFAULT_VALUE` containerField describes typical field relationship of a node to its parent.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_NAME` fromField ROUTE name for SFString field named name.
`static java.lang.String`	`fromField_REFERENCE` fromField ROUTE name for SFString field named reference.
`static java.lang.String`	`fromField_VALUE` fromField ROUTE name for MFBool field named value.
`static int`	`LEVEL` Integer constant LEVEL provides default X3D Core component level for this element: 1
`static java.lang.String`	`NAME` String constant NAME provides name of this element: MetadataBoolean.
`static java.lang.String`	`NAME_DEFAULT_VALUE` SFString field named name has default value equal to an empty string.
`static java.lang.String`	`REFERENCE_DEFAULT_VALUE` SFString field named reference has default value equal to an empty string.
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_NAME` toField ROUTE name for SFString field named name.
`static java.lang.String`	`toField_REFERENCE` toField ROUTE name for SFString field named reference.
`static java.lang.String`	`toField_VALUE` toField ROUTE name for MFBool field named value.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult

Constructor Summary

Constructors
Constructor and Description
`MetadataBooleanObject()` Constructor for MetadataBooleanObject to initialize member variables with default values.
`MetadataBooleanObject(java.lang.String DEFlabel)` Utility constructor that assigns DEF label after initializing member variables with default values.
`MetadataBooleanObject(java.lang.String DEFlabel, java.lang.String newName)` Utility constructor that assigns both DEF label and name, after initializing member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MetadataBooleanObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`MetadataBooleanObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`MetadataBooleanObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`MetadataBooleanObject`	`addValue(boolean newValue)` Add singleton boolean value to MFBool value field.
`MetadataBooleanObject`	`addValue(SFBoolObject newValue)` Add singleton SFBoolObject value to MFBool value field.
`MetadataBooleanObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`MetadataBooleanObject`	`clearValue()` Utility method to clear MFBool value field.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteNode`	`findNodeByDEF(java.lang.String DEFvalue)` Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`java.lang.String`	`getComponent()` Defines X3D component for the MetadataBoolean element: Core
`int`	`getComponentLevel()` Provides default X3D component level for this element: 1
`java.lang.String`	`getContainerFieldDefault()` containerField describes typical field relationship of a node to its parent.
`java.lang.String`	`getElementName()` Provides name of this element: MetadataBoolean
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`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.
`java.util.ArrayList<java.lang.Boolean>`	`getValueList()` Utility method to get ArrayList MFBool value field, similar to `getValue()`.
`boolean`	`hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
`boolean`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`boolean`	`hasNodeByDEF(java.lang.String DEFvalue)` Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
`void`	`initialize()` Initialize all member variables to default values.
`MetadataBooleanObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`MetadataBooleanObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`MetadataBooleanObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`MetadataBooleanObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`MetadataBooleanObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`MetadataBooleanObject`	`setMetadata(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`MetadataBooleanObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`MetadataBooleanObject`	`setName(SFStringObject newValue)` Assign typed object value to SFString name field, similar to `setName(String)`.
`MetadataBooleanObject`	`setName(java.lang.String newValue)` Assign String value to inputOutput SFString field named name.
`MetadataBooleanObject`	`setReference(SFStringObject newValue)` Assign typed object value to SFString reference field, similar to `setReference(String)`.
`MetadataBooleanObject`	`setReference(java.lang.String newValue)` Assign String value to inputOutput SFString field named reference.
`MetadataBooleanObject`	`setUSE(MetadataBooleanObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`MetadataBooleanObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`MetadataBooleanObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`MetadataBooleanObject`	`setValue(java.util.ArrayList<java.lang.Boolean> newValue)` Assign ArrayList MFBool value field, similar to `setValue(boolean[])`.
`MetadataBooleanObject`	`setValue(boolean[] newValue)` Assign Boolean array to inputOutput MFBool field named value.
`MetadataBooleanObject`	`setValue(MFBoolObject newValue)` Assign typed object MFBool value field, similar to `setValue(boolean[])`.
`java.lang.String`	`toStringClassicVRML(int indentLevel)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int indentLevel)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int indentLevel)` Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: MetadataBoolean.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the MetadataBoolean element: Core
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D Core component level for this element: 1
    
    See Also:
    
    Constant Field Values
  - NAME_DEFAULT_VALUE
```
public static final java.lang.String NAME_DEFAULT_VALUE
```
    SFString field named name has default value equal to an empty string.
    
    See Also:
    
    Constant Field Values
  - REFERENCE_DEFAULT_VALUE
```
public static final java.lang.String REFERENCE_DEFAULT_VALUE
```
    SFString field named reference has default value equal to an empty string.
    
    See Also:
    
    Constant Field Values
  - containerField_DEFAULT_VALUE
```
public static final java.lang.String containerField_DEFAULT_VALUE
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
  - fromField_METADATA
```
public static final java.lang.String fromField_METADATA
```
    fromField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_METADATA
```
public static final java.lang.String toField_METADATA
```
    toField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - fromField_NAME
```
public static final java.lang.String fromField_NAME
```
    fromField ROUTE name for SFString field named name.
    
    See Also:
    
    Constant Field Values
  - toField_NAME
```
public static final java.lang.String toField_NAME
```
    toField ROUTE name for SFString field named name.
    
    See Also:
    
    Constant Field Values
  - fromField_REFERENCE
```
public static final java.lang.String fromField_REFERENCE
```
    fromField ROUTE name for SFString field named reference.
    
    See Also:
    
    Constant Field Values
  - toField_REFERENCE
```
public static final java.lang.String toField_REFERENCE
```
    toField ROUTE name for SFString field named reference.
    
    See Also:
    
    Constant Field Values
  - fromField_VALUE
```
public static final java.lang.String fromField_VALUE
```
    fromField ROUTE name for MFBool field named value.
    
    See Also:
    
    Constant Field Values
  - toField_VALUE
```
public static final java.lang.String toField_VALUE
```
    toField ROUTE name for MFBool field named value.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MetadataBooleanObject
```
public MetadataBooleanObject()
```
    Constructor for MetadataBooleanObject to initialize member variables with default values.
  - MetadataBooleanObject
```
public MetadataBooleanObject(java.lang.String DEFlabel)
```
    Utility constructor that assigns DEF label after initializing member variables with default values.
    
    Parameters:
    
    DEFlabel - unique DEF name for this X3D node
  - MetadataBooleanObject
```
public MetadataBooleanObject(java.lang.String DEFlabel,
                             java.lang.String newName)
```
    Utility constructor that assigns both DEF label and name, after initializing member variables with default values.
    
    Parameters:
    
    DEFlabel - unique DEF name for this X3D node
    
    newName - name for this meta element
    
    See Also:
    
    X3D Tooltips: MetadataBooleanObject, X3D Scene Authoring Hints: Metadata Nodes
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: MetadataBoolean
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the MetadataBoolean element: Core
    
    Specified by:
    
    getComponent in class X3DConcreteElement
    
    Returns:
    
    X3D component for this element
  - getComponentLevel
```
public final int getComponentLevel()
```
    Provides default X3D component level for this element: 1
    
    Specified by:
    
    getComponentLevel in class X3DConcreteElement
    
    Returns:
    
    default X3D component level for this element
  - getFieldType
```
public java.lang.String getFieldType(java.lang.String fieldName)
```
    Indicate type corresponding to given fieldName.
    
    Specified by:
    
    getFieldType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
  - getAccessType
```
public java.lang.String getAccessType(java.lang.String fieldName)
```
    Indicate accessType corresponding to given fieldName.
    
    Specified by:
    
    getAccessType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
  - getContainerFieldDefault
```
public final java.lang.String getContainerFieldDefault()
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    Specified by:
    
    getContainerFieldDefault in class X3DConcreteNode
    
    Returns:
    
    default containerField value
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteNode
  - getMetadata
```
public X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface MetadataBoolean
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public MetadataBooleanObject setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface MetadataBoolean
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public MetadataBooleanObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public MetadataBooleanObject setMetadata(ProtoInstanceObject newValue)
```
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(X3DMetadataObject)
  - hasMetadata
```
public boolean hasMetadata()
```
    Indicate whether an object is available for inputOutput SFNode field metadata.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - getName
```
public 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 MetadataBoolean
    
    Specified by:
    
    getName in interface X3DMetadataObject
    
    Returns:
    
    value of name field
  - setName
```
public final MetadataBooleanObject 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 MetadataBoolean
    
    Specified by:
    
    setName in interface X3DMetadataObject
    
    Parameters:
    
    newValue - is new value for the name field.
    
    Returns:
    
    MetadataBooleanObject - 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
  - setName
```
public MetadataBooleanObject setName(SFStringObject newValue)
```
    Assign typed object value to SFString name field, similar to setName(String).
    
    Parameters:
    
    newValue - is new value for the name field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getReference
```
public 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 MetadataBoolean
    
    Specified by:
    
    getReference in interface X3DMetadataObject
    
    Returns:
    
    value of reference field
  - setReference
```
public MetadataBooleanObject 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 MetadataBoolean
    
    Specified by:
    
    setReference in interface X3DMetadataObject
    
    Parameters:
    
    newValue - is new value for the reference field.
    
    Returns:
    
    MetadataBooleanObject - 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
  - setReference
```
public MetadataBooleanObject setReference(SFStringObject newValue)
```
    Assign typed object value to SFString reference field, similar to setReference(String).
    
    Parameters:
    
    newValue - is new value for the reference field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getValue
```
public 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.
    Specified by:
    
    getValue in interface MetadataBoolean
    
    Returns:
    
    value of value field
  - getValueList
```
public java.util.ArrayList<java.lang.Boolean> getValueList()
```
    Utility method to get ArrayList MFBool value field, similar to getValue().
    
    Returns:
    
    value of value field
  - setValue
```
public MetadataBooleanObject 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.
    
    Specified by:
    
    setValue in interface MetadataBoolean
    
    Parameters:
    
    newValue - is new value for the value field.
    
    Returns:
    
    MetadataBooleanObject - 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
  - setValue
```
public MetadataBooleanObject setValue(MFBoolObject newValue)
```
    Assign typed object MFBool value field, similar to setValue(boolean[]).
    
    Parameters:
    
    newValue - is new value for the value field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setValue
```
public MetadataBooleanObject setValue(java.util.ArrayList<java.lang.Boolean> newValue)
```
    Assign ArrayList MFBool value field, similar to setValue(boolean[]).
    
    Parameters:
    
    newValue - is new value for the value field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - clearValue
```
public MetadataBooleanObject clearValue()
```
    Utility method to clear MFBool value field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addValue
```
public MetadataBooleanObject addValue(boolean newValue)
```
    Add singleton boolean value to MFBool value field.
    
    Parameters:
    
    newValue - is new value to add to the value field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addValue
```
public MetadataBooleanObject addValue(SFBoolObject newValue)
```
    Add singleton SFBoolObject value to MFBool value field.
    
    Parameters:
    
    newValue - is new value to add to the value field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public final MetadataBooleanObject 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 MetadataBoolean
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    MetadataBooleanObject - 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
```
public MetadataBooleanObject setDEF(SFStringObject newValue)
```
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public final MetadataBooleanObject 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 MetadataBoolean
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    MetadataBooleanObject - 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
```
public MetadataBooleanObject setUSE(SFStringObject newValue)
```
    Assign typed object value to SFString USE field, similar to setUSE(String).
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
public final MetadataBooleanObject setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Specified by:
    
    setCssClass in interface MetadataBoolean
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    MetadataBooleanObject - 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
```
public MetadataBooleanObject setCssClass(SFStringObject newValue)
```
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIS
```
public MetadataBooleanObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public MetadataBooleanObject setUSE(MetadataBooleanObject DEFnode)
```
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    
    Warning: note that 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.
    
    Parameters:
    
    DEFnode - must have a DEF value defined
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addComments
```
public MetadataBooleanObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public MetadataBooleanObject addComments(java.lang.String[] newComments)
```
    Add comments as String[] array to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComments - array of comments
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public MetadataBooleanObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - toStringX3D
```
public java.lang.String toStringX3D(int indentLevel)
```
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    
    Specified by:
    
    toStringX3D in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    X3D string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form
  - toStringClassicVRML
```
public java.lang.String toStringClassicVRML(int indentLevel)
```
    Recursive method to provide ClassicVRML string serialization.
    
    Specified by:
    
    toStringClassicVRML in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    ClassicVRML string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
  - toStringVRML97
```
public java.lang.String toStringVRML97(int indentLevel)
```
    Recursive method to provide VRML97 string serialization.
    
    Specified by:
    
    toStringVRML97 in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    VRML97 string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasElementByNameValue
```
public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)
```
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findElementByNameValue(String, String)
  - findNodeByDEF
```
public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same DEF, this method does not handle that case.
    
    Specified by:
    
    findNodeByDEF in class X3DConcreteElement
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found node, null otherwise
    
    See Also:
    
    findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasNodeByDEF
```
public boolean hasNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findNodeByDEF(String)
  - validate
```
public java.lang.String validate()
```
    Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
    
    Specified by:
    
    validate in class X3DConcreteElement
    
    Returns:
    
    validation results (if any)

Class MetadataBooleanObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

NAME_DEFAULT_VALUE

REFERENCE_DEFAULT_VALUE

containerField_DEFAULT_VALUE

fromField_METADATA

toField_METADATA

fromField_NAME

toField_NAME

fromField_REFERENCE

toField_REFERENCE

fromField_VALUE

toField_VALUE

Constructor Detail

MetadataBooleanObject

MetadataBooleanObject

MetadataBooleanObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

getMetadata

setMetadata

clearMetadata

setMetadata

hasMetadata

getName

setName

setName

getReference

setReference

setReference

getValue

getValueList

setValue

setValue

setValue

clearValue

addValue

addValue

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

addComments

addComments

addComments

toStringX3D

toStringClassicVRML

toStringVRML97

findElementByNameValue

findElementByNameValue

hasElementByNameValue

findNodeByDEF

hasNodeByDEF

validate