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

Class BaSyxEntity.BaSyxEntityBuilder

java.lang.Object

de.iip_ecosphere.platform.support.aas.basyx2.BaSyxSubmodelElementContainerBuilder<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>

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

All Implemented Interfaces:

de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder, de.iip_ecosphere.platform.support.aas.RbacReceiver<de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder>, de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder, de.iip_ecosphere.platform.support.Builder<de.iip_ecosphere.platform.support.aas.Entity>

Enclosing class:

BaSyxEntity

public static class BaSyxEntity.BaSyxEntityBuilder
extends BaSyxSubmodelElementContainerBuilder<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>
implements de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder

Implements the entity builder.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private org.eclipse.digitaltwin.aas4j.v3.model.Entity	entity
private BaSyxEntity	instance
private boolean	isNew
private BaSyxSubmodelElementContainerBuilder<?>	parentBuilder
private List<org.eclipse.digitaltwin.aas4j.v3.model.SubmodelElement>	statements

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaSyxEntityBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder, BaSyxEntity instance)	Creates an instance from an existing BaSyx instance.
(package private)	BaSyxEntityBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder, String idShort, de.iip_ecosphere.platform.support.aas.Entity.EntityType type, de.iip_ecosphere.platform.support.aas.Reference asset)	Creates a builder instance.

Method Summary

Modifier and Type	Method	Description
de.iip_ecosphere.platform.support.aas.Entity	build()
de.iip_ecosphere.platform.support.aas.Reference	createReference()	Creates a reference to the sub-model under creation.
de.iip_ecosphere.platform.support.aas.SubmodelElementCollection.SubmodelElementCollectionBuilder	createSubmodelElementCollectionBuilder(String idShort)
de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder	createSubmodelElementContainerBuilder(String idShort)
de.iip_ecosphere.platform.support.aas.SubmodelElementList.SubmodelElementListBuilder	createSubmodelElementListBuilder(String idShort)
de.iip_ecosphere.platform.support.aas.Aas.AasBuilder	getAasBuilder()
protected String	getIdShort()	Returns the underlying collection instance.
BaSyxSubmodelElementContainerBuilder<?>	getParentBuilder()
boolean	hasElement(String idShort)
boolean	isNew()
de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder	rbac(de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor auth)
de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder	rbac(de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor auth, de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor.Role role, de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor.RbacAction... actions)
protected BaSyxBlob	register(BaSyxBlob blob)	Registers a file data element.
protected BaSyxEntity	register(BaSyxEntity entity)	Registers a entity element.
protected BaSyxFile	register(BaSyxFile file)	Registers a file data element.
protected BaSyxMultiLanguageProperty	register(BaSyxMultiLanguageProperty property)	Registers a multi-language property.
protected BaSyxOperation	register(BaSyxOperation operation)	Registers an operation.
protected BaSyxProperty	register(BaSyxProperty property)	Registers a property.
protected BaSyxReferenceElement	register(BaSyxReferenceElement reference)	Registers a reference element.
protected BaSyxRelationshipElement	register(BaSyxRelationshipElement relationship)	Registers a relationship element.
de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder	setAsset(de.iip_ecosphere.platform.support.aas.Reference asset)
de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder	setDescription(de.iip_ecosphere.platform.support.aas.LangString... description)
de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder	setEntityType(de.iip_ecosphere.platform.support.aas.Entity.EntityType type)
de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder	setSemanticId(String refValue)

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

buildMyDeferred, composeRbacPath, createBlobDataElementBuilder, createEntityBuilder, createFileDataElementBuilder, createMultiLanguagePropertyBuilder, createOperationBuilder, createPropertyBuilder, createRangeBuilder, createReferenceElementBuilder, createRelationshipElementBuilder, defer, getInstance, parents, register, register, register, registerElement

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.Entity.EntityBuilder

build, justBuild, rbac

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

rbacAll, rbacAllAuthenticated, rbacDevice, rbacPlatform

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

createBlobDataElementBuilder, createEntityBuilder, createFileDataElementBuilder, createMultiLanguagePropertyBuilder, createOperationBuilder, createPropertyBuilder, createRangeBuilder, createReferenceElementBuilder, createRelationshipElementBuilder

Field Details

parentBuilder

private BaSyxSubmodelElementContainerBuilder<?> parentBuilder

instance

private BaSyxEntity instance

entity

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

statements

private List<org.eclipse.digitaltwin.aas4j.v3.model.SubmodelElement> statements

isNew

private boolean isNew

Constructor Details

BaSyxEntityBuilder

BaSyxEntityBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder,
 String idShort,
 de.iip_ecosphere.platform.support.aas.Entity.EntityType type,
 de.iip_ecosphere.platform.support.aas.Reference asset)

Creates a builder instance.

Parameters:

parentBuilder - the parent builder

idShort - the short id of the reference element

type - the entity type

asset - the asset of the entity, may be null for none

BaSyxEntityBuilder

protected BaSyxEntityBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder,
 BaSyxEntity instance)

Creates an instance from an existing BaSyx instance.

Parameters:

parentBuilder - the parent builder

instance - the BaSyx instance

Method Details

