Package de.iip_ecosphere.platform.support.aas.basyx

Class BaSyxSubmodel.BaSyxSubmodelBuilder

java.lang.Object

de.iip_ecosphere.platform.support.aas.basyx.BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.map.Submodel>

de.iip_ecosphere.platform.support.aas.basyx.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.Submodel.SubmodelBuilder, de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder, de.iip_ecosphere.platform.support.Builder<de.iip_ecosphere.platform.support.aas.Submodel>

Direct Known Subclasses:

BaSyxTechnicalDataSubmodel.BaSyxTechnicalDataSubmodelBuilder

Enclosing class:

BaSyxSubmodel

protected static class BaSyxSubmodel.BaSyxSubmodelBuilder
extends BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.map.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.
(package private)	BaSyxSubmodelBuilder(AbstractAas.BaSyxAbstractAasBuilder parentBuilder, java.lang.String idShort, java.lang.String identifier)	Creates an instance.
protected	BaSyxSubmodelBuilder(AbstractAas.BaSyxAbstractAasBuilder parentBuilder, java.lang.String idShort, org.eclipse.basyx.submodel.metamodel.api.identifier.IIdentifier identifier)	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(java.lang.String idShort, boolean ordered, boolean allowDuplicates)
void	defer()
de.iip_ecosphere.platform.support.aas.Aas.AasBuilder	getAasBuilder()
protected AbstractSubmodel<org.eclipse.basyx.submodel.metamodel.map.Submodel>	getInstance()	Returns the underlying instance.
de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder	getParentBuilder()
boolean	isNew()
protected void	setInstance(BaSyxSubmodel instance)	Sets the instance.

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

buildMyDeferred, createFileDataElementBuilder, createOperationBuilder, createPropertyBuilder, createReference, createReferenceElementBuilder, defer, register, register, register, register, register

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.Submodel.SubmodelBuilder

createReference

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

createFileDataElementBuilder, createOperationBuilder, createPropertyBuilder, createReferenceElementBuilder

Field Detail

parentBuilder

private AbstractAas.BaSyxAbstractAasBuilder parentBuilder

instance

private BaSyxSubmodel instance

isNew

private boolean isNew

Constructor Detail

BaSyxSubmodelBuilder

BaSyxSubmodelBuilder(AbstractAas.BaSyxAbstractAasBuilder parentBuilder,
                     java.lang.String idShort,
                     java.lang.String identifier)

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 sub-model (may be null or empty for an identification based on idShort, interpreted as an URN if this starts with urn)

Throws:

java.lang.IllegalArgumentException - may be thrown if idShort is not given

BaSyxSubmodelBuilder

protected BaSyxSubmodelBuilder(AbstractAas.BaSyxAbstractAasBuilder parentBuilder,
                               java.lang.String idShort,
                               org.eclipse.basyx.submodel.metamodel.api.identifier.IIdentifier identifier)

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:

java.lang.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:

java.lang.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 Detail

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(java.lang.String idShort,
                                                                                                                                               boolean ordered,
                                                                                                                                               boolean allowDuplicates)

Specified by:

createSubmodelElementCollectionBuilder 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

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.basyx.submodel.metamodel.map.Submodel> getInstance()

Description copied from class: BaSyxSubmodelElementContainerBuilder

Returns the underlying instance.

Specified by:

getInstance in class BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.map.Submodel>

Returns:

the instance

isNew

public boolean isNew()

Specified by:

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