Class IMPORTObject

  • All Implemented Interfaces:
    X3DChildNode, X3DNode

    public class IMPORTObject
    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 http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#ImportExportsemantics
    See Also:
    X3D Abstract Specification: IMPORT, X3D Tooltips: IMPORT, X3D Scene Authoring Hints: InlinesPrototypes
    • Field Detail

      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: IMPORT.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the IMPORT element: Networking
        See Also:
        Constant Field Values
      • LEVEL

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

        public static final java.lang.String AS_DEFAULT_VALUE
        SFString field named AS has default value equal to an empty string.
        See Also:
        Constant Field Values
      • IMPORTEDDEF_DEFAULT_VALUE

        public static final java.lang.String IMPORTEDDEF_DEFAULT_VALUE
        SFString field named importedDEF has default value equal to an empty string.
        See Also:
        Constant Field Values
      • INLINEDEF_DEFAULT_VALUE

        public static final java.lang.String INLINEDEF_DEFAULT_VALUE
        SFString field named inlineDEF has default value equal to an empty string.
        See Also:
        Constant Field Values
    • Constructor Detail

      • IMPORTObject

        public IMPORTObject()
        Constructor for IMPORTObject to initialize member variables with default values.
    • Method Detail

      • getElementName

        public final java.lang.String getElementName()
        Provides name of this element: IMPORT
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.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 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 statement
        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 statement
        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 X3DConcreteStatement
      • getAS

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

        public IMPORTObject setAS​(SFStringObject newValue)
        Assign typed object value to SFString AS field, similar to setAS(String).
        Parameters:
        newValue - is new value for the AS field.
        Returns:
        IMPORTObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getImportedDEF

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

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

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

        public IMPORTObject setInlineDEF​(SFStringObject newValue)
        Assign typed object value to SFString inlineDEF field, similar to setInlineDEF(String).
        Parameters:
        newValue - is new value for the inlineDEF field.
        Returns:
        IMPORTObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addComments

        public IMPORTObject addComments​(java.lang.String newComment)
        Add comment as String to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComment - initial value
        Returns:
        IMPORTObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

        public IMPORTObject 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:
        IMPORTObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

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

        @Deprecated
        public IMPORTObject setDEF​(java.lang.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 IMPORTObject setUSE​(java.lang.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
      • setCssClass

        @Deprecated
        public IMPORTObject setCssClass​(java.lang.String newValue)
        Deprecated.