Class DefaultDataSpecificationIEC61360

  • All Implemented Interfaces:
    DataSpecificationContent, DataSpecificationIEC61360

    public class DefaultDataSpecificationIEC61360
    extends java.lang.Object
    implements DataSpecificationIEC61360
    Default implementation of package io.adminshell.aas.v3.model.DataSpecificationIEC61360 Data Specification Template for defining Property Descriptions conformant to IEC 61360. Constraint AASd-075: For all ConceptDescriptions using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) values for the attributes not being marked as mandatory or optional in tables Table 9, Table 10, Table 11 and Table 12.depending on its category are ignored and handled as undefined.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DefaultDataSpecificationIEC61360.Builder
      This builder class can be used to construct a DefaultDataSpecificationIEC61360 bean.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      DataTypeIEC61360 getDataType()
      Constraint AASd-070: For a ConceptDescription with category PROPERTY or VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is mandatory and shall be defined.
      java.util.List<LangString> getDefinitions()
      Constraint AASd-074: For all ConceptDescriptions except for ConceptDescriptions of category VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/definition is mandatory and shall be defined at least in English.
      java.util.List<LevelType> getLevelTypes()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/levelType
      java.util.List<LangString> getPreferredNames()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/preferredName
      java.util.List<LangString> getShortNames()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/shortName
      java.lang.String getSourceOfDefinition()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/sourceOfDefinition
      java.lang.String getSymbol()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/symbol
      java.lang.String getUnit()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unit
      Reference getUnitId()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unitId
      java.lang.String getValue()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/value
      java.lang.String getValueFormat()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueFormat
      Reference getValueId()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueId
      ValueList getValueList()
      The Type 'ValueList' lists all the allowed values for a concept description for which the allowed values are listed in an enumeration.
      int hashCode()  
      void setDataType​(DataTypeIEC61360 dataType)
      Constraint AASd-070: For a ConceptDescription with category PROPERTY or VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is mandatory and shall be defined.
      void setDefinitions​(java.util.List<LangString> definitions)
      Constraint AASd-074: For all ConceptDescriptions except for ConceptDescriptions of category VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/definition is mandatory and shall be defined at least in English.
      void setLevelTypes​(java.util.List<LevelType> levelTypes)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/levelType
      void setPreferredNames​(java.util.List<LangString> preferredNames)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/preferredName
      void setShortNames​(java.util.List<LangString> shortNames)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/shortName
      void setSourceOfDefinition​(java.lang.String sourceOfDefinition)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/sourceOfDefinition
      void setSymbol​(java.lang.String symbol)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/symbol
      void setUnit​(java.lang.String unit)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unit
      void setUnitId​(Reference unitId)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unitId
      void setValue​(java.lang.String value)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/value
      void setValueFormat​(java.lang.String valueFormat)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueFormat
      void setValueId​(Reference valueId)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueId
      void setValueList​(ValueList valueList)
      The Type 'ValueList' lists all the allowed values for a concept description for which the allowed values are listed in an enumeration.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • definitions

        protected java.util.List<LangString> definitions
      • levelTypes

        protected java.util.List<LevelType> levelTypes
      • preferredNames

        protected java.util.List<LangString> preferredNames
      • shortNames

        protected java.util.List<LangString> shortNames
      • sourceOfDefinition

        protected java.lang.String sourceOfDefinition
      • symbol

        protected java.lang.String symbol
      • unit

        protected java.lang.String unit
      • value

        protected java.lang.String value
      • valueFormat

        protected java.lang.String valueFormat
    • Constructor Detail

      • DefaultDataSpecificationIEC61360

        public DefaultDataSpecificationIEC61360()
    • 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
      • getDataType

        public DataTypeIEC61360 getDataType()
        Description copied from interface: DataSpecificationIEC61360
        Constraint AASd-070: For a ConceptDescription with category PROPERTY or VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is mandatory and shall be defined. Constraint AASd-071: For a ConceptDescription with category REFERENCE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is STRING by default. Constraint AASd-072: For a ConceptDescription with category DOCUMENT using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType shall be one of the following values: STRING or URL. Constraint AASd-073: For a ConceptDescription with category QUALIFIER using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is mandatory and shall be defined. More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/dataType
        Specified by:
        getDataType in interface DataSpecificationIEC61360
        Returns:
        Returns the DataTypeIEC61360 for the property dataType.
      • setDataType

        public void setDataType​(DataTypeIEC61360 dataType)
        Description copied from interface: DataSpecificationIEC61360
        Constraint AASd-070: For a ConceptDescription with category PROPERTY or VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is mandatory and shall be defined. Constraint AASd-071: For a ConceptDescription with category REFERENCE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is STRING by default. Constraint AASd-072: For a ConceptDescription with category DOCUMENT using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType shall be one of the following values: STRING or URL. Constraint AASd-073: For a ConceptDescription with category QUALIFIER using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is mandatory and shall be defined. More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/dataType
        Specified by:
        setDataType in interface DataSpecificationIEC61360
        Parameters:
        dataType - desired value for the property dataType.
      • getDefinitions

        public java.util.List<LangString> getDefinitions()
        Description copied from interface: DataSpecificationIEC61360
        Constraint AASd-074: For all ConceptDescriptions except for ConceptDescriptions of category VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/definition is mandatory and shall be defined at least in English. More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/definition
        Specified by:
        getDefinitions in interface DataSpecificationIEC61360
        Returns:
        Returns the List of LangStrings for the property definitions.
      • setDefinitions

        public void setDefinitions​(java.util.List<LangString> definitions)
        Description copied from interface: DataSpecificationIEC61360
        Constraint AASd-074: For all ConceptDescriptions except for ConceptDescriptions of category VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/definition is mandatory and shall be defined at least in English. More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/definition
        Specified by:
        setDefinitions in interface DataSpecificationIEC61360
        Parameters:
        definitions - desired value for the property definitions.
      • getLevelTypes

        public java.util.List<LevelType> getLevelTypes()
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/levelType
        Specified by:
        getLevelTypes in interface DataSpecificationIEC61360
        Returns:
        Returns the List of LevelTypes for the property levelTypes.
      • setLevelTypes

        public void setLevelTypes​(java.util.List<LevelType> levelTypes)
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/levelType
        Specified by:
        setLevelTypes in interface DataSpecificationIEC61360
        Parameters:
        levelTypes - desired value for the property levelTypes.
      • getPreferredNames

        public java.util.List<LangString> getPreferredNames()
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/preferredName
        Specified by:
        getPreferredNames in interface DataSpecificationIEC61360
        Returns:
        Returns the List of LangStrings for the property preferredNames.
      • setPreferredNames

        public void setPreferredNames​(java.util.List<LangString> preferredNames)
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/preferredName
        Specified by:
        setPreferredNames in interface DataSpecificationIEC61360
        Parameters:
        preferredNames - desired value for the property preferredNames.
      • getShortNames

        public java.util.List<LangString> getShortNames()
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/shortName
        Specified by:
        getShortNames in interface DataSpecificationIEC61360
        Returns:
        Returns the List of LangStrings for the property shortNames.
      • setShortNames

        public void setShortNames​(java.util.List<LangString> shortNames)
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/shortName
        Specified by:
        setShortNames in interface DataSpecificationIEC61360
        Parameters:
        shortNames - desired value for the property shortNames.
      • getSourceOfDefinition

        public java.lang.String getSourceOfDefinition()
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/sourceOfDefinition
        Specified by:
        getSourceOfDefinition in interface DataSpecificationIEC61360
        Returns:
        Returns the String for the property sourceOfDefinition.
      • setSourceOfDefinition

        public void setSourceOfDefinition​(java.lang.String sourceOfDefinition)
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/sourceOfDefinition
        Specified by:
        setSourceOfDefinition in interface DataSpecificationIEC61360
        Parameters:
        sourceOfDefinition - desired value for the property sourceOfDefinition.
      • getSymbol

        public java.lang.String getSymbol()
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/symbol
        Specified by:
        getSymbol in interface DataSpecificationIEC61360
        Returns:
        Returns the String for the property symbol.
      • setSymbol

        public void setSymbol​(java.lang.String symbol)
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/symbol
        Specified by:
        setSymbol in interface DataSpecificationIEC61360
        Parameters:
        symbol - desired value for the property symbol.
      • getUnit

        public java.lang.String getUnit()
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unit
        Specified by:
        getUnit in interface DataSpecificationIEC61360
        Returns:
        Returns the String for the property unit.
      • setUnit

        public void setUnit​(java.lang.String unit)
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unit
        Specified by:
        setUnit in interface DataSpecificationIEC61360
        Parameters:
        unit - desired value for the property unit.
      • getUnitId

        public Reference getUnitId()
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unitId
        Specified by:
        getUnitId in interface DataSpecificationIEC61360
        Returns:
        Returns the Reference for the property unitId.
      • setUnitId

        public void setUnitId​(Reference unitId)
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unitId
        Specified by:
        setUnitId in interface DataSpecificationIEC61360
        Parameters:
        unitId - desired value for the property unitId.
      • getValueFormat

        public java.lang.String getValueFormat()
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueFormat
        Specified by:
        getValueFormat in interface DataSpecificationIEC61360
        Returns:
        Returns the String for the property valueFormat.
      • setValueFormat

        public void setValueFormat​(java.lang.String valueFormat)
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueFormat
        Specified by:
        setValueFormat in interface DataSpecificationIEC61360
        Parameters:
        valueFormat - desired value for the property valueFormat.
      • getValue

        public java.lang.String getValue()
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/value
        Specified by:
        getValue in interface DataSpecificationIEC61360
        Returns:
        Returns the String for the property value.
      • setValue

        public void setValue​(java.lang.String value)
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/value
        Specified by:
        setValue in interface DataSpecificationIEC61360
        Parameters:
        value - desired value for the property value.
      • getValueList

        public ValueList getValueList()
        Description copied from interface: DataSpecificationIEC61360
        The Type 'ValueList' lists all the allowed values for a concept description for which the allowed values are listed in an enumeration. The value list is a set of value reference pairs. More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueList
        Specified by:
        getValueList in interface DataSpecificationIEC61360
        Returns:
        Returns the ValueList for the property valueList.
      • setValueList

        public void setValueList​(ValueList valueList)
        Description copied from interface: DataSpecificationIEC61360
        The Type 'ValueList' lists all the allowed values for a concept description for which the allowed values are listed in an enumeration. The value list is a set of value reference pairs. More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueList
        Specified by:
        setValueList in interface DataSpecificationIEC61360
        Parameters:
        valueList - desired value for the property valueList.
      • getValueId

        public Reference getValueId()
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueId
        Specified by:
        getValueId in interface DataSpecificationIEC61360
        Returns:
        Returns the Reference for the property valueId.
      • setValueId

        public void setValueId​(Reference valueId)
        Description copied from interface: DataSpecificationIEC61360
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueId
        Specified by:
        setValueId in interface DataSpecificationIEC61360
        Parameters:
        valueId - desired value for the property valueId.