Package org.web3d.x3d.jsail.Core

Class head

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteStatement
org.web3d.x3d.jsail.Core.head
public class head extends X3DConcreteStatement
Functional summary: each X3D scene includes a head statement that can contain component, unit and meta statements. This concrete class represents an X3D head statement.

X3D statement tooltip: [X3D statement] head can contain component, unit, and author-defined meta (metadata) elements. Hint: design for this element is patterned after the &lt;head&gt; tag in HTML: <a href="https://www.w3.org/TR/html5/document-metadata.html#the-head-element" target="_blank">https://www.w3.org/TR/html5/document-metadata.html#the-head-element</a> Warning: head is optional first child of X3D statement, and must precede the Scene statement. Warning: in order to pass XML validation, these contained optional statements must appear in order: first component statements, then unit statements, then meta statements. *

See Also:

  • Field Details

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: head.
      See Also:

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the head element: Core
      See Also:

    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Core component level for this element: 1
      See Also:

  • Constructor Details

    • head

      public head()
      Constructor for head to initialize member variables with default values.

  • Method Details

    • getElementName

      public final String getElementName()
      Provides name of this element: head
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final String getComponent()
      Defines X3D component for the head 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 String getFieldType(String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D statement
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:

    • getAccessType

      public String getAccessType(String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D statement
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:

    • initialize

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

    • getCssClass

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteElement
      Returns:
      value of class field
      See Also:

    • setCssClass

      public final head setCssClass(String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.
      Parameters:
      newValue - is new value for the class field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCssClass

      public head setCssClass(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e
      Parameters:
      newValue - is new value for the class field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getComponentList

      public ArrayList<component> getComponentList()
      Provide array of component results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field component.

      Tooltip: Add component statements to indicate necessary scene functionality above the given profile for this X3D model. *


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to component.
      Returns:
      value of component field
      See Also:

    • setComponentList

      public head setComponentList(ArrayList<component> newValue)
      Accessor method to assign component array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field component.

      Tooltip: Add component statements to indicate necessary scene functionality above the given profile for this X3D model. *


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to component.
      Parameters:
      newValue - is new value for the component field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addComponent

      public head addComponent(component newValue)
      Add array of child component nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to component.
      Parameters:
      newValue - is new value array to be appended the component field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setComponent

      public head setComponent(component newValue)
      Set single child component node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to component.
      Parameters:
      newValue - is new node for the component field (restricted to component)
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearComponent

      public head clearComponent()
      Utility method to clear MFNode value of componentList field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasComponent

      public boolean hasComponent()
      Indicate whether an object is available for inputOutput MFNode field componentList.
      Returns:
      whether a concrete statement array or CommentsBlock is available.
      See Also:

    • getHtmlID

      public String getHtmlID()
      Provide String value from inputOutput SFString field named id.
      Overrides:
      getHtmlID in class X3DConcreteElement
      Returns:
      value of id field
      See Also:

    • setHtmlID

      public final head setHtmlID(String newValue)
      Accessor method to assign String value to inputOutput SFString field named id.
      Parameters:
      newValue - is new value for the id field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setHtmlID

      public head setHtmlID(SFString newValue)
      Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e
      Parameters:
      newValue - is new value for the id field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetaList

      public ArrayList<meta> getMetaList()
      Provide array of meta results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field meta.

      Tooltip: Add meta statements to provide metadata information about this X3D model. *


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to meta.
      Returns:
      value of meta field
      See Also:

    • setMetaList

      public head setMetaList(ArrayList<meta> newValue)
      Accessor method to assign meta array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field meta.

      Tooltip: Add meta statements to provide metadata information about this X3D model. *


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to meta.
      Parameters:
      newValue - is new value for the meta field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addMeta

      public head addMeta(meta newValue)
      Add array of child meta nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to meta.
      Parameters:
      newValue - is new value array to be appended the meta field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setMeta

      public head setMeta(meta newValue)
      Set single child meta node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to meta.
      Parameters:
      newValue - is new node for the meta field (restricted to meta)
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearMeta

      public head clearMeta()
      Utility method to clear MFNode value of metaList field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasMeta

      public boolean hasMeta()
      Indicate whether an object is available for inputOutput MFNode field metaList.
      Returns:
      whether a concrete statement array or CommentsBlock is available.
      See Also:

    • getCssStyle

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteElement
      Returns:
      value of style field
      See Also:

    • setCssStyle

      public final head setCssStyle(String newValue)
      Accessor method to assign String value to inputOutput SFString field named style.
      Parameters:
      newValue - is new value for the style field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCssStyle

      public head setCssStyle(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e
      Parameters:
      newValue - is new value for the style field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUnitList

      public ArrayList<unit> getUnitList()
      Provide array of unit results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field unit.

      Tooltip: Add unit statements to define data-conversion factors for typed values defined within a scene. *


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to unit.
      Returns:
      value of unit field
      See Also:

    • setUnitList

      public head setUnitList(ArrayList<unit> newValue)
      Accessor method to assign unit array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field unit.

      Tooltip: Add unit statements to define data-conversion factors for typed values defined within a scene. *


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to unit.
      Parameters:
      newValue - is new value for the unit field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addUnit

      public head addUnit(unit newValue)
      Add array of child unit nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to unit.
      Parameters:
      newValue - is new value array to be appended the unit field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUnit

      public head setUnit(unit newValue)
      Set single child unit node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to unit.
      Parameters:
      newValue - is new node for the unit field (restricted to unit)
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearUnit

      public head clearUnit()
      Utility method to clear MFNode value of unitList field.
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasUnit

      public boolean hasUnit()
      Indicate whether an object is available for inputOutput MFNode field unitList.
      Returns:
      whether a concrete statement array or CommentsBlock is available.
      See Also:

    • addComponent

      public head addComponent(String componentName, int level)
      Add a child component statement.
      Parameters:
      componentName - name for component statement
      level - for component statement
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addUnit

      public head addUnit(String newName, String newCategory, float newConversionFactor)
      Add a child unit statement.
      Parameters:
      newName - name for this unit statement
      newCategory - category value for this unit statement
      newConversionFactor - conversion factor for this unit statement
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addUnit

      public head addUnit(String newName, String newCategory, double newConversionFactor)
      Add a child unit statement.
      Parameters:
      newName - name for this unit statement
      newCategory - category value for this unit statement
      newConversionFactor - conversion factor for this unit statement
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addMeta

      public head addMeta(String newName, String newDescription)
      Add a child meta statement.
      Parameters:
      newName - name for meta statement
      newDescription - description for meta statement
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addComments

      public head addComments(String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addComments

      public head addComments(String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public head addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      head - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • toStringX3D

      public 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:

    • toStringClassicVRML

      public 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:

    • toStringVRML97

      public 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:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue, 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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:

    • hasElementByNameValue

      public boolean hasElementByNameValue(String nameValue, 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:

    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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:

    • hasNodeByDEF

      public boolean hasNodeByDEF(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:

    • validate

      public 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)

    • findMetaByName

      public meta findMetaByName(String metaName)
      Find contained meta statement by name, if present.
      Parameters:
      metaName - is NMTOKEN name attribute for meta statement of interest
      Returns:
      meta reference of interest, null otherwise
      See Also:

    • hasMeta

      public boolean hasMeta(String metaName)
      Determine whether relevant meta statement is present.
      Parameters:
      metaName - is name attribute for meta statement of interest
      Returns:
      whether meta is found.
      See Also:

    • findComponentByName

      public component findComponentByName(String componentName)
      Find contained component statement by name, if present.
      Parameters:
      componentName - name for component statement
      Returns:
      component reference of interest, null otherwise
      See Also:

    • hasComponent

      public boolean hasComponent(String componentName)
      Determine whether relevant component statement is present.
      Parameters:
      componentName - name for component statement
      Returns:
      whether component is found.
      See Also:

    • findUnitByName

      public unit findUnitByName(String unitName)
      Find contained unit statement by name, if present.
      Parameters:
      unitName - is name attribute for unit statement of interest
      Returns:
      unit object reference of interest, null otherwise
      See Also:

    • hasUnit

      public boolean hasUnit(String unitName)
      Determine whether relevant unit statement is present.
      Parameters:
      unitName - is name attribute for unit statement of interest
      Returns:
      whether unit is found.
      See Also: