Class DISEntityTypeMappingObject

    • Field Detail

      • NAME

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

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

        public static final int LEVEL
        Integer constant LEVEL provides default X3D DIS component level for this element: 2
        See Also:
        Constant Field Values
      • CATEGORY_DEFAULT_VALUE

        public static final int CATEGORY_DEFAULT_VALUE
        SFInt32 field named category has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • COUNTRY_DEFAULT_VALUE

        public static final int COUNTRY_DEFAULT_VALUE
        SFInt32 field named country has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • DOMAIN_DEFAULT_VALUE

        public static final int DOMAIN_DEFAULT_VALUE
        SFInt32 field named domain has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • EXTRA_DEFAULT_VALUE

        public static final int EXTRA_DEFAULT_VALUE
        SFInt32 field named extra has default value 0 (Java syntax) or 0 (XML syntax).
        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).
      • KIND_DEFAULT_VALUE

        public static final int KIND_DEFAULT_VALUE
        SFInt32 field named kind has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • METADATA_DEFAULT_VALUE

        public static final X3DMetadataObject METADATA_DEFAULT_VALUE
        SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
      • SPECIFIC_DEFAULT_VALUE

        public static final int SPECIFIC_DEFAULT_VALUE
        SFInt32 field named specific has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • SUBCATEGORY_DEFAULT_VALUE

        public static final int SUBCATEGORY_DEFAULT_VALUE
        SFInt32 field named subcategory has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • URL_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> URL_DEFAULT_VALUE
        MFString field named url 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_URL

        public static final java.lang.String fromField_URL
        fromField ROUTE name for MFString field named url.
        See Also:
        Constant Field Values
      • toField_URL

        public static final java.lang.String toField_URL
        toField ROUTE name for MFString field named url.
        See Also:
        Constant Field Values
    • Constructor Detail

      • DISEntityTypeMappingObject

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

        public DISEntityTypeMappingObject​(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
    • Method Detail

      • getElementName

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

        public final java.lang.String getComponent()
        Defines X3D component for the DISEntityTypeMapping element: DIS
        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 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
      • getCategory

        public int getCategory()
        Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named category.

        Tooltip: Integer enumerations value for main category that describes the entity, semantics of each code varies according to domain. See DIS Enumerations values. *
        Specified by:
        getCategory in interface DISEntityTypeMapping
        Returns:
        value of category field
      • setCategory

        public DISEntityTypeMappingObject setCategory​(int newValue)
        Accessor method to assign int value to initializeOnly SFInt32 field named category.

        Tooltip: Integer enumerations value for main category that describes the entity, semantics of each code varies according to domain. See DIS Enumerations values. *
        Specified by:
        setCategory in interface DISEntityTypeMapping
        Parameters:
        newValue - is new value for the category field.
        Returns:
        DISEntityTypeMappingObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getCountry

        public int getCountry()
        Provide int value within allowed range of [0,65535] from initializeOnly SFInt32 field named country.

        Tooltip: Integer enumerations value for country to which the design of the entity or its design specification is attributed. *
        Specified by:
        getCountry in interface DISEntityTypeMapping
        Returns:
        value of country field
      • setCountry

        public DISEntityTypeMappingObject setCountry​(int newValue)
        Accessor method to assign int value to initializeOnly SFInt32 field named country.

        Tooltip: Integer enumerations value for country to which the design of the entity or its design specification is attributed. *
        Specified by:
        setCountry in interface DISEntityTypeMapping
        Parameters:
        newValue - is new value for the country field.
        Returns:
        DISEntityTypeMappingObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getDomain

        public int getDomain()
        Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named domain.

        Tooltip: Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER. *
        Specified by:
        getDomain in interface DISEntityTypeMapping
        Returns:
        value of domain field
      • setDomain

        public DISEntityTypeMappingObject setDomain​(int newValue)
        Accessor method to assign int value to initializeOnly SFInt32 field named domain.

        Tooltip: Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER. *
        Specified by:
        setDomain in interface DISEntityTypeMapping
        Parameters:
        newValue - is new value for the domain field.
        Returns:
        DISEntityTypeMappingObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getExtra

        public int getExtra()
        Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named extra.

        Tooltip: Any extra information required to describe a particular entity. The contents of this field shall depend on the type of entity represented. *
        Specified by:
        getExtra in interface DISEntityTypeMapping
        Returns:
        value of extra field
      • setExtra

        public DISEntityTypeMappingObject setExtra​(int newValue)
        Accessor method to assign int value to initializeOnly SFInt32 field named extra.

        Tooltip: Any extra information required to describe a particular entity. The contents of this field shall depend on the type of entity represented. *
        Specified by:
        setExtra in interface DISEntityTypeMapping
        Parameters:
        newValue - is new value for the extra field.
        Returns:
        DISEntityTypeMappingObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • 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()
      • getKind

        public int getKind()
        Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named kind.

        Tooltip: Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER. *
        Specified by:
        getKind in interface DISEntityTypeMapping
        Returns:
        value of kind field
      • setKind

        public DISEntityTypeMappingObject setKind​(int newValue)
        Accessor method to assign int value to initializeOnly SFInt32 field named kind.

        Tooltip: Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER. *
        Specified by:
        setKind in interface DISEntityTypeMapping
        Parameters:
        newValue - is new value for the kind field.
        Returns:
        DISEntityTypeMappingObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearMetadata

        public DISEntityTypeMappingObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        DISEntityTypeMappingObject - 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
      • getSpecific

        public int getSpecific()
        Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named specific.

        Tooltip: Specific information about an entity based on the Subcategory field. See DIS Enumerations values. *
        Specified by:
        getSpecific in interface DISEntityTypeMapping
        Returns:
        value of specific field
      • setSpecific

        public DISEntityTypeMappingObject setSpecific​(int newValue)
        Accessor method to assign int value to initializeOnly SFInt32 field named specific.

        Tooltip: Specific information about an entity based on the Subcategory field. See DIS Enumerations values. *
        Specified by:
        setSpecific in interface DISEntityTypeMapping
        Parameters:
        newValue - is new value for the specific field.
        Returns:
        DISEntityTypeMappingObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getSubcategory

        public int getSubcategory()
        Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named subcategory.
        Specified by:
        getSubcategory in interface DISEntityTypeMapping
        Returns:
        value of subcategory field
      • setSubcategory

        public DISEntityTypeMappingObject setSubcategory​(int newValue)
        Accessor method to assign int value to initializeOnly SFInt32 field named subcategory.
        Specified by:
        setSubcategory in interface DISEntityTypeMapping
        Parameters:
        newValue - is new value for the subcategory field.
        Returns:
        DISEntityTypeMappingObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getUrlList

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

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

        public DISEntityTypeMappingObject setUrl​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString url field, similar to setUrl(String[]).
        Parameters:
        newValue - is new value for the url field.
        Returns:
        DISEntityTypeMappingObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearUrl

        public DISEntityTypeMappingObject clearUrl()
        Utility method to clear MFString value of url field.
        Returns:
        DISEntityTypeMappingObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setDEF

        public final DISEntityTypeMappingObject setDEF​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named DEF.

        Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

        Note that setting the DEF value clears the USE value.
        Specified by:
        setDEF in class X3DConcreteNode
        Parameters:
        newValue - is new value for the DEF field.
        Returns:
        DISEntityTypeMappingObject - 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 DISEntityTypeMappingObject 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:
        DISEntityTypeMappingObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getCssClass

        public java.lang.String getCssClass()
        Provide String value from inputOutput SFString field named class.

        Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
        • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
        • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
        Overrides:
        getCssClass in class X3DConcreteNode
        Returns:
        value of class field
        See Also:
        W3C Cascading Style Sheets
      • setCssClass

        public final DISEntityTypeMappingObject setCssClass​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named class.

        Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
        • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
        • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
        Specified by:
        setCssClass in class X3DConcreteNode
        Parameters:
        newValue - is new value for the class field.
        Returns:
        DISEntityTypeMappingObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        W3C Cascading Style Sheets
      • setUSE

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

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