Package de.iip_ecosphere.platform.support.aas.basyx2

Class BaSyxEntity

java.lang.Object

de.iip_ecosphere.platform.support.aas.basyx2.BaSyxSubmodelElement

de.iip_ecosphere.platform.support.aas.basyx2.BaSyxEntity

All Implemented Interfaces:

BaSyxElementTranslator.SubmodelElementsRegistrar, de.iip_ecosphere.platform.support.aas.Element, de.iip_ecosphere.platform.support.aas.ElementsAccess, de.iip_ecosphere.platform.support.aas.Entity, de.iip_ecosphere.platform.support.aas.HasDataSpecification, de.iip_ecosphere.platform.support.aas.HasKind, de.iip_ecosphere.platform.support.aas.HasSemantics, de.iip_ecosphere.platform.support.aas.Qualifiable, de.iip_ecosphere.platform.support.aas.Referable, de.iip_ecosphere.platform.support.aas.SubmodelElement, de.iip_ecosphere.platform.support.aas.SubmodelElementCollection

public class BaSyxEntity
extends BaSyxSubmodelElement
implements de.iip_ecosphere.platform.support.aas.Entity, BaSyxElementTranslator.SubmodelElementsRegistrar

Implements the entity wrapper.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaSyxEntity.BaSyxEntityBuilder	Implements the entity builder.

Nested classes/interfaces inherited from class de.iip_ecosphere.platform.support.aas.basyx2.BaSyxSubmodelElement

BaSyxSubmodelElement.PathFunction

Nested classes/interfaces inherited from interface de.iip_ecosphere.platform.support.aas.Entity

de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder, de.iip_ecosphere.platform.support.aas.Entity.EntityType

Nested classes/interfaces inherited from interface de.iip_ecosphere.platform.support.aas.SubmodelElementCollection

de.iip_ecosphere.platform.support.aas.SubmodelElementCollection.SubmodelElementCollectionBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,de.iip_ecosphere.platform.support.Builder<?>>	deferred
private org.eclipse.digitaltwin.aas4j.v3.model.Entity	entity
private List<de.iip_ecosphere.platform.support.aas.SubmodelElement>	statementsList

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BaSyxEntity()	Creates an instance.
(package private)	BaSyxEntity(org.eclipse.digitaltwin.aas4j.v3.model.Entity entity)	Creates an instance and directly sets the entity.

Method Summary

