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.SubmodelElementCollection.SubmodelElementCollectionBuilder, de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder, de.iip_ecosphere.platform.support.Builder<de.iip_ecosphere.platform.support.aas.SubmodelElementCollection>

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.map.submodelelement.SubmodelElementCollection	collection
private BaSyxSubmodelElementCollection	instance
private boolean	isNew
private BaSyxSubmodelElementContainerBuilder<?>	parentBuilder

Constructor Summary

Constructors

Constructor	Description
BaSyxSubmodelElementCollectionBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder, BaSyxSubmodelElementCollection instance)	Creates an instance from an existing BaSyx instance.
BaSyxSubmodelElementCollectionBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder, String idShort, boolean ordered, boolean allowDuplicates)	Creates a sub-model element collection builder.

Method Summary

Modifier and Type	Method	Description
BaSyxSubmodelElementCollection	build()
de.iip_ecosphere.platform.support.aas.Operation.OperationBuilder	createOperationBuilder(String idShort)
de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder	createPropertyBuilder(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(String idShort)
de.iip_ecosphere.platform.support.aas.SubmodelElementCollection.SubmodelElementCollectionBuilder	createSubmodelElementCollectionBuilder(String idShort, boolean ordered, boolean allowDuplicates)
de.iip_ecosphere.platform.support.aas.Aas.AasBuilder	getAasBuilder()
protected AbstractSubmodel<org.eclipse.basyx.submodel.metamodel.api.ISubModel>	getInstance()	Returns the underlying instance.
de.iip_ecosphere.platform.support.aas.SubmodelElementContainerBuilder	getParentBuilder()
boolean	isNew()
(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.
(package private) 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

Field Details

parentBuilder

private BaSyxSubmodelElementContainerBuilder<?> parentBuilder

instance

private BaSyxSubmodelElementCollection instance

collection

private org.eclipse.basyx.submodel.metamodel.map.submodelelement.SubmodelElementCollection collection

isNew

private boolean isNew

Constructor Details

BaSyxSubmodelElementCollectionBuilder

BaSyxSubmodelElementCollectionBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder, 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:

IllegalArgumentException - may be thrown if idShort is not given

BaSyxSubmodelElementCollectionBuilder

BaSyxSubmodelElementCollectionBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder, BaSyxSubmodelElementCollection instance)

Creates an instance from an existing BaSyx instance.

Parameters:

parentBuilder - the parent builder

instance - the BaSyx instance

Method Details

createPropertyBuilder

public de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder createPropertyBuilder(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(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(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(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

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

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

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

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

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