Package io.adminshell.aas.v3.model.impl
Class DefaultMultiLanguageProperty
- java.lang.Object
-
- io.adminshell.aas.v3.model.impl.DefaultMultiLanguageProperty
-
- All Implemented Interfaces:
DataElement,HasDataSpecification,HasExtensions,HasKind,HasSemantics,MultiLanguageProperty,Qualifiable,Referable,SubmodelElement
public class DefaultMultiLanguageProperty extends java.lang.Object implements MultiLanguageProperty
Default implementation of package io.adminshell.aas.v3.model.MultiLanguageProperty A property is a data element that has a multi language value.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDefaultMultiLanguageProperty.BuilderThis builder class can be used to construct a DefaultMultiLanguageProperty bean.
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.Stringcategoryprotected java.util.List<LangString>descriptionsprotected java.util.List<LangString>displayNamesprotected java.util.List<EmbeddedDataSpecification>embeddedDataSpecificationsprotected java.util.List<Extension>extensionsprotected java.lang.StringidShortprotected ModelingKindkindprotected java.util.List<Constraint>qualifiersprotected ReferencesemanticIdprotected ReferencevalueIdprotected java.util.List<LangString>values
-
Constructor Summary
Constructors Constructor Description DefaultMultiLanguageProperty()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)java.lang.StringgetCategory()The category is a value that gives further meta information w.r.t. to the class of the element.java.util.List<LangString>getDescriptions()Description or comments on the element.java.util.List<LangString>getDisplayNames()Display name.java.util.List<EmbeddedDataSpecification>getEmbeddedDataSpecifications()Link to the included description of the Data Specification.java.util.List<Extension>getExtensions()An extension of the element.java.lang.StringgetIdShort()Identifying string of the element within its name space.ModelingKindgetKind()ModelingKind of the element: either type or instance.java.util.List<Constraint>getQualifiers()Additional qualification of a qualifiable element.ReferencegetSemanticId()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).ReferencegetValueId()Reference to the global unqiue id of a coded value.java.util.List<LangString>getValues()The value of the property instance.inthashCode()voidsetCategory(java.lang.String category)The category is a value that gives further meta information w.r.t. to the class of the element.voidsetDescriptions(java.util.List<LangString> descriptions)Description or comments on the element.voidsetDisplayNames(java.util.List<LangString> displayNames)Display name.voidsetEmbeddedDataSpecifications(java.util.List<EmbeddedDataSpecification> embeddedDataSpecifications)Link to the included description of the Data Specification.voidsetExtensions(java.util.List<Extension> extensions)An extension of the element.voidsetIdShort(java.lang.String idShort)Identifying string of the element within its name space.voidsetKind(ModelingKind kind)ModelingKind of the element: either type or instance.voidsetQualifiers(java.util.List<Constraint> qualifiers)Additional qualification of a qualifiable element.voidsetSemanticId(Reference semanticId)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).voidsetValueId(Reference valueId)Reference to the global unqiue id of a coded value.voidsetValues(java.util.List<LangString> values)The value of the property instance.
-
-
-
Field Detail
-
embeddedDataSpecifications
protected java.util.List<EmbeddedDataSpecification> embeddedDataSpecifications
-
extensions
protected java.util.List<Extension> extensions
-
kind
protected ModelingKind kind
-
semanticId
protected Reference semanticId
-
values
protected java.util.List<LangString> values
-
valueId
protected Reference valueId
-
qualifiers
protected java.util.List<Constraint> qualifiers
-
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
-
-
Method Detail
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
getValues
public java.util.List<LangString> getValues()
Description copied from interface:MultiLanguagePropertyThe value of the property instance. Constraint AASd-052b: If the semanticId of a MultiLanguageProperty references a ConceptDescription then the ConceptDescription/category shall be one of following values: PROPERTY. Constraint AASd-012: If both, the MultiLanguageProperty/value and the MultiLanguageProperty/valueId are present then for each string in a specific language the meaning must be the same as specified in MultiLanguageProperty/valueId. Constraint AASd-067: If the semanticId of a MultiLanguageProperty references a ConceptDescription then DataSpecificationIEC61360/dataType shall be STRING_TRANSLATABLE. More information under https://admin-shell.io/aas/3/0/RC01/MultiLanguageProperty/value- Specified by:
getValuesin interfaceMultiLanguageProperty- Returns:
- Returns the List of LangStrings for the property values.
-
setValues
public void setValues(java.util.List<LangString> values)
Description copied from interface:MultiLanguagePropertyThe value of the property instance. Constraint AASd-052b: If the semanticId of a MultiLanguageProperty references a ConceptDescription then the ConceptDescription/category shall be one of following values: PROPERTY. Constraint AASd-012: If both, the MultiLanguageProperty/value and the MultiLanguageProperty/valueId are present then for each string in a specific language the meaning must be the same as specified in MultiLanguageProperty/valueId. Constraint AASd-067: If the semanticId of a MultiLanguageProperty references a ConceptDescription then DataSpecificationIEC61360/dataType shall be STRING_TRANSLATABLE. More information under https://admin-shell.io/aas/3/0/RC01/MultiLanguageProperty/value- Specified by:
setValuesin interfaceMultiLanguageProperty- Parameters:
values- desired value for the property values.
-
getValueId
public Reference getValueId()
Description copied from interface:MultiLanguagePropertyReference to the global unqiue id of a coded value. More information under https://admin-shell.io/aas/3/0/RC01/MultiLanguageProperty/valueId- Specified by:
getValueIdin interfaceMultiLanguageProperty- Returns:
- Returns the Reference for the property valueId.
-
setValueId
public void setValueId(Reference valueId)
Description copied from interface:MultiLanguagePropertyReference to the global unqiue id of a coded value. More information under https://admin-shell.io/aas/3/0/RC01/MultiLanguageProperty/valueId- Specified by:
setValueIdin interfaceMultiLanguageProperty- Parameters:
valueId- desired value for the property valueId.
-
getCategory
public java.lang.String getCategory()
Description copied from interface:ReferableThe 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:
getCategoryin interfaceReferable- Returns:
- Returns the String for the property category.
-
setCategory
public void setCategory(java.lang.String category)
Description copied from interface:ReferableThe 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:
setCategoryin interfaceReferable- Parameters:
category- desired value for the property category.
-
getDescriptions
public java.util.List<LangString> getDescriptions()
Description copied from interface:ReferableDescription 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:
getDescriptionsin interfaceReferable- Returns:
- Returns the List of LangStrings for the property descriptions.
-
setDescriptions
public void setDescriptions(java.util.List<LangString> descriptions)
Description copied from interface:ReferableDescription 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:
setDescriptionsin interfaceReferable- Parameters:
descriptions- desired value for the property descriptions.
-
getDisplayNames
public java.util.List<LangString> getDisplayNames()
Description copied from interface:ReferableDisplay name. Can be provided in several languages. More information under https://admin-shell.io/aas/3/0/RC01/Referable/displayName- Specified by:
getDisplayNamesin interfaceReferable- Returns:
- Returns the List of LangStrings for the property displayNames.
-
setDisplayNames
public void setDisplayNames(java.util.List<LangString> displayNames)
Description copied from interface:ReferableDisplay name. Can be provided in several languages. More information under https://admin-shell.io/aas/3/0/RC01/Referable/displayName- Specified by:
setDisplayNamesin interfaceReferable- Parameters:
displayNames- desired value for the property displayNames.
-
getIdShort
public java.lang.String getIdShort()
Description copied from interface:ReferableIdentifying 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:
getIdShortin interfaceReferable- Returns:
- Returns the String for the property idShort.
-
setIdShort
public void setIdShort(java.lang.String idShort)
Description copied from interface:ReferableIdentifying 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:
setIdShortin interfaceReferable- Parameters:
idShort- desired value for the property idShort.
-
getExtensions
public java.util.List<Extension> getExtensions()
Description copied from interface:HasExtensionsAn extension of the element. More information under https://admin-shell.io/aas/3/0/RC01/HasExtensions/extension- Specified by:
getExtensionsin interfaceHasExtensions- Returns:
- Returns the List of Extensions for the property extensions.
-
setExtensions
public void setExtensions(java.util.List<Extension> extensions)
Description copied from interface:HasExtensionsAn extension of the element. More information under https://admin-shell.io/aas/3/0/RC01/HasExtensions/extension- Specified by:
setExtensionsin interfaceHasExtensions- Parameters:
extensions- desired value for the property extensions.
-
getQualifiers
public java.util.List<Constraint> getQualifiers()
Description copied from interface:QualifiableAdditional qualification of a qualifiable element. More information under https://admin-shell.io/aas/3/0/RC01/Qualifiable/qualifier- Specified by:
getQualifiersin interfaceQualifiable- Returns:
- Returns the List of Constraints for the property qualifiers.
-
setQualifiers
public void setQualifiers(java.util.List<Constraint> qualifiers)
Description copied from interface:QualifiableAdditional qualification of a qualifiable element. More information under https://admin-shell.io/aas/3/0/RC01/Qualifiable/qualifier- Specified by:
setQualifiersin interfaceQualifiable- Parameters:
qualifiers- desired value for the property qualifiers.
-
getEmbeddedDataSpecifications
public java.util.List<EmbeddedDataSpecification> getEmbeddedDataSpecifications()
Description copied from interface:HasDataSpecificationLink to the included description of the Data Specification. More information under https://admin-shell.io/aas/3/0/RC01/HasDataSpecification/embeddedDataSpecification- Specified by:
getEmbeddedDataSpecificationsin interfaceHasDataSpecification- Returns:
- Returns the List of EmbeddedDataSpecifications for the property embeddedDataSpecifications.
-
setEmbeddedDataSpecifications
public void setEmbeddedDataSpecifications(java.util.List<EmbeddedDataSpecification> embeddedDataSpecifications)
Description copied from interface:HasDataSpecificationLink to the included description of the Data Specification. More information under https://admin-shell.io/aas/3/0/RC01/HasDataSpecification/embeddedDataSpecification- Specified by:
setEmbeddedDataSpecificationsin interfaceHasDataSpecification- Parameters:
embeddedDataSpecifications- desired value for the property embeddedDataSpecifications.
-
getKind
public ModelingKind getKind()
Description copied from interface:HasKindModelingKind of the element: either type or instance. More information under https://admin-shell.io/aas/3/0/RC01/HasKind/kind
-
setKind
public void setKind(ModelingKind kind)
Description copied from interface:HasKindModelingKind of the element: either type or instance. More information under https://admin-shell.io/aas/3/0/RC01/HasKind/kind
-
getSemanticId
public Reference getSemanticId()
Description copied from interface:HasSemanticsPoints 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:
getSemanticIdin interfaceHasSemantics- Returns:
- Returns the Reference for the property semanticId.
-
setSemanticId
public void setSemanticId(Reference semanticId)
Description copied from interface:HasSemanticsPoints 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:
setSemanticIdin interfaceHasSemantics- Parameters:
semanticId- desired value for the property semanticId.
-
-