Modifier and Type	Method	Description
void	accept(de.iip_ecosphere.platform.support.aas.AasVisitor visitor)
private <T extends de.iip_ecosphere.platform.support.aas.SubmodelElement> T	add(T elt)	Adds an element.
private void	createElementsStructure()	Creates the actual data structure to use.
de.iip_ecosphere.platform.support.aas.Reference	createReference()
void	deleteElement(String idShort)
Iterable<de.iip_ecosphere.platform.support.aas.SubmodelElement>	elements()
private Stream<de.iip_ecosphere.platform.support.aas.SubmodelElement>	elementsStream()	Returns the elements/statements as stream.
de.iip_ecosphere.platform.support.aas.DataElement	getDataElement(String idShort)
de.iip_ecosphere.platform.support.aas.SubmodelElement	getElement(String idShort)
private <T extends de.iip_ecosphere.platform.support.aas.SubmodelElement> T	getElement(String idShort, Class<T> type)	getElement(String) combined with a type filter.
int	getElementsCount()
(package private) org.eclipse.digitaltwin.aas4j.v3.model.Entity	getEntity()	Returns the BaSyx entity.
de.iip_ecosphere.platform.support.aas.Entity	getEntity(String idShort)
de.iip_ecosphere.platform.support.aas.Operation	getOperation(String idShort)
de.iip_ecosphere.platform.support.aas.Property	getProperty(String idShort)
de.iip_ecosphere.platform.support.aas.ReferenceElement	getReferenceElement(String idShort)
de.iip_ecosphere.platform.support.aas.RelationshipElement	getRelationshipElement(String idShort)
(package private) org.eclipse.digitaltwin.aas4j.v3.model.Entity	getSubmodelElement()	Returns the implementing sub-model element.
de.iip_ecosphere.platform.support.aas.SubmodelElement	getSubmodelElement(String idShort)
de.iip_ecosphere.platform.support.aas.SubmodelElementCollection	getSubmodelElementCollection(String idShort)
de.iip_ecosphere.platform.support.aas.SubmodelElementList	getSubmodelElementList(String idShort)
de.iip_ecosphere.platform.support.aas.Entity.EntityType	getType()
private void	initialize()	Dynamically initializes the elements structure.
BaSyxBlob	register(BaSyxBlob blob)	Registers a BLOB data element.
<D extends org.eclipse.digitaltwin.aas4j.v3.model.DataElement> BaSyxDataElement<D>	register(BaSyxDataElement<D> dataElement)	Registers a data element.
BaSyxEntity	register(BaSyxEntity entity)	Registers an entity.
BaSyxFile	register(BaSyxFile file)	Registers a file data element.
BaSyxMultiLanguageProperty	register(BaSyxMultiLanguageProperty property)	Registers a multi-language property.
BaSyxOperation	register(BaSyxOperation operation)	Registers an operation.
BaSyxProperty	register(BaSyxProperty property)	Registers a property.
BaSyxReferenceElement	register(BaSyxReferenceElement reference)	Registers a reference element.
BaSyxRelationshipElement	register(BaSyxRelationshipElement relationship)	Registers a relationship element.
BaSyxSubmodelElementCollection	register(BaSyxSubmodelElementCollection collection)	Registers a sub-model element collection.
BaSyxSubmodelElementList	register(BaSyxSubmodelElementList list)	Registers a sub-model element list.
<T extends de.iip_ecosphere.platform.support.aas.SubmodelElement> T	registerElement(T elt)	Registers an element.
Iterable<de.iip_ecosphere.platform.support.aas.SubmodelElement>	submodelElements()

Methods inherited from class de.iip_ecosphere.platform.support.aas.basyx2.BaSyxSubmodelElement

composePath, composePath, createConnectedSubmodelElement, createSubmodelElement, deleteConnectedSubmodelElement, getIdShort, getParent, getRepo, getSemanticId, processOnPath, setParent, setSemanticId, update, updateConnectedSubmodelElement, updateInBuild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.iip_ecosphere.platform.support.aas.basyx2.BaSyxElementTranslator.SubmodelElementsRegistrar

register

Methods inherited from interface de.iip_ecosphere.platform.support.aas.Element

getIdShort, update

Methods inherited from interface de.iip_ecosphere.platform.support.aas.ElementsAccess

deleteElement, getIdShort

Methods inherited from interface de.iip_ecosphere.platform.support.aas.HasSemantics

getSemanticId, getSemanticId, setSemanticId

Field Details

entity

private org.eclipse.digitaltwin.aas4j.v3.model.Entity entity

deferred

private Map<String,de.iip_ecosphere.platform.support.Builder<?>> deferred

statementsList

private List<de.iip_ecosphere.platform.support.aas.SubmodelElement> statementsList

Constructor Details

BaSyxEntity

private BaSyxEntity()

Creates an instance. Prevents external access.

BaSyxEntity

BaSyxEntity(org.eclipse.digitaltwin.aas4j.v3.model.Entity entity)

Creates an instance and directly sets the entity.

Parameters:

entity - the entity

Method Details

createElementsStructure

private void createElementsStructure()

Creates the actual data structure to use. statementsList shall be set before.

initialize

private void initialize()

Dynamically initializes the elements structure.

getEntity

org.eclipse.digitaltwin.aas4j.v3.model.Entity getEntity()

Returns the BaSyx entity.

Returns:

the BaSyx entity

getSubmodelElement

org.eclipse.digitaltwin.aas4j.v3.model.Entity getSubmodelElement()

Description copied from class: BaSyxSubmodelElement

Returns the implementing sub-model element.

Specified by:

getSubmodelElement in class BaSyxSubmodelElement

Returns:

the submodel element

accept

public void accept(de.iip_ecosphere.platform.support.aas.AasVisitor visitor)

Specified by:

accept in interface de.iip_ecosphere.platform.support.aas.Element

Specified by:

