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

Class DefaultEntity

  • All Implemented Interfaces:
    Entity, HasDataSpecification, HasExtensions, HasKind, HasSemantics, Qualifiable, Referable, SubmodelElement
    public class DefaultEntity
extends java.lang.Object
implements Entity
    Default implementation of package io.adminshell.aas.v3.model.Entity An entity is a submodel element that is used to model entities. Constraint AASd-056: The semanticId of a Entity submodel element shall only reference a ConceptDescription with the category ENTITY. The ConceptDescription describes the elements assigned to the entity via Entity/statement.

    • Constructor Detail

      • DefaultEntity

        public DefaultEntity()

    • 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

      • getGlobalAssetId

        public Reference getGlobalAssetId()
        Description copied from interface: Entity
        Reference to the asset the entity is representing. The asset attribute must be set if entityType is set to 'SelfManagedEntity'. It is empty otherwise. Constraint AASd-014: Either the attribute globalAssetId or externalAssetId of an Entity must be set if Entity/entityType is set to 'SelfManagedEntity'. They are not existing otherwise. More information under https://admin-shell.io/aas/3/0/RC01/Entity/globalAssetId
        Specified by:
        getGlobalAssetId in interface Entity
        Returns:
        Returns the Reference for the property globalAssetId.

      • setGlobalAssetId

        public void setGlobalAssetId​(Reference globalAssetId)
        Description copied from interface: Entity
        Reference to the asset the entity is representing. The asset attribute must be set if entityType is set to 'SelfManagedEntity'. It is empty otherwise. Constraint AASd-014: Either the attribute globalAssetId or externalAssetId of an Entity must be set if Entity/entityType is set to 'SelfManagedEntity'. They are not existing otherwise. More information under https://admin-shell.io/aas/3/0/RC01/Entity/globalAssetId
        Specified by:
        setGlobalAssetId in interface Entity
        Parameters:
        globalAssetId - desired value for the property globalAssetId.

      • getSpecificAssetId

        public IdentifierKeyValuePair getSpecificAssetId()
        Description copied from interface: Entity
        Reference to an identifier key value pair representing an external identifier of the asset represented by the asset administration shell. The asset attribute must be set if entityType is set to 'SelfManagedEntity'. It is empty otherwise. Constraint AASd-014: Either the attribute globalAssetId or externalAssetId of an Entity must be set if Entity/entityType is set to 'SelfManagedEntity'. They are not existing otherwise. More information under https://admin-shell.io/aas/3/0/RC01/Entity/specificAssetId
        Specified by:
        getSpecificAssetId in interface Entity
        Returns:
        Returns the IdentifierKeyValuePair for the property specificAssetId.

      • setSpecificAssetId

        public void setSpecificAssetId​(IdentifierKeyValuePair specificAssetId)
        Description copied from interface: Entity
        Reference to an identifier key value pair representing an external identifier of the asset represented by the asset administration shell. The asset attribute must be set if entityType is set to 'SelfManagedEntity'. It is empty otherwise. Constraint AASd-014: Either the attribute globalAssetId or externalAssetId of an Entity must be set if Entity/entityType is set to 'SelfManagedEntity'. They are not existing otherwise. More information under https://admin-shell.io/aas/3/0/RC01/Entity/specificAssetId
        Specified by:
        setSpecificAssetId in interface Entity
        Parameters:
        specificAssetId - desired value for the property specificAssetId.

      • getEntityType

        public EntityType getEntityType()
        Description copied from interface: Entity
        Describes whether the entity is a co-managed entity or a self-managed entity. More information under https://admin-shell.io/aas/3/0/RC01/Entity/entityType
        Specified by:
        getEntityType in interface Entity
        Returns:
        Returns the EntityType for the property entityType.

      • setEntityType

        public void setEntityType​(EntityType entityType)
        Description copied from interface: Entity
        Describes whether the entity is a co-managed entity or a self-managed entity. More information under https://admin-shell.io/aas/3/0/RC01/Entity/entityType
        Specified by:
        setEntityType in interface Entity
        Parameters:
        entityType - desired value for the property entityType.

      • getStatements

        public java.util.List<SubmodelElement> getStatements()
        Description copied from interface: Entity
        Describes statements applicable to the entity by a set of submodel elements, typically with a qualified value. More information under https://admin-shell.io/aas/3/0/RC01/Entity/statement
        Specified by:
        getStatements in interface Entity
        Returns:
        Returns the List of SubmodelElements for the property statements.

      • setStatements

        public void setStatements​(java.util.List<SubmodelElement> statements)
        Description copied from interface: Entity
        Describes statements applicable to the entity by a set of submodel elements, typically with a qualified value. More information under https://admin-shell.io/aas/3/0/RC01/Entity/statement
        Specified by:
        setStatements in interface Entity
        Parameters:
        statements - desired value for the property statements.

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

      • getQualifiers

        public java.util.List<Constraint> getQualifiers()
        Description copied from interface: Qualifiable
        Additional qualification of a qualifiable element. More information under https://admin-shell.io/aas/3/0/RC01/Qualifiable/qualifier
        Specified by:
        getQualifiers in interface Qualifiable
        Returns:
        Returns the List of Constraints for the property qualifiers.

      • setQualifiers

        public void setQualifiers​(java.util.List<Constraint> qualifiers)
        Description copied from interface: Qualifiable
        Additional qualification of a qualifiable element. More information under https://admin-shell.io/aas/3/0/RC01/Qualifiable/qualifier
        Specified by:
        setQualifiers in interface Qualifiable
        Parameters:
        qualifiers - desired value for the property qualifiers.

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

      • getKind

        public ModelingKind getKind()
        Description copied from interface: HasKind
        ModelingKind of the element: either type or instance. More information under https://admin-shell.io/aas/3/0/RC01/HasKind/kind
        Specified by:
        getKind in interface HasKind
        Returns:
        Returns the ModelingKind for the property kind.

      • setKind

        public void setKind​(ModelingKind kind)
        Description copied from interface: HasKind
        ModelingKind of the element: either type or instance. More information under https://admin-shell.io/aas/3/0/RC01/HasKind/kind
        Specified by:
        setKind in interface HasKind
        Parameters:
        kind - desired value for the property kind.

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