org.eclipse.basyx.components.aas.mongodb

Class MongoDBSubmodelAPI

java.lang.Object

org.eclipse.basyx.components.aas.mongodb.MongoDBSubmodelAPI

All Implemented Interfaces:

org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI

public class MongoDBSubmodelAPI
extends Object
implements org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI

Implements the ISubmodelAPI for a mongoDB backend.

Author:

espen

Constructor Summary

Constructors

Constructor and Description
MongoDBSubmodelAPI(BaSyxMongoDBConfiguration config, String smId) Receives the path of the configuration.properties file in it's constructor.
MongoDBSubmodelAPI(String smId) Constructor using default sql connections
MongoDBSubmodelAPI(String resourceConfigPath, String smId) Receives the path of the .properties file in it's constructor from a resource.

Method Summary

Modifier and Type	Method and Description
void	addSubmodelElement(org.eclipse.basyx.submodel.metamodel.api.submodelelement.ISubmodelElement elem)
void	addSubmodelElement(String idShortPath, org.eclipse.basyx.submodel.metamodel.api.submodelelement.ISubmodelElement elem)
void	deleteSubmodelElement(String idShortPath)
Object	getOperationResult(String idShort, String requestId)
Collection<org.eclipse.basyx.submodel.metamodel.api.submodelelement.operation.IOperation>	getOperations()
org.eclipse.basyx.submodel.metamodel.api.ISubModel	getSubmodel()
org.eclipse.basyx.submodel.metamodel.api.submodelelement.ISubmodelElement	getSubmodelElement(String idShortPath)
Collection<org.eclipse.basyx.submodel.metamodel.api.submodelelement.ISubmodelElement>	getSubmodelElements()
Object	getSubmodelElementValue(String idShortPath)
Object	invokeAsync(String idShortPath, Object... params)
Object	invokeOperation(String idShortPath, Object... params)
void	setConfiguration(BaSyxMongoDBConfiguration config) Sets the db configuration for the submodel API.
void	setSubModel(org.eclipse.basyx.submodel.metamodel.map.SubModel sm) Depending on whether the model is already in the db, this method inserts or replaces the existing data.
void	setSubmodelId(String smId) Sets the submodel id, so that this API points to the submodel with smId.
void	updateSubmodelElement(String idShortPath, Object newValue)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MongoDBSubmodelAPI

public MongoDBSubmodelAPI(BaSyxMongoDBConfiguration config,
                          String smId)

Receives the path of the configuration.properties file in it's constructor.

Parameters:

configFilePath -

MongoDBSubmodelAPI

public MongoDBSubmodelAPI(String resourceConfigPath,
                          String smId)

Receives the path of the .properties file in it's constructor from a resource.

MongoDBSubmodelAPI

public MongoDBSubmodelAPI(String smId)

Constructor using default sql connections

Method Detail

setConfiguration

public void setConfiguration(BaSyxMongoDBConfiguration config)

Sets the db configuration for the submodel API.

Parameters:

config -

setSubmodelId

public void setSubmodelId(String smId)

Sets the submodel id, so that this API points to the submodel with smId. Can be changed to point to a different submodel in the database.

Parameters:

smId -

setSubModel

public void setSubModel(org.eclipse.basyx.submodel.metamodel.map.SubModel sm)

Depending on whether the model is already in the db, this method inserts or replaces the existing data. The new submodel id for this API is taken from the given submodel.

Parameters:

sm -

getSubmodel

public org.eclipse.basyx.submodel.metamodel.api.ISubModel getSubmodel()

Specified by:

getSubmodel in interface org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI

addSubmodelElement

public void addSubmodelElement(org.eclipse.basyx.submodel.metamodel.api.submodelelement.ISubmodelElement elem)

Specified by:

addSubmodelElement in interface org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI

getOperations

public Collection<org.eclipse.basyx.submodel.metamodel.api.submodelelement.operation.IOperation> getOperations()

Specified by:

getOperations in interface org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI

getSubmodelElements

public Collection<org.eclipse.basyx.submodel.metamodel.api.submodelelement.ISubmodelElement> getSubmodelElements()

Specified by:

getSubmodelElements in interface org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI

getOperationResult

public Object getOperationResult(String idShort,
                                 String requestId)

Specified by:

getOperationResult in interface org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI

getSubmodelElement

public org.eclipse.basyx.submodel.metamodel.api.submodelelement.ISubmodelElement getSubmodelElement(String idShortPath)

Specified by:

getSubmodelElement in interface org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI

deleteSubmodelElement

public void deleteSubmodelElement(String idShortPath)

Specified by:

deleteSubmodelElement in interface org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI

updateSubmodelElement

public void updateSubmodelElement(String idShortPath,
                                  Object newValue)

Specified by:

updateSubmodelElement in interface org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI

getSubmodelElementValue

public Object getSubmodelElementValue(String idShortPath)

Specified by:

getSubmodelElementValue in interface org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI

invokeOperation

public Object invokeOperation(String idShortPath,
                              Object... params)

Specified by:

invokeOperation in interface org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI

invokeAsync

public Object invokeAsync(String idShortPath,
                          Object... params)

Specified by:

invokeAsync in interface org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI

addSubmodelElement

public void addSubmodelElement(String idShortPath,
                               org.eclipse.basyx.submodel.metamodel.api.submodelelement.ISubmodelElement elem)

Specified by:

addSubmodelElement in interface org.eclipse.basyx.submodel.restapi.api.ISubmodelAPI