accept in interface de.iip_ecosphere.platform.support.aas.ElementsAccess

submodelElements

public Iterable<de.iip_ecosphere.platform.support.aas.SubmodelElement> submodelElements()

Specified by:

submodelElements in interface de.iip_ecosphere.platform.support.aas.ElementsAccess

elements

public Iterable<de.iip_ecosphere.platform.support.aas.SubmodelElement> elements()

Specified by:

elements in interface de.iip_ecosphere.platform.support.aas.SubmodelElementCollection

getElementsCount

public int getElementsCount()

Specified by:

getElementsCount in interface de.iip_ecosphere.platform.support.aas.SubmodelElementCollection

elementsStream

private Stream<de.iip_ecosphere.platform.support.aas.SubmodelElement> elementsStream()

Returns the elements/statements as stream.

Returns:

the stream

getSubmodelElement

public de.iip_ecosphere.platform.support.aas.SubmodelElement getSubmodelElement(String idShort)

Specified by:

getSubmodelElement in interface de.iip_ecosphere.platform.support.aas.ElementsAccess

getElement

public de.iip_ecosphere.platform.support.aas.SubmodelElement getElement(String idShort)

Specified by:

getElement in interface de.iip_ecosphere.platform.support.aas.SubmodelElementCollection

createReference

public de.iip_ecosphere.platform.support.aas.Reference createReference()

Specified by:

createReference in interface de.iip_ecosphere.platform.support.aas.SubmodelElementCollection

getElement

private <T extends de.iip_ecosphere.platform.support.aas.SubmodelElement>
T getElement(String idShort,
 Class<T> type)

getElement(String) combined with a type filter.

Type Parameters:

T - the type

Parameters:

idShort - the short id to search for

type - the class representing the type

Returns:

the element with given type or null for none

getSubmodelElementCollection

public de.iip_ecosphere.platform.support.aas.SubmodelElementCollection getSubmodelElementCollection(String idShort)

Specified by:

getSubmodelElementCollection in interface de.iip_ecosphere.platform.support.aas.ElementsAccess

getSubmodelElementList

public de.iip_ecosphere.platform.support.aas.SubmodelElementList getSubmodelElementList(String idShort)

Specified by:

getSubmodelElementList in interface de.iip_ecosphere.platform.support.aas.ElementsAccess

getEntity

public de.iip_ecosphere.platform.support.aas.Entity getEntity(String idShort)

Specified by:

getEntity in interface de.iip_ecosphere.platform.support.aas.ElementsAccess

getDataElement

public de.iip_ecosphere.platform.support.aas.DataElement getDataElement(String idShort)

Specified by:

getDataElement in interface de.iip_ecosphere.platform.support.aas.ElementsAccess

getProperty

public de.iip_ecosphere.platform.support.aas.Property getProperty(String idShort)

Specified by:

getProperty in interface de.iip_ecosphere.platform.support.aas.ElementsAccess

getOperation

public de.iip_ecosphere.platform.support.aas.Operation getOperation(String idShort)

Specified by:

getOperation in interface de.iip_ecosphere.platform.support.aas.ElementsAccess

getReferenceElement

public de.iip_ecosphere.platform.support.aas.ReferenceElement getReferenceElement(String idShort)

Specified by:

getReferenceElement in interface de.iip_ecosphere.platform.support.aas.ElementsAccess

getRelationshipElement

public de.iip_ecosphere.platform.support.aas.RelationshipElement getRelationshipElement(String idShort)

Specified by:

getRelationshipElement in interface de.iip_ecosphere.platform.support.aas.ElementsAccess

deleteElement

public void deleteElement(String idShort)

Specified by:

deleteElement in interface de.iip_ecosphere.platform.support.aas.ElementsAccess

getType

public de.iip_ecosphere.platform.support.aas.Entity.EntityType getType()

Specified by:

getType in interface de.iip_ecosphere.platform.support.aas.Entity

add

private <T extends de.iip_ecosphere.platform.support.aas.SubmodelElement>
T add(T elt)

Adds an element.

Type Parameters:

T - the actual type of the element

Parameters:

elt - the element

Returns:

elt

registerElement

