Package org.eclipse.basyx.submodel.types.technicaldata.submodelelementcollections.productclassifications

Class ProductClassificationItem

java.lang.Object

org.eclipse.basyx.vab.model.VABModelMap<Object>

org.eclipse.basyx.submodel.metamodel.map.submodelelement.SubmodelElement

org.eclipse.basyx.submodel.metamodel.map.submodelelement.SubmodelElementCollection

org.eclipse.basyx.submodel.types.technicaldata.submodelelementcollections.productclassifications.ProductClassificationItem

All Implemented Interfaces:

Map<String,Object>, IElement, IElementContainer, IHasKind, IHasDataSpecification, IHasSemantics, IReferable, IQualifiable, ISubmodelElement, ISubmodelElementCollection

public class ProductClassificationItem
extends SubmodelElementCollection

ProductClassificationItem as described in the Submodel Template AAS Technical Data Document It is a submodel element collection which contains Single product classification by association with product class in a particular classification system or property dictionary.

Author:

haque

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLASSIFICATIONSYSTEMVERSIONID
static String	PRODUCTCLASSID
static String	PRODUCTCLASSIFICATIONSYSTEMID
static Reference	SEMANTICID

Fields inherited from class org.eclipse.basyx.submodel.metamodel.map.submodelelement.SubmodelElementCollection

ALLOWDUPLICATES, MODELTYPE, ORDERED

Fields inherited from class org.eclipse.basyx.vab.model.VABModelMap

map

Constructor Summary

Constructors

Constructor	Description
ProductClassificationItem(String idShort, String productClassificationSystem, String productClassId)	Constructor with mandatory attributes
ProductClassificationItem(String idShort, Property productClassificationSystem, Property productClassId)	Constructor with mandatory attributes

Method Summary

Modifier and Type	Method	Description
static ProductClassificationItem	createAsFacade(Map<String,Object> obj)	Creates a ProductClassificationItem SMC object from a map
IProperty	getClassificationSystemVersion()	Gets common version identifier of the used classification system, in order to distinguish different version of the property dictionary.
IProperty	getProductClassId()	Gets class of the associated product or industrial equipment in the classification system.
IProperty	getProductClassificationSystem()	Gets common name of the classification system.
static boolean	isValid(Map<String,Object> obj)	Check whether all mandatory elements for ProdictClassificationSystem SMC exist in the map
void	setClassificationSystemVersion(String version)	Sets common version identifier of the used classification system, in order to distinguish different version of the property dictionary.
void	setClassificationSystemVersion(Property version)	Sets common version identifier of the used classification system, in order to distinguish different version of the property dictionary.
void	setProductClassId(String id)	Sets class of the associated product or industrial equipment in the classification system.
void	setProductClassId(Property id)	Sets class of the associated product or industrial equipment in the classification system.
void	setProductClassificationSystem(String system)	Sets common name of the classification system.
void	setProductClassificationSystem(Property system)	Sets common name of the classification system.

Methods inherited from class org.eclipse.basyx.submodel.metamodel.map.submodelelement.SubmodelElementCollection

addSubmodelElement, deleteSubmodelElement, getCategory, getDataSpecificationReferences, getDescription, getIdShort, getKeyElement, getLocalCopy, getOperations, getProperties, getSubmodelElement, getSubmodelElements, getValue, getValues, isAllowDuplicates, isOrdered, isSubmodelElementCollection, setAllowDuplicates, setDataSpecificationReferences, setElements, setElements, setOrdered, setValue

Methods inherited from class org.eclipse.basyx.submodel.metamodel.map.submodelelement.SubmodelElement

getEmbeddedDataSpecifications, getModelingKind, getModelType, getParent, getQualifiers, getReference, getSemanticId, setCategory, setDescription, setEmbeddedDataSpecifications, setIdShort, setModelingKind, setParent, setQualifiers, setSemanticId

Methods inherited from class org.eclipse.basyx.vab.model.VABModelMap

clear, containsKey, containsValue, entrySet, equals, get, getPath, hashCode, isEmpty, keySet, put, putAll, putPath, remove, setMap, size, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.basyx.submodel.metamodel.api.qualifier.IHasDataSpecification

