Package de.iip_ecosphere.platform.configuration.aas

Class AbstractAasElement

java.lang.Object
de.iip_ecosphere.platform.configuration.aas.AbstractAasElement
Direct Known Subclasses:
AasEnum, AasEnumLiteral, AasField, AasType
public class AbstractAasElement extends Object
Abstract superclass for AAS elements.
Author:
Holger Eichelberger, SSE

  • Field Details

    • idShort

      private String idShort

    • semanticId

      private String semanticId

    • isCaseOf

      private String isCaseOf

    • description

      private String description

    • hasMultiSemanticIds

      private boolean hasMultiSemanticIds

    • isGeneric

      private boolean isGeneric

    • displayName

      private String displayName

  • Constructor Details

    • AbstractAasElement

      public AbstractAasElement()
      Creates an instance.

    • AbstractAasElement

      public AbstractAasElement(AbstractAasElement elt)
      Copies values of elt.
      Parameters:
      elt - the source element

  • Method Details

    • setIdShort

      void setIdShort(String idShort)
      Defines the idShort.
      Parameters:
      idShort - the idShort without multi-value counting suffix.

    • getIdShort

      public String getIdShort()
      Returns the idShort without multi-value counting suffix.
      Returns:
      the idShort

    • setSemanticId

      void setSemanticId(String semanticId)
      Sets the semantic id of this field.
      Parameters:
      semanticId - the semantic id in format of the AAS abstraction of the platform, i.e., prefixed with identifier from IdentifierType, may be null for none

    • getSemanticId

      public String getSemanticId()
      Returns the semantic id of this field.
      Returns:
      the semantic id in format of the AAS abstraction of the platform, i.e., prefixed with identifier from IdentifierType, may be null for none

    • setMultiSemanticIds

      void setMultiSemanticIds(boolean hasMultiSemanticIds)
      Defines whether this field has multiple semantic ids, i.e., getSemanticId() returns a possible one.
      Parameters:
      hasMultiSemanticIds - if the field has multiple semantic ids

    • hasMultiSemanticIds

      public boolean hasMultiSemanticIds()
      Returns whether this field has multiple semantic ids, i.e., getSemanticId() returns a possible one.
      Returns:
      if the field has multiple semantic ids

    • setIsCaseOf

      void setIsCaseOf(String isCaseOf)
      Sets the "isCaseOf" semantic id.
      Parameters:
      isCaseOf - the "isCaseOf" semantic id in format of the AAS abstraction of the platform, i.e., prefixed with identifier from IdentifierType

    • getIsCaseOf

      public String getIsCaseOf()
      Returns "isCaseOf" semantic id.
      Returns:
      the semantic id in format of the AAS abstraction of the platform, i.e., prefixed with identifier from IdentifierType, may be null for none

    • isGeneric

      public boolean isGeneric()
      Returns whether this field is generic, i.e., an indication that further fields may be added.
      Returns:
      if the field is generic

    • setGeneric

      void setGeneric(boolean isGeneric)
      Changes whether this field is generic, i.e., an indication that further fields may be added.
      Parameters:
      isGeneric - if the field is generic

    • setDescription

      void setDescription(String description)
      Sets the description/explanation of this field. Adds a full stop to the end if there is none.
      Parameters:
      description - the description/explanation

    • getDescription

      public String getDescription()
      Returns the description/explanation.
      Returns:
      the description/explanation

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setDisplayName

      void setDisplayName(String displayName)
      Sets the display name.
      Parameters:
      displayName - the type name

    • getDisplayName

      public String getDisplayName()
      Returns the display name if defined or getIdShort().
      Returns:
      the display name