Package org.web3d.x3d.jsail.Networking

Class IMPORT

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteStatement
org.web3d.x3d.jsail.Networking.IMPORT
All Implemented Interfaces:
X3DChildNode, X3DNode
public class IMPORT extends X3DConcreteStatement implements X3DChildNode
Functional summary: IMPORT provides ROUTE access to a node that has a corresponding EXPORT statement within an Inline scene. These connections allow event values to be exchanged via ROUTE statements between a parent model and a child Inline model. This concrete class represents an X3D IMPORT statement.

X3D statement tooltip: [X3D statement] IMPORT provides ROUTE access to a node that has a corresponding EXPORT statement within an Inline scene. These connections allow event values to be passed via ROUTE statements between a parent model and a child Inline model. Hint: it is good practice to place IMPORT statements next to corresponding Inline scenes for readability. Hint: see EXPORT statement for corresponding functionality within the related Inline model. Warning: corresponding parent-scene IMPORT and child Inline-scene EXPORT statements are necessary in order to ROUTE values between a parent model and a child Inline model. Hint: X3D Architecture 4.4.6 Import/Export semantics <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/concepts.html#ImportExportsemantics" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/concepts.html#ImportExportsemantics</a> *

See Also:

  • Field Details

    • NAME

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

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the IMPORT element: Networking
      See Also:

    • LEVEL

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

    • AS_DEFAULT_VALUE

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

    • IMPORTEDDEF_DEFAULT_VALUE

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

    • INLINEDEF_DEFAULT_VALUE

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

  • Constructor Details

    • IMPORT

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

  • Method Details

    • getElementName

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

    • getComponent

      public final String getComponent()
      Defines X3D component for the IMPORT element: Networking
      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: 3
      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

    • getAS

      public String getAS()
      Provide String value from inputOutput SFString field named AS.

      Tooltip: map importedDEF name AS a new name in current scene. Hint: optional, default export is importedDEF node name. *
      Returns:
      value of AS field

    • setAS

      public IMPORT setAS(String newValue)
      Accessor method to assign String value to inputOutput SFString field named AS.

      Tooltip: map importedDEF name AS a new name in current scene. Hint: optional, default export is importedDEF node name. *
      Parameters:
      newValue - is new value for the AS field.
      Returns:
      IMPORT - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setAS

      public IMPORT setAS(SFString newValue)
      Assign typed object value to SFString AS field, similar to setAS(String). // #0.e
      Parameters:
      newValue - is new value for the AS field.
      Returns:
      IMPORT - 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 IMPORT 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:
      IMPORT - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCssClass

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

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

    • setHtmlID

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

    • getImportedDEF

      public String getImportedDEF()
      Provide String value from inputOutput SFString field named importedDEF.

      Tooltip: importedDEF is DEF name of the node of interest that is contained in the remote inlineDEF scene. Hint: required. *
      Returns:
      value of importedDEF field

    • setImportedDEF

      public IMPORT setImportedDEF(String newValue)
      Accessor method to assign String value to inputOutput SFString field named importedDEF.

      Tooltip: importedDEF is DEF name of the node of interest that is contained in the remote inlineDEF scene. Hint: required. *
      Parameters:
      newValue - is new value for the importedDEF field.
      Returns:
      IMPORT - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setImportedDEF

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

    • getInlineDEF

      public String getInlineDEF()
      Provide String value from inputOutput SFString field named inlineDEF.

      Tooltip: inlineDEF is the DEF name of Inline node in the same scene as this IMPORT statement. Warning: the inlineDEF Inline scene must similarly include a corresponding EXPORT statement. *
      Returns:
      value of inlineDEF field

    • setInlineDEF

      public IMPORT setInlineDEF(String newValue)
      Accessor method to assign String value to inputOutput SFString field named inlineDEF.

      Tooltip: inlineDEF is the DEF name of Inline node in the same scene as this IMPORT statement. Warning: the inlineDEF Inline scene must similarly include a corresponding EXPORT statement. *
      Parameters:
      newValue - is new value for the inlineDEF field.
      Returns:
      IMPORT - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setInlineDEF

      public IMPORT setInlineDEF(SFString newValue)
      Assign typed object value to SFString inlineDEF field, similar to setInlineDEF(String). // #0.e
      Parameters:
      newValue - is new value for the inlineDEF field.
      Returns:
      IMPORT - 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 IMPORT 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:
      IMPORT - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCssStyle

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

    • addComments

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

    • addComments

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

    • addComments

      public IMPORT addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      IMPORT - 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)

    • 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 IMPORT 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 IMPORT 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 IMPORT 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