public <T extends de.iip_ecosphere.platform.support.aas.SubmodelElement>
T registerElement(T elt)

Description copied from interface: BaSyxElementTranslator.SubmodelElementsRegistrar

Registers an element. Default for all remaining registration functions in this interface.

Specified by:

registerElement in interface BaSyxElementTranslator.SubmodelElementsRegistrar

Type Parameters:

T - the actual type of the element

Parameters:

elt - the element

Returns:

elt

register

public BaSyxProperty register(BaSyxProperty property)

Description copied from interface: BaSyxElementTranslator.SubmodelElementsRegistrar

Registers a property.

Specified by:

register in interface BaSyxElementTranslator.SubmodelElementsRegistrar

Parameters:

property - the property

Returns:

property

register

public BaSyxBlob register(BaSyxBlob blob)

Description copied from interface: BaSyxElementTranslator.SubmodelElementsRegistrar

Registers a BLOB data element.

Specified by:

register in interface BaSyxElementTranslator.SubmodelElementsRegistrar

Parameters:

blob - the BLOB data element

Returns:

blob

register

public BaSyxFile register(BaSyxFile file)

Description copied from interface: BaSyxElementTranslator.SubmodelElementsRegistrar

Registers a file data element.

Specified by:

register in interface BaSyxElementTranslator.SubmodelElementsRegistrar

Parameters:

file - the file data element

Returns:

file

register

public BaSyxMultiLanguageProperty register(BaSyxMultiLanguageProperty property)

Description copied from interface: BaSyxElementTranslator.SubmodelElementsRegistrar

Registers a multi-language property.

Specified by:

register in interface BaSyxElementTranslator.SubmodelElementsRegistrar

Parameters:

property - the property

Returns:

property

register

public BaSyxRelationshipElement register(BaSyxRelationshipElement relationship)

Description copied from interface: BaSyxElementTranslator.SubmodelElementsRegistrar

Registers a relationship element.

Specified by:

register in interface BaSyxElementTranslator.SubmodelElementsRegistrar

Parameters:

relationship - the relationship element

Returns:

relationship

register

public BaSyxEntity register(BaSyxEntity entity)

Description copied from interface: BaSyxElementTranslator.SubmodelElementsRegistrar

Registers an entity.

Specified by:

register in interface BaSyxElementTranslator.SubmodelElementsRegistrar

Parameters:

entity - the entity

Returns:

entity

register

public BaSyxOperation register(BaSyxOperation operation)

Description copied from interface: BaSyxElementTranslator.SubmodelElementsRegistrar

Registers an operation.

Specified by:

register in interface BaSyxElementTranslator.SubmodelElementsRegistrar

Parameters:

operation - the operation

Returns:

operation

register

public BaSyxReferenceElement register(BaSyxReferenceElement reference)

Description copied from interface: BaSyxElementTranslator.SubmodelElementsRegistrar

Registers a reference element.

Specified by:

register in interface BaSyxElementTranslator.SubmodelElementsRegistrar

Parameters:

reference - the reference

Returns:

reference

register

public BaSyxSubmodelElementCollection register(BaSyxSubmodelElementCollection collection)

Description copied from interface: BaSyxElementTranslator.SubmodelElementsRegistrar

Registers a sub-model element collection.

Specified by:

register in interface BaSyxElementTranslator.SubmodelElementsRegistrar

Parameters:

collection - the collection

Returns:

collection

register

public BaSyxSubmodelElementList register(BaSyxSubmodelElementList list)

Description copied from interface: BaSyxElementTranslator.SubmodelElementsRegistrar

Registers a sub-model element list.

Specified by:

register in interface BaSyxElementTranslator.SubmodelElementsRegistrar

Parameters:

list - the list

Returns:

collection

register

public <D extends org.eclipse.digitaltwin.aas4j.v3.model.DataElement>
BaSyxDataElement<D> register(BaSyxDataElement<D> dataElement)

Description copied from interface: BaSyxElementTranslator.SubmodelElementsRegistrar

Registers a data element.

Specified by:

register in interface BaSyxElementTranslator.SubmodelElementsRegistrar

Type Parameters:

D - the element type

Parameters:

dataElement - the element to register

Returns:

dataElement