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

Class BaSyxSubmodelElementCollection.BaSyxSubmodelElementCollectionBuilder

java.lang.Object

de.iip_ecosphere.platform.support.aas.basyx.BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>

de.iip_ecosphere.platform.support.aas.basyx.BaSyxSubmodelElementCollection.BaSyxSubmodelElementCollectionBuilder

All Implemented Interfaces:

de.iip_ecosphere.platform.support.aas.DeferredBuilder<de.iip_ecosphere.platform.support.aas.SubmodelElementCollection>, de.iip_ecosphere.platform.support.aas.SubmodelElementCollection.SubmodelElementCollectionBuilder, de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder, de.iip_ecosphere.platform.support.Builder<de.iip_ecosphere.platform.support.aas.SubmodelElementCollection>

Direct Known Subclasses:

BaSyxFurtherInformation.BaSyxFurtherInformationBuilder, BaSyxGeneralInformation.BaSyxGeneralInformationBuilder, BaSyxProductClassificationItem.BaSyxProductClassificationItemBuilder, BaSyxProductClassifications.BaSyxProductClassificationsBuilder, BaSyxTechnicalProperties.BaSyxTechnicalPropertiesBuilder

Enclosing class:

BaSyxSubmodelElementCollection

public static class BaSyxSubmodelElementCollection.BaSyxSubmodelElementCollectionBuilder
extends BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>
implements de.iip_ecosphere.platform.support.aas.SubmodelElementCollection.SubmodelElementCollectionBuilder

The sub-model element collection builder.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private org.eclipse.basyx.submodel.metamodel.api.submodelelement.ISubmodelElementCollection	collection
private BaSyxSubmodelElementCollection	instance
private boolean	isNew
private BaSyxSubmodelElementContainerBuilder<?>	parentBuilder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaSyxSubmodelElementCollectionBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder, BaSyxSubmodelElementCollection instance)	Creates an instance from an existing BaSyx instance.
protected	BaSyxSubmodelElementCollectionBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder, java.lang.String idShort, boolean ordered, boolean allowDuplicates)	Creates a sub-model element collection builder.
protected	BaSyxSubmodelElementCollectionBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder, java.lang.String idShort, java.util.function.Supplier<BaSyxSubmodelElementCollection> wCreator, java.util.function.Supplier<org.eclipse.basyx.submodel.metamodel.map.submodelelement.SubmodelElementCollection> bCreator)	Creates a sub-model element collection builder.

Method Summary

Modifier and Type	Method	Description
BaSyxSubmodelElementCollection	build()
void	buildDeferred()
(package private) void	buildMyDeferred()	Calls Builder.build() on all deferred builders.
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)
de.iip_ecosphere.platform.support.aas.SubmodelElementCollection.SubmodelElementCollectionBuilder	createSubmodelElementCollectionBuilder(java.lang.String idShort, boolean ordered, boolean allowDuplicates)
void	defer()
(package private) void	defer(java.lang.String shortId, de.iip_ecosphere.platform.support.Builder<?> builder)	Registers a sub-build as deferred.
de.iip_ecosphere.platform.support.aas.Aas.AasBuilder	getAasBuilder()
protected org.eclipse.basyx.submodel.metamodel.api.submodelelement.ISubmodelElementCollection	getCollection()	Returns the BaSyx collection created by this instance.
protected BaSyxSubmodelElementCollection	getCollectionInstance()	Returns the collection instance being created.
protected AbstractSubmodel<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>	getInstance()	Returns the underlying instance.
de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder	getParentBuilder()
boolean	isNew()
protected BaSyxFile	register(BaSyxFile file)	Registers a file data element.
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 BaSyxSubmodelElementCollection	register(BaSyxSubmodelElementCollection collection)	Registers a sub-model element collection.

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

createFileDataElementBuilder

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

createFileDataElementBuilder

Field Detail

parentBuilder

private BaSyxSubmodelElementContainerBuilder<?> parentBuilder

instance

private BaSyxSubmodelElementCollection instance

collection

private org.eclipse.basyx.submodel.metamodel.api.submodelelement.ISubmodelElementCollection collection

isNew

private boolean isNew

Constructor Detail

BaSyxSubmodelElementCollectionBuilder

protected BaSyxSubmodelElementCollectionBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder,
                                                java.lang.String idShort,
                                                boolean ordered,
                                                boolean allowDuplicates)

Creates a sub-model element collection builder. The parent builder must be set by the calling constructor.

Parameters:

parentBuilder - the parent builder

idShort - the short name of the sub-model element

ordered - whether the collection is ordered

allowDuplicates - whether the collection allows duplicates

Throws:

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

BaSyxSubmodelElementCollectionBuilder

protected BaSyxSubmodelElementCollectionBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder,
                                                java.lang.String idShort,
                                                java.util.function.Supplier<BaSyxSubmodelElementCollection> wCreator,
                                                java.util.function.Supplier<org.eclipse.basyx.submodel.metamodel.map.submodelelement.SubmodelElementCollection> bCreator)

Creates a sub-model element collection builder. The parent builder must be set by the calling constructor.

Parameters:

parentBuilder - the parent builder

idShort - the short name of the sub-model element

wCreator - creates a wrapper instance, subclass of the containing class

bCreator - creates a BaSyx instance

Throws:

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

BaSyxSubmodelElementCollectionBuilder

protected BaSyxSubmodelElementCollectionBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder,
                                                BaSyxSubmodelElementCollection instance)

Creates an instance from an existing BaSyx instance.

Parameters:

parentBuilder - the parent builder

instance - the BaSyx instance

Method Detail

getCollection

protected org.eclipse.basyx.submodel.metamodel.api.submodelelement.ISubmodelElementCollection getCollection()

Returns the BaSyx collection created by this instance.

Returns:

the collection

getCollectionInstance

protected BaSyxSubmodelElementCollection getCollectionInstance()

Returns the collection instance being created.

Returns:

the collection instance

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

Overrides:

createPropertyBuilder in class BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>

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

Overrides:

createReferenceElementBuilder in class BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>

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

Overrides:

createOperationBuilder in class BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>

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

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.SubmodelElementCollection.SubmodelElementCollectionBuilder

Overrides:

createReference in class BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>

Returns:

the reference

register

protected BaSyxFile register(BaSyxFile file)

Description copied from class: BaSyxSubmodelElementContainerBuilder

Registers a file data element.

Overrides:

register in class BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>

Parameters:

file - the file data element

Returns:

file

register

protected BaSyxOperation register(BaSyxOperation operation)

Description copied from class: BaSyxSubmodelElementContainerBuilder

Registers an operation.

Overrides:

register in class BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>

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.basyx.submodel.metamodel.api.ISubmodel>

Parameters:

property - the property

Returns:

property

register

protected BaSyxReferenceElement register(BaSyxReferenceElement reference)

Description copied from class: BaSyxSubmodelElementContainerBuilder

Registers a reference element.

Overrides:

register in class BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>

Parameters:

reference - the reference

Returns:

reference

register

protected BaSyxSubmodelElementCollection register(BaSyxSubmodelElementCollection collection)

Description copied from class: BaSyxSubmodelElementContainerBuilder

Registers a sub-model element collection.

Overrides:

register in class BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>

Parameters:

collection - the collection

Returns:

collection

defer

public void defer()

Specified by:

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

defer

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

Description copied from class: BaSyxSubmodelElementContainerBuilder

Registers a sub-build as deferred.

Overrides:

defer in class BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>

Parameters:

shortId - the shortId of the element

builder - the sub-builder to be registered

See Also:

BaSyxSubmodelElementContainerBuilder.buildMyDeferred()

buildMyDeferred

void buildMyDeferred()

Description copied from class: BaSyxSubmodelElementContainerBuilder

Calls Builder.build() on all deferred builders.

Overrides:

buildMyDeferred in class BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>

See Also:

BaSyxSubmodelElementContainerBuilder.defer(String, Builder)

buildDeferred

public void buildDeferred()

Specified by:

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

build

public BaSyxSubmodelElementCollection build()

Specified by:

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

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.api.ISubmodel> getInstance()

Description copied from class: BaSyxSubmodelElementContainerBuilder

Returns the underlying instance.

Specified by:

getInstance in class BaSyxSubmodelElementContainerBuilder<org.eclipse.basyx.submodel.metamodel.api.ISubmodel>

Returns:

the instance

isNew

public boolean isNew()

Specified by:

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