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

Class BaSyxSubmodelElementContainerBuilder<S extends org.eclipse.basyx.submodel.metamodel.api.ISubmodel>

java.lang.Object

de.iip_ecosphere.platform.support.aas.basyx.BaSyxSubmodelElementContainerBuilder<S>

Type Parameters:

S - the BaSyx type implementing the sub-model

All Implemented Interfaces:

de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder

Direct Known Subclasses:

BaSyxISubmodel.BaSyxISubmodelBuilder, BaSyxSubmodel.BaSyxSubmodelBuilder, BaSyxSubmodelElementCollection.BaSyxSubmodelElementCollectionBuilder

public abstract class BaSyxSubmodelElementContainerBuilder<S extends org.eclipse.basyx.submodel.metamodel.api.ISubmodel>
extends java.lang.Object
implements de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder

Basic implementation for a container-based model element. Subclasses must call buildMyDeferred() in an appropriate method (usually Builder.build()) and use DeferredBuilder.getDeferred(String, Class, java.util.Map) when potentially creating a builder that could be deferred.

Author:

Holger Eichelberger, SSE

Constructor Summary

Constructors

Constructor	Description
BaSyxSubmodelElementContainerBuilder()

Method Summary

Modifier and Type	Method	Description
(package private) void	buildMyDeferred()	Calls Builder.build() on all deferred builders.
de.iip_ecosphere.platform.support.aas.FileDataElement.FileDataElementBuilder	createFileDataElementBuilder(java.lang.String idShort, java.lang.String contents, java.lang.String mimeType)
de.iip_ecosphere.platform.support.aas.Operation.OperationBuilder	createOperationBuilder(java.lang.String idShort)
de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder	createPropertyBuilder(java.lang.String idShort)
de.iip_ecosphere.platform.support.aas.Reference	createReference()	Creates a reference to the sub-model under creation.
de.iip_ecosphere.platform.support.aas.ReferenceElement.ReferenceElementBuilder	createReferenceElementBuilder(java.lang.String idShort)
(package private) void	defer(java.lang.String shortId, de.iip_ecosphere.platform.support.Builder<?> builder)	Registers a sub-build as deferred.
protected abstract AbstractSubmodel<S>	getInstance()	Returns the underlying instance.
(package private) BaSyxFile	register(BaSyxFile file)	Registers a file data element.
(package private) BaSyxOperation	register(BaSyxOperation operation)	Registers an operation.
(package private) BaSyxProperty	register(BaSyxProperty property)	Registers a property.
(package private) BaSyxReferenceElement	register(BaSyxReferenceElement reference)	Registers a reference element.
protected BaSyxSubmodelElementCollection	register(BaSyxSubmodelElementCollection collection)	Registers a sub-model element collection.

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.SubmodelElementContainerBuilder

createSubmodelElementCollectionBuilder, getAasBuilder, getParentBuilder, isNew

Constructor Detail

BaSyxSubmodelElementContainerBuilder

public BaSyxSubmodelElementContainerBuilder()

Method Detail

createPropertyBuilder

public de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder createPropertyBuilder(java.lang.String idShort)

Specified by:

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

createReferenceElementBuilder

public de.iip_ecosphere.platform.support.aas.ReferenceElement.ReferenceElementBuilder createReferenceElementBuilder(java.lang.String idShort)

Specified by:

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

createOperationBuilder

public de.iip_ecosphere.platform.support.aas.Operation.OperationBuilder createOperationBuilder(java.lang.String idShort)

Specified by:

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

createFileDataElementBuilder

public de.iip_ecosphere.platform.support.aas.FileDataElement.FileDataElementBuilder createFileDataElementBuilder(java.lang.String idShort,
                                                                                                                 java.lang.String contents,
                                                                                                                 java.lang.String mimeType)

Specified by:

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

createReference

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

Creates a reference to the sub-model under creation.

Returns:

the reference

getInstance

protected abstract AbstractSubmodel<S> getInstance()

Returns the underlying instance.

Returns:

the instance

register

BaSyxFile register(BaSyxFile file)

Registers a file data element.

Parameters:

file - the file data element

Returns:

file

register

BaSyxOperation register(BaSyxOperation operation)

Registers an operation.

Parameters:

operation - the operation

Returns:

operation

register

BaSyxProperty register(BaSyxProperty property)

Registers a property.

Parameters:

property - the property

Returns:

property

register

BaSyxReferenceElement register(BaSyxReferenceElement reference)

Registers a reference element.

Parameters:

reference - the reference

Returns:

reference

register

protected BaSyxSubmodelElementCollection register(BaSyxSubmodelElementCollection collection)

Registers a sub-model element collection.

Parameters:

collection - the collection

Returns:

collection

defer

void defer(java.lang.String shortId,
           de.iip_ecosphere.platform.support.Builder<?> builder)

Registers a sub-build as deferred.

Parameters:

shortId - the shortId of the element

builder - the sub-builder to be registered

See Also:

buildMyDeferred()

buildMyDeferred

void buildMyDeferred()

Calls Builder.build() on all deferred builders.

See Also:

defer(String, Builder)