Class ExternProtoDeclare

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteStatement
org.web3d.x3d.jsail.Core.ExternProtoDeclare
All Implemented Interfaces:
X3DChildNode, X3DNode
public class ExternProtoDeclare extends X3DConcreteStatement implements X3DChildNode
ExternProtoDeclare refers to a ProtoDeclare node declaration provided in another file. ExternProtoDeclare interfaces are defined by field statements (and without IS/connect statements). This concrete class represents an X3D ExternProtoDeclare statement.

ExternProtoDeclare statement tooltip: ExternProtoDeclare refers to a ProtoDeclare node declaration provided in another file. ExternProtoDeclare interfaces are defined by <field> statements (without IS/connect statements).
See Also:

  • Field Details

    • NAME

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

    • COMPONENT

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

    • LEVEL

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

    • APPINFO_DEFAULT_VALUE

      public static final String APPINFO_DEFAULT_VALUE
      SFString field named appinfo has default value equal to an empty string.
      See Also:

    • DOCUMENTATION_DEFAULT_VALUE

      public static final String DOCUMENTATION_DEFAULT_VALUE
      SFString field named documentation has default value equal to an empty string.
      See Also:

    • NAME_DEFAULT_VALUE

      public static final String NAME_DEFAULT_VALUE
      SFString field named name has default value equal to an empty string.
      See Also:

    • URL_DEFAULT_VALUE

      public static final ArrayList<String> URL_DEFAULT_VALUE
      MFString field named url has default value equal to an empty list.

  • Constructor Details

    • ExternProtoDeclare

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

    • ExternProtoDeclare

      public ExternProtoDeclare(String prototypeName)
      Utility constructor that assigns ExternProtoDeclare name after initializing member variables with default values.
      Parameters:
      prototypeName - initial name for this ExternProtoDeclare statement

  • Method Details

    • getElementName

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

    • getComponent

      public final String getComponent()
      Defines X3D component for the ExternProtoDeclare 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: 2
      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

    • getAppinfo

      public String getAppinfo()
      Provide String value from inputOutput SFString field named appinfo.

      Tooltip: Application information to provide simple description usable as a tooltip, similar to XML Schema appinfo tag. *
      Returns:
      value of appinfo field

    • setAppinfo

      public ExternProtoDeclare setAppinfo(String newValue)
      Accessor method to assign String value to inputOutput SFString field named appinfo.

      Tooltip: Application information to provide simple description usable as a tooltip, similar to XML Schema appinfo tag. *
      Parameters:
      newValue - is new value for the appinfo field.
      Returns:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setAppinfo

      public ExternProtoDeclare setAppinfo(SFString newValue)
      Assign typed object value to SFString appinfo field, similar to setAppinfo(String).
      Parameters:
      newValue - is new value for the appinfo field.
      Returns:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • 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 ExternProtoDeclare 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:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCssClass

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

    • getDocumentation

      public String getDocumentation()
      Provide String value from inputOutput SFString field named documentation.

      Tooltip: Documentation url for further information, similar to XML Schema documentation tag. *
      Returns:
      value of documentation field

    • setDocumentation

      public ExternProtoDeclare setDocumentation(String newValue)
      Accessor method to assign String value to inputOutput SFString field named documentation.

      Tooltip: Documentation url for further information, similar to XML Schema documentation tag. *
      Parameters:
      newValue - is new value for the documentation field.
      Returns:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDocumentation

      public ExternProtoDeclare setDocumentation(SFString newValue)
      Assign typed object value to SFString documentation field, similar to setDocumentation(String).
      Parameters:
      newValue - is new value for the documentation field.
      Returns:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getFieldList

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

      Tooltip: Include a field statement for each field declaration in the corresponding original ProtoDeclare.
      • Warning: do not include initialization values in these field declarations since the original ProtoDeclare takes precedence.


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

    • setFieldList

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

      Tooltip: Include a field statement for each field declaration in the corresponding original ProtoDeclare.
      • Warning: do not include initialization values in these field declarations since the original ProtoDeclare takes precedence.


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

    • setField

      public ExternProtoDeclare setField(field newValue)
      Set single child field node, replacing prior array of existing nodes (if any).

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

    • clearField

      public ExternProtoDeclare clearField()
      Utility method to clear MFNode value of fieldList field. This method does not initialize withFIELD_DEFAULT_VALUE.
      Returns:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasField

      public boolean hasField()
      Indicate whether an object is available for inputOutput MFNode field fieldList.
      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 ExternProtoDeclare 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:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setHtmlID

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

    • getName

      public String getName()
      Provide String value from inputOutput SFString field named name.

      Tooltip: name of the ExternProtoDeclare (External Prototype Declaration) being referenced.
      Returns:
      value of name field

    • setName

      public final ExternProtoDeclare setName(String newValue)
      Accessor method to assign String value to inputOutput SFString field named name.

      Tooltip: name of the ExternProtoDeclare (External Prototype Declaration) being referenced.

      @see X3D Scene Authoring Hints: Naming Conventions
      Parameters:
      newValue - is new value for the name field.
      Returns:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setName

      public ExternProtoDeclare setName(SFString newValue)
      Assign typed object value to SFString name field, similar to setName(String).
      Parameters:
      newValue - is new value for the name field.
      Returns:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • 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 ExternProtoDeclare 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:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCssStyle

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

    • getUrl

      public String[] getUrl()
      Provide array of String results from inputOutput MFString field named url.

      Tooltip: Location and filename of ProtoDeclare source declaration of interest. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
      • Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
      Returns:
      value of url field

    • getUrlList

      public ArrayList<String> getUrlList()
      Utility method to get ArrayList value of MFString url field, similar to getUrl().
      Returns:
      value of url field

    • setUrl

      public ExternProtoDeclare setUrl(String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named url.

      Tooltip: Location and filename of ProtoDeclare source declaration of interest. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
      • Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
      Parameters:
      newValue - is new value for the url field.
      Returns:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUrl

      public ExternProtoDeclare setUrl(MFString newValue)
      Assign typed object value to MFString url field, similar to setUrl(String[]).
      Parameters:
      newValue - is new value for the url field.
      Returns:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearUrl

      public ExternProtoDeclare clearUrl()
      Utility method to clear MFString value of url field. This method does not initialize withURL_DEFAULT_VALUE.
      Returns:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addUrl

      public ExternProtoDeclare addUrl(String newValue)
      Add singleton String value to MFString url field.
      Parameters:
      newValue - is new value to add to the url field.
      Returns:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addUrl

      public ExternProtoDeclare addUrl(SFString newValue)
      Add singleton SFString value to MFString url field.
      Parameters:
      newValue - is new value to add to the url field.
      Returns:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getNodeType

      public String getNodeType()
      (Warning: not yet supported in ExternProtoDeclare implementation, TODO) This method helps determine node type of ProtoInstance by inspecting first node within corresponding ProtoDeclare ProtoBody.
      Returns:
      name of X3D node corresponding to node type for this ExternProtoDeclare statement
      See Also:

    • addComments

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

    • addComments

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

    • addComments

      public ExternProtoDeclare addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      ExternProtoDeclare - 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. TODO document specific validation methods.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)

    • addField

      public ExternProtoDeclare addField(field newField)
      Add field to fieldList for this ExternProtoDeclare
      Parameters:
      newField - is field to add
      Returns:
      ExternProtoDeclare - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • findFieldByName

      public field findFieldByName(String fieldName)
      Find contained field statement by name, if present.
      Parameters:
      fieldName - is name attribute for field of interest
      Returns:
      field reference of interest, null otherwise

    • removeField

      public boolean removeField(field fieldToRemove)
      Remove a field from contained fieldList
      Parameters:
      fieldToRemove - matching field of interest
      Returns:
      whether field was removed
      See Also:

    • removeField

      public boolean removeField(String fieldName)
      Remove a field by name from contained fieldList
      Parameters:
      fieldName - matching field of interest
      Returns:
      whether field was removed
      See Also:

    • clearFields

      public void clearFields()
      Clear all fields

    • hasField

      public boolean hasField(String fieldName)
      Determine if field statement is present.
      Parameters:
      fieldName - is name attribute for field of interest
      Returns:
      whether field is found

    • getMetadata

      @Deprecated public X3DMetadataObject getMetadata()
      Deprecated.
      DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      null, this method is deprecated and has no effect
      See Also:

    • setMetadata

      @Deprecated public ExternProtoDeclare setMetadata(X3DMetadataObject newValue)
      Deprecated.
      DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - ignored
      Returns:
      unmodified object, this method is deprecated and has no effect
      See Also:

    • setDEF

      @Deprecated public ExternProtoDeclare setDEF(String newValue)
      Deprecated.
      DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
      Parameters:
      newValue - ignored
      Returns:
      unmodified object, this method is deprecated and has no effect

    • setUSE

      @Deprecated public ExternProtoDeclare setUSE(String newValue)
      Deprecated.
      DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
      Parameters:
      newValue - ignored
      Returns:
      unmodified object, this method is deprecated and has no effect