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

Class BaSyxSubmodel.BaSyxSubmodelBuilder

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.BaSyxSubmodel.BaSyxSubmodelBuilder

All Implemented Interfaces:

de.iip_ecosphere.platform.support.aas.DeferredBuilder<de.iip_ecosphere.platform.support.aas.Submodel>, de.iip_ecosphere.platform.support.aas.RbacReceiver<de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder>, de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder, de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder, de.iip_ecosphere.platform.support.Builder<de.iip_ecosphere.platform.support.aas.Submodel>

Enclosing class:

BaSyxSubmodel

protected static class BaSyxSubmodel.BaSyxSubmodelBuilder
extends BaSyxSubmodelElementContainerBuilder<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>
implements de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder

Builder for BaSyxSubmodel.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private BaSyxSubmodel	instance
private boolean	isNew
private AbstractAas.BaSyxAbstractAasBuilder	parentBuilder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaSyxSubmodelBuilder(AbstractAas.BaSyxAbstractAasBuilder parentBuilder)	Creates an uninitialized instance, e.g., for delayed creation.
protected	BaSyxSubmodelBuilder(AbstractAas.BaSyxAbstractAasBuilder parentBuilder, BaSyxSubmodel instance)	Creates an instance from an existing BaSyx instance.
protected	BaSyxSubmodelBuilder(AbstractAas.BaSyxAbstractAasBuilder parentBuilder, String idShort, String identifier, org.eclipse.digitaltwin.basyx.submodelrepository.client.ConnectedSubmodelRepository repo)	Creates an instance.

Method Summary

Modifier and Type	Method	Description
de.iip_ecosphere.platform.support.aas.Submodel	build()
void	buildDeferred()
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)
void	defer()
de.iip_ecosphere.platform.support.aas.Aas.AasBuilder	getAasBuilder()
protected String	getIdShort()	Returns the underlying collection instance.
protected AbstractSubmodel<org.eclipse.digitaltwin.aas4j.v3.model.Submodel>	getInstance()	Returns the underlying instance.
de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder	getParentBuilder()
boolean	hasElement(String idShort)
boolean	isNew()
de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder	rbac(de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor auth)
de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder	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)
de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder	setDescription(de.iip_ecosphere.platform.support.aas.LangString... description)
protected void	setInstance(BaSyxSubmodel instance)	Sets the instance.
de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder	setSemanticId(String refValue)

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

buildMyDeferred, composeRbacPath, createBlobDataElementBuilder, createEntityBuilder, createFileDataElementBuilder, createMultiLanguagePropertyBuilder, createOperationBuilder, createPropertyBuilder, createRangeBuilder, createReference, createReferenceElementBuilder, createRelationshipElementBuilder, defer, parents, register, register, register, register, register, register, register, register, 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.RbacReceiver

rbacAll, rbacAllAuthenticated, rbacDevice, rbacPlatform

Methods inherited from interface de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder

createReference, justBuild, rbac

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

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

Field Details

parentBuilder

private AbstractAas.BaSyxAbstractAasBuilder parentBuilder

instance

private BaSyxSubmodel instance

isNew

private boolean isNew

Constructor Details

BaSyxSubmodelBuilder

protected BaSyxSubmodelBuilder(AbstractAas.BaSyxAbstractAasBuilder parentBuilder,
 String idShort,
 String identifier,
 org.eclipse.digitaltwin.basyx.submodelrepository.client.ConnectedSubmodelRepository repo)

Creates an instance. Prevents external creation.

Parameters:

parentBuilder - the parent builder (may be null for a standalone sub-model)

idShort - the short id of the sub-model

identifier - the identifier of the model

Throws:

IllegalArgumentException - may be thrown if idShort is not given

BaSyxSubmodelBuilder

protected BaSyxSubmodelBuilder(AbstractAas.BaSyxAbstractAasBuilder parentBuilder)

Creates an uninitialized instance, e.g., for delayed creation. Use setInstance(BaSyxSubmodel).

Parameters:

parentBuilder - the parent builder (may be null for a standalone sub-model)

Throws:

IllegalArgumentException - may be thrown if idShort is not given

BaSyxSubmodelBuilder

protected BaSyxSubmodelBuilder(AbstractAas.BaSyxAbstractAasBuilder parentBuilder,
 BaSyxSubmodel instance)

Creates an instance from an existing BaSyx instance.

Parameters:

parentBuilder - the parent builder (may be null for a standalone sub-model)

instance - the BaSyx instance wrapper

Method Details

setInstance

protected void setInstance(BaSyxSubmodel instance)

Sets the instance.

Parameters:

instance - the wrapped instance

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

defer

public void defer()

Specified by:

defer in interface de.iip_ecosphere.platform.support.aas.DeferredBuilder<de.iip_ecosphere.platform.support.aas.Submodel>

buildDeferred

public void buildDeferred()

Specified by:

buildDeferred in interface de.iip_ecosphere.platform.support.aas.DeferredBuilder<de.iip_ecosphere.platform.support.aas.Submodel>

build

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

Specified by:

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

getAasBuilder

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

Specified by:

getAasBuilder 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

getParentBuilder

public de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder getParentBuilder()

Specified by:

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

getInstance

protected AbstractSubmodel<org.eclipse.digitaltwin.aas4j.v3.model.Submodel> getInstance()

Description copied from class: BaSyxSubmodelElementContainerBuilder

Returns the underlying instance.

Overrides:

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

Returns:

the instance

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

setSemanticId

public de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder setSemanticId(String refValue)

Specified by:

setSemanticId in interface de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder

Specified by:

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

rbac

public de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder 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.Submodel.SubmodelBuilder>

rbac

public de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder 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.Submodel.SubmodelBuilder>

setDescription

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

Specified by:

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