Class 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 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
      • IS_DEFAULT_VALUE

        public static final ISObject IS_DEFAULT_VALUE
        SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
      • METADATA_DEFAULT_VALUE

        public static final X3DMetadataObject METADATA_DEFAULT_VALUE
        SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
      • 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
      • VALUE_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.Boolean> VALUE_DEFAULT_VALUE
        MFBool field named value has default value equal to an empty list.
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        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
      • initialize

        public final void initialize()
        Initialize all member variables to default values.
        Overrides:
        initialize in class X3DConcreteNode
      • clearIS

        public MetadataBooleanObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        MetadataBooleanObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasIS

        public boolean hasIS()
        Indicate whether an object is available for inputOutput SFNode field IS.
        Returns:
        whether a concrete statement or CommentsBlock is available.
        See Also:
        getIS()
      • 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).
      • 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
      • 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​(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)
        Accessor method to 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​(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 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).
      • getUSE

        public java.lang.String getUSE()
        Provide String value from 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.
        Overrides:
        getUSE in class X3DConcreteNode
        Returns:
        value of USE field
        See Also:
        X3D Scene Authoring Hints: Naming Conventions
      • setUSE

        public final MetadataBooleanObject setUSE​(java.lang.String newValue)
        Accessor method to 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 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 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).
      • 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).
      • 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)
      • 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)