getParentBuilder

public BaSyxSubmodelElementContainerBuilder<?> getParentBuilder()

Specified by:

getParentBuilder in interface de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder

Specified by:

getParentBuilder in interface de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder

build

public de.iip_ecosphere.platform.support.aas.Entity build()

Specified by:

build in interface de.iip_ecosphere.platform.support.Builder<de.iip_ecosphere.platform.support.aas.Entity>

setSemanticId

public de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder setSemanticId(String refValue)

Specified by:

setSemanticId in interface de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder

Specified by:

setSemanticId in interface de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder

setDescription

public de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder setDescription(de.iip_ecosphere.platform.support.aas.LangString... description)

Specified by:

setDescription in interface de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder

Specified by:

setDescription in interface de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder

createReference

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

Description copied from class: BaSyxSubmodelElementContainerBuilder

Creates a reference to the sub-model under creation.

Specified by:

createReference in interface de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder

Overrides:

createReference in class BaSyxSubmodelElementContainerBuilder<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>

Returns:

the reference

createSubmodelElementCollectionBuilder

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

Specified by:

createSubmodelElementCollectionBuilder in interface de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder

createSubmodelElementListBuilder

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

Specified by:

createSubmodelElementListBuilder in interface de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder

createSubmodelElementContainerBuilder

public de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder createSubmodelElementContainerBuilder(String idShort)

Specified by:

createSubmodelElementContainerBuilder in interface de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder

getAasBuilder

public de.iip_ecosphere.platform.support.aas.Aas.AasBuilder getAasBuilder()

Specified by:

getAasBuilder in interface de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder

isNew

public boolean isNew()

Specified by:

isNew in interface de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder

hasElement

public boolean hasElement(String idShort)

Specified by:

hasElement in interface de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder

getIdShort

protected String getIdShort()

Description copied from class: BaSyxSubmodelElementContainerBuilder

Returns the underlying collection instance.

Specified by:

getIdShort in class BaSyxSubmodelElementContainerBuilder<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>

Returns:

the instance

register

protected BaSyxFile register(BaSyxFile file)

Description copied from class: BaSyxSubmodelElementContainerBuilder

Registers a file data element.

Overrides:

register in class BaSyxSubmodelElementContainerBuilder<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>

Parameters:

file - the file data element

Returns:

file

register

protected BaSyxBlob register(BaSyxBlob blob)

Description copied from class: BaSyxSubmodelElementContainerBuilder

Registers a file data element.

Overrides:

register in class BaSyxSubmodelElementContainerBuilder<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>

Parameters:

blob - the BLOB data element

Returns:

blob

register

protected BaSyxOperation register(BaSyxOperation operation)

Description copied from class: BaSyxSubmodelElementContainerBuilder

Registers an operation.

Overrides:

register in class BaSyxSubmodelElementContainerBuilder<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>

Parameters:

operation - the operation

Returns:

operation

register

protected BaSyxProperty register(BaSyxProperty property)

Description copied from class: BaSyxSubmodelElementContainerBuilder

Registers a property.

Overrides:

register in class BaSyxSubmodelElementContainerBuilder<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>

Parameters:

property - the property

Returns:

property

register

protected BaSyxMultiLanguageProperty register(BaSyxMultiLanguageProperty property)

Description copied from class: BaSyxSubmodelElementContainerBuilder

Registers a multi-language property.

Overrides:

register in class BaSyxSubmodelElementContainerBuilder<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>

Parameters:

property - the property

Returns:

property

register

protected BaSyxRelationshipElement register(BaSyxRelationshipElement relationship)

Description copied from class: BaSyxSubmodelElementContainerBuilder

Registers a relationship element.

Overrides:

register in class BaSyxSubmodelElementContainerBuilder<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>

Parameters:

relationship - the relationship element

Returns:

relationship

register

protected BaSyxEntity register(BaSyxEntity entity)

Description copied from class: BaSyxSubmodelElementContainerBuilder

Registers a entity element.

Overrides:

register in class BaSyxSubmodelElementContainerBuilder<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>

Parameters:

entity - the entity

Returns:

reference

register

protected BaSyxReferenceElement register(BaSyxReferenceElement reference)

Description copied from class: BaSyxSubmodelElementContainerBuilder

Registers a reference element.

Overrides:

register in class BaSyxSubmodelElementContainerBuilder<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>

Parameters:

reference - the reference

Returns:

reference

setEntityType

public de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder setEntityType(de.iip_ecosphere.platform.support.aas.Entity.EntityType type)

Specified by:

setEntityType in interface de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder

setAsset

public de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder setAsset(de.iip_ecosphere.platform.support.aas.Reference asset)

Specified by:

setAsset in interface de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder

rbac

public de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder rbac(de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor auth,
 de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor.Role role,
 de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor.RbacAction... actions)

Specified by:

rbac in interface de.iip_ecosphere.platform.support.aas.RbacReceiver<de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder>

rbac

public de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder rbac(de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor auth)

Specified by:

rbac in interface de.iip_ecosphere.platform.support.aas.RbacReceiver<de.iip_ecosphere.platform.support.aas.Entity.EntityBuilder>