getEmbeddedDataSpecifications

Methods inherited from interface org.eclipse.basyx.submodel.metamodel.api.qualifier.haskind.IHasKind

getModelingKind

Methods inherited from interface org.eclipse.basyx.submodel.metamodel.api.qualifier.IHasSemantics

getSemanticId

Methods inherited from interface org.eclipse.basyx.submodel.metamodel.api.qualifier.qualifiable.IQualifiable

getQualifiers

Methods inherited from interface org.eclipse.basyx.submodel.metamodel.api.qualifier.IReferable

getParent, getReference

Methods inherited from interface org.eclipse.basyx.submodel.metamodel.api.submodelelement.ISubmodelElement

getModelType

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

PRODUCTCLASSIFICATIONSYSTEMID

public static final String PRODUCTCLASSIFICATIONSYSTEMID

See Also:

Constant Field Values

CLASSIFICATIONSYSTEMVERSIONID

public static final String CLASSIFICATIONSYSTEMVERSIONID

See Also:

Constant Field Values

PRODUCTCLASSID

public static final String PRODUCTCLASSID

See Also:

Constant Field Values

SEMANTICID

public static final Reference SEMANTICID

Constructor Detail

ProductClassificationItem

public ProductClassificationItem(String idShort,
                                 Property productClassificationSystem,
                                 Property productClassId)

Constructor with mandatory attributes

Parameters:

idShort -

productClassificationSystem -

productClassId -

ProductClassificationItem

public ProductClassificationItem(String idShort,
                                 String productClassificationSystem,
                                 String productClassId)

Constructor with mandatory attributes

Parameters:

idShort -

productClassificationSystem -

productClassId -

Method Detail

createAsFacade

public static ProductClassificationItem createAsFacade(Map<String,Object> obj)

Creates a ProductClassificationItem SMC object from a map

Parameters:

obj - a ProductClassificationItem SMC object as raw map

Returns:

a ProductClassificationItem SMC object, that behaves like a facade for the given map

isValid

public static boolean isValid(Map<String,Object> obj)

Check whether all mandatory elements for ProdictClassificationSystem SMC exist in the map

Parameters:

obj -

Returns:

true/false

setProductClassificationSystem

public void setProductClassificationSystem(Property system)

Sets common name of the classification system. Note: Examples for common names for classification systems are "ECLASS" or "IEC CDD".

Parameters:

system -

setProductClassificationSystem

public void setProductClassificationSystem(String system)

Sets common name of the classification system. Note: Examples for common names for classification systems are "ECLASS" or "IEC CDD".

Parameters:

system -

getProductClassificationSystem

public IProperty getProductClassificationSystem()

Gets common name of the classification system. Note: Examples for common names for classification systems are "ECLASS" or "IEC CDD".

Returns:

setClassificationSystemVersion

public void setClassificationSystemVersion(Property version)

Sets common version identifier of the used classification system, in order to distinguish different version of the property dictionary. Note: Casing is to be ignored.

Parameters:

version -

setClassificationSystemVersion

public void setClassificationSystemVersion(String version)

Sets common version identifier of the used classification system, in order to distinguish different version of the property dictionary. Note: Casing is to be ignored.

Parameters:

version -

getClassificationSystemVersion

public IProperty getClassificationSystemVersion()

Gets common version identifier of the used classification system, in order to distinguish different version of the property dictionary. Note: Casing is to be ignored.

Returns:

setProductClassId

public void setProductClassId(Property id)

Sets class of the associated product or industrial equipment in the classification system. According to the notation of the system. Note: Ideally, the Property/valueId is used to reference the IRI/ IRDI of the product class.

Parameters:

id -

setProductClassId

public void setProductClassId(String id)

Sets class of the associated product or industrial equipment in the classification system. According to the notation of the system. Note: Ideally, the Property/valueId is used to reference the IRI/ IRDI of the product class.

Parameters:

id -

getProductClassId

public IProperty getProductClassId()

Gets class of the associated product or industrial equipment in the classification system. According to the notation of the system. Note: Ideally, the Property/valueId is used to reference the IRI/ IRDI of the product class.

Returns: