Package io.adminshell.aas.v3.model.impl

Class DefaultView

  • All Implemented Interfaces:
    HasDataSpecification, HasExtensions, HasSemantics, Referable, View
    public class DefaultView
extends java.lang.Object
implements View
    Default implementation of package io.adminshell.aas.v3.model.View A view is a collection of referable elements w.r.t. to a specific viewpoint of one or more stakeholders. Constraint AASd-064: If the semanticId of a View references a ConceptDescription then the category of the ConceptDescription shall be VIEW.

    • Field Detail

      • extensions

        protected java.util.List<Extension> extensions

      • category

        protected java.lang.String category

      • descriptions

        protected java.util.List<LangString> descriptions

      • displayNames

        protected java.util.List<LangString> displayNames

      • idShort

        protected java.lang.String idShort

      • containedElements

        protected java.util.List<Reference> containedElements

    • Constructor Detail

      • DefaultView

        public DefaultView()

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • getContainedElements

        public java.util.List<Reference> getContainedElements()
        Description copied from interface: View
        Referable elements that are contained in the view. More information under https://admin-shell.io/aas/3/0/RC01/View/containedElement
        Specified by:
        getContainedElements in interface View
        Returns:
        Returns the List of References for the property containedElements.

      • setContainedElements

        public void setContainedElements​(java.util.List<Reference> containedElements)
        Description copied from interface: View
        Referable elements that are contained in the view. More information under https://admin-shell.io/aas/3/0/RC01/View/containedElement
        Specified by:
        setContainedElements in interface View
        Parameters:
        containedElements - desired value for the property containedElements.

      • getCategory

        public java.lang.String getCategory()
        Description copied from interface: Referable
        The category is a value that gives further meta information w.r.t. to the class of the element. It affects the expected existence of attributes and the applicability of constraints. More information under https://admin-shell.io/aas/3/0/RC01/Referable/category
        Specified by:
        getCategory in interface Referable
        Returns:
        Returns the String for the property category.

      • setCategory

        public void setCategory​(java.lang.String category)
        Description copied from interface: Referable
        The category is a value that gives further meta information w.r.t. to the class of the element. It affects the expected existence of attributes and the applicability of constraints. More information under https://admin-shell.io/aas/3/0/RC01/Referable/category
        Specified by:
        setCategory in interface Referable
        Parameters:
        category - desired value for the property category.

      • getDescriptions

        public java.util.List<LangString> getDescriptions()
        Description copied from interface: Referable
        Description or comments on the element. The description can be provided in several languages. More information under https://admin-shell.io/aas/3/0/RC01/Referable/description
        Specified by:
        getDescriptions in interface Referable
        Returns:
        Returns the List of LangStrings for the property descriptions.

      • setDescriptions

        public void setDescriptions​(java.util.List<LangString> descriptions)
        Description copied from interface: Referable
        Description or comments on the element. The description can be provided in several languages. More information under https://admin-shell.io/aas/3/0/RC01/Referable/description
        Specified by:
        setDescriptions in interface Referable
        Parameters:
        descriptions - desired value for the property descriptions.

      • getDisplayNames

        public java.util.List<LangString> getDisplayNames()
        Description copied from interface: Referable
        Display name. Can be provided in several languages. More information under https://admin-shell.io/aas/3/0/RC01/Referable/displayName
        Specified by:
        getDisplayNames in interface Referable
        Returns:
        Returns the List of LangStrings for the property displayNames.

      • setDisplayNames

        public void setDisplayNames​(java.util.List<LangString> displayNames)
        Description copied from interface: Referable
        Display name. Can be provided in several languages. More information under https://admin-shell.io/aas/3/0/RC01/Referable/displayName
        Specified by:
        setDisplayNames in interface Referable
        Parameters:
        displayNames - desired value for the property displayNames.

      • getIdShort

        public java.lang.String getIdShort()
        Description copied from interface: Referable
        Identifying string of the element within its name space. Constraint AASd-002: idShort shall only feature letters, digits, underscore ('_'); starting with a small letter. I.e. [a-z][a-zA-Z0-9_]+. Constraint AASd-003: idShort shall be matched case-insensitive. Constraint AASd-022: idShort of non-identifiable referables shall be unqiue in its namespace. Note: In case the element is a property and the property has a semantic definition (HasSemantics) the idShort is typically identical to the short name in English. Note: In case of an identifiable element idShort is optional but recommended to be defined. It can be used for unique reference in its name space and thus allows better usability and a more performant implementation. In this case it is similar to the 'BrowserPath' in OPC UA. More information under https://admin-shell.io/aas/3/0/RC01/Referable/idShort
        Specified by:
        getIdShort in interface Referable
        Returns:
        Returns the String for the property idShort.

      • setIdShort

        public void setIdShort​(java.lang.String idShort)
        Description copied from interface: Referable
        Identifying string of the element within its name space. Constraint AASd-002: idShort shall only feature letters, digits, underscore ('_'); starting with a small letter. I.e. [a-z][a-zA-Z0-9_]+. Constraint AASd-003: idShort shall be matched case-insensitive. Constraint AASd-022: idShort of non-identifiable referables shall be unqiue in its namespace. Note: In case the element is a property and the property has a semantic definition (HasSemantics) the idShort is typically identical to the short name in English. Note: In case of an identifiable element idShort is optional but recommended to be defined. It can be used for unique reference in its name space and thus allows better usability and a more performant implementation. In this case it is similar to the 'BrowserPath' in OPC UA. More information under https://admin-shell.io/aas/3/0/RC01/Referable/idShort
        Specified by:
        setIdShort in interface Referable
        Parameters:
        idShort - desired value for the property idShort.

      • getExtensions

        public java.util.List<Extension> getExtensions()
        Description copied from interface: HasExtensions
        An extension of the element. More information under https://admin-shell.io/aas/3/0/RC01/HasExtensions/extension
        Specified by:
        getExtensions in interface HasExtensions
        Returns:
        Returns the List of Extensions for the property extensions.

      • setExtensions

        public void setExtensions​(java.util.List<Extension> extensions)
        Description copied from interface: HasExtensions
        An extension of the element. More information under https://admin-shell.io/aas/3/0/RC01/HasExtensions/extension
        Specified by:
        setExtensions in interface HasExtensions
        Parameters:
        extensions - desired value for the property extensions.

      • getEmbeddedDataSpecifications

        public java.util.List<EmbeddedDataSpecification> getEmbeddedDataSpecifications()
        Description copied from interface: HasDataSpecification
        Link to the included description of the Data Specification. More information under https://admin-shell.io/aas/3/0/RC01/HasDataSpecification/embeddedDataSpecification
        Specified by:
        getEmbeddedDataSpecifications in interface HasDataSpecification
        Returns:
        Returns the List of EmbeddedDataSpecifications for the property embeddedDataSpecifications.

      • setEmbeddedDataSpecifications

        public void setEmbeddedDataSpecifications​(java.util.List<EmbeddedDataSpecification> embeddedDataSpecifications)
        Description copied from interface: HasDataSpecification
        Link to the included description of the Data Specification. More information under https://admin-shell.io/aas/3/0/RC01/HasDataSpecification/embeddedDataSpecification
        Specified by:
        setEmbeddedDataSpecifications in interface HasDataSpecification
        Parameters:
        embeddedDataSpecifications - desired value for the property embeddedDataSpecifications.

      • getSemanticId

        public Reference getSemanticId()
        Description copied from interface: HasSemantics
        Points to the Expression Semantic of the Submodels The semantic id might refer to an external information source, which explains the formulation of the submodel (for example an PDF if a standard). More information under https://admin-shell.io/aas/3/0/RC01/HasSemantics/semanticId
        Specified by:
        getSemanticId in interface HasSemantics
        Returns:
        Returns the Reference for the property semanticId.

      • setSemanticId

        public void setSemanticId​(Reference semanticId)
        Description copied from interface: HasSemantics
        Points to the Expression Semantic of the Submodels The semantic id might refer to an external information source, which explains the formulation of the submodel (for example an PDF if a standard). More information under https://admin-shell.io/aas/3/0/RC01/HasSemantics/semanticId
        Specified by:
        setSemanticId in interface HasSemantics
        Parameters:
        semanticId - desired value for the property semanticId.