Package de.iip_ecosphere.platform.support.iip_aas

Class ActiveAasBase

java.lang.Object

de.iip_ecosphere.platform.support.iip_aas.ActiveAasBase

public class ActiveAasBase
extends Object

Basic functions for active AAS with notification calls.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ActiveAasBase.NotificationMode	Supported notification modes.
static interface	ActiveAasBase.NotificationProcessor	Defines the interface for a notification processor.

Field Summary

Fields

Modifier and Type	Field	Description
private static ExecutorService	exec
private static final de.iip_ecosphere.platform.support.logging.Logger	LOGGER
private static ActiveAasBase.NotificationMode	mode

Constructor Summary

Constructors

Constructor	Description
ActiveAasBase()

Method Summary

Modifier and Type	Method	Description
static void	clearCollection(de.iip_ecosphere.platform.support.aas.SubmodelElementCollection coll, Predicate<de.iip_ecosphere.platform.support.aas.SubmodelElementCollection> pred)	Clears a collection from elements responding to the given with the given predicate.
static Predicate<de.iip_ecosphere.platform.support.aas.SubmodelElementCollection>	createPropertyPredicate(String propertyIdShort, Object propertyValue, String failMessage)	Returns a predicate, e.g., for clearCollection(SubmodelElementCollection, Predicate) to delete the given collection based on a property value.
static de.iip_ecosphere.platform.support.aas.Submodel	getSubmodel(String name)	Obtains a submodel of AasPartRegistry.retrieveIipAas().
static void	processNotification(String subId, ActiveAasBase.NotificationMode mode, ActiveAasBase.NotificationProcessor processor)	Processes a notification on a submodel of AasPartRegistry.retrieveIipAas().
static void	processNotification(String subId, ActiveAasBase.NotificationProcessor processor)	Processes a notification on a submodel of AasPartRegistry.retrieveIipAas() with the notification #mode mode set in this class.
static ActiveAasBase.NotificationMode	setNotificationMode(ActiveAasBase.NotificationMode mo)	Changes the notification execution mode.

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final de.iip_ecosphere.platform.support.logging.Logger LOGGER

mode

private static ActiveAasBase.NotificationMode mode

exec

private static ExecutorService exec

Constructor Details

ActiveAasBase

public ActiveAasBase()

Method Details

processNotification

public static void processNotification(String subId,
 ActiveAasBase.NotificationProcessor processor)

Processes a notification on a submodel of AasPartRegistry.retrieveIipAas() with the notification #mode mode set in this class.

Parameters:

subId - the short id of the submodel

processor - the processor to execute

processNotification

public static void processNotification(String subId,
 ActiveAasBase.NotificationMode mode,
 ActiveAasBase.NotificationProcessor processor)

Processes a notification on a submodel of AasPartRegistry.retrieveIipAas().

Parameters:

subId - the short id of the submodel

mode - explicit notification mode to be used if mode is not ActiveAasBase.NotificationMode.NONE. If parameter is null, use mode instead

processor - the processor to execute

setNotificationMode

public static ActiveAasBase.NotificationMode setNotificationMode(ActiveAasBase.NotificationMode mo)

Changes the notification execution mode. [for testing]

Parameters:

mo - the new mode

Returns:

the last notification mode

getSubmodel

public static de.iip_ecosphere.platform.support.aas.Submodel getSubmodel(String name)
                                                                  throws IOException

Obtains a submodel of AasPartRegistry.retrieveIipAas().

Parameters:

name - the name of the submodel

Returns:

the submodel

Throws:

IOException - if the submodel cannot be found

clearCollection

public static void clearCollection(de.iip_ecosphere.platform.support.aas.SubmodelElementCollection coll,
 Predicate<de.iip_ecosphere.platform.support.aas.SubmodelElementCollection> pred)

Clears a collection from elements responding to the given with the given predicate.

Parameters:

coll - the collection to be cleared

pred - the predicate

createPropertyPredicate

public static Predicate<de.iip_ecosphere.platform.support.aas.SubmodelElementCollection> createPropertyPredicate(String propertyIdShort,
 Object propertyValue,
 String failMessage)

Returns a predicate, e.g., for clearCollection(SubmodelElementCollection, Predicate) to delete the given collection based on a property value.

Parameters:

propertyIdShort - the property to look for

propertyValue - the value to cause the deletion

failMessage - if an exception occurs, the message lead in (will be followed by the exception message)

Returns:

the predicate