Package io.openems.common.types

Class EdgeConfig.Component

java.lang.Object

io.openems.common.types.EdgeConfig.Component

Enclosing class:

EdgeConfig

public static class EdgeConfig.Component
extends Object

Represents an instance of an OpenEMS Component.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EdgeConfig.Component.Channel	Represents a Channel of an OpenEMS Component.
static enum	EdgeConfig.Component.JsonFormat

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NO_SERVICE_PID

Constructor Summary

Constructors

Constructor	Description
Component(String id, String alias, String factoryId, com.google.gson.JsonObject properties)	Constructor with NO_SERVICE_PID, properties as JsonObject and no channels.
Component(String servicePid, String id, String alias, String factoryId, SortedMap<String,com.google.gson.JsonElement> properties, SortedMap<String,EdgeConfig.Component.Channel> channels)
Component(String id, String alias, String factoryId, SortedMap<String,com.google.gson.JsonElement> properties, SortedMap<String,EdgeConfig.Component.Channel> channels)	Constructor with NO_SERVICE_PID.

Method Summary

Modifier and Type	Method	Description
static EdgeConfig.Component	fromJson(String componentId, com.google.gson.JsonElement json)	Creates a Component from JSON.
String	getAlias()	Gets the Alias of the EdgeConfig.Component.
Map<String,EdgeConfig.Component.Channel>	getChannels()	Gets a map of EdgeConfig.Component.Channels of the EdgeConfig.Component.
Map<String,EdgeConfig.Component.Channel>	getChannelsOfCategory(ChannelCategory channelCategory)	Gets the Channels of the given ChannelCategory.
String	getFactoryId()	Gets the Factory-ID of the EdgeConfig.Component, e.g.
String	getId()	Gets the ID of the EdgeConfig.Component, e.g.
String	getPid()	Gets the PID of the EdgeConfig.Component.
Map<String,com.google.gson.JsonElement>	getProperties()	Gets the Properties of the EdgeConfig.Component.
Optional<com.google.gson.JsonElement>	getProperty(String propertyId)	Gets the Property with the given ID.
com.google.gson.JsonElement	getPropertyOrError(String propertyId)	Gets the Property with the given ID or throws an Exception if it does not exist.
Optional<EdgeConfig.Component.Channel>	getStateChannel(String channelId)	Get the StateChannel with the given Channel-ID.
Map<String,EdgeConfig.Component.Channel>	getStateChannels()	Gets the StateChannels.
boolean	isStateChannel(String channelId)	Is the given Channel-ID a StateChannel?.
void	setChannels(Map<String,EdgeConfig.Component.Channel> channels)
com.google.gson.JsonObject	toJson(EdgeConfig.Component.JsonFormat jsonFormat)	Returns the Component configuration as a JSON Object.

Methods inherited from class java.lang.Object

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

Field Details

NO_SERVICE_PID

public static final String NO_SERVICE_PID

See Also:

• Constant Field Values

Constructor Details

Component

public Component(String servicePid,
 String id,
 String alias,
 String factoryId,
 SortedMap<String,com.google.gson.JsonElement> properties,
 SortedMap<String,EdgeConfig.Component.Channel> channels)

Component

public Component(String id,
 String alias,
 String factoryId,
 SortedMap<String,com.google.gson.JsonElement> properties,
 SortedMap<String,EdgeConfig.Component.Channel> channels)

Constructor with NO_SERVICE_PID.

Parameters:

id - the Component-ID

alias - the Alias

factoryId - the Factory-ID

properties - the configuration properties

channels - the channels

Component

public Component(String id,
 String alias,
 String factoryId,
 com.google.gson.JsonObject properties)

Constructor with NO_SERVICE_PID, properties as JsonObject and no channels.

Parameters:

id - the Component-ID

alias - the Alias

factoryId - the Factory-ID

properties - the configuration properties

Method Details

getPid

public String getPid()

Gets the PID of the EdgeConfig.Component.

Returns:

the PID

getId

public String getId()

Gets the ID of the EdgeConfig.Component, e.g. 'ctrlDebugLog0'.

Returns:

the Component-ID

getAlias

public String getAlias()

Gets the Alias of the EdgeConfig.Component.

Returns:

the Alias

getFactoryId

public String getFactoryId()

Gets the Factory-ID of the EdgeConfig.Component, e.g. 'Controller.Debug.Log'.

Returns:

the Factory-ID

getProperties

public Map<String,com.google.gson.JsonElement> getProperties()

Gets the Properties of the EdgeConfig.Component.

Returns:

the Properties

getProperty

public Optional<com.google.gson.JsonElement> getProperty(String propertyId)

Gets the Property with the given ID.

Parameters:

propertyId - the Property-ID

Returns:

the Property as Optional

getPropertyOrError

public com.google.gson.JsonElement getPropertyOrError(String propertyId)
                                               throws InvalidValueException

Gets the Property with the given ID or throws an Exception if it does not exist.

Parameters:

propertyId - the Property-ID

Returns:

the Property

Throws:

InvalidValueException

getChannels

public Map<String,EdgeConfig.Component.Channel> getChannels()

Gets a map of EdgeConfig.Component.Channels of the EdgeConfig.Component.

Returns:

the map of EdgeConfig.Component.Channels by their Channel-IDs.

setChannels

public void setChannels(Map<String,EdgeConfig.Component.Channel> channels)

getChannelsOfCategory

public Map<String,EdgeConfig.Component.Channel> getChannelsOfCategory(ChannelCategory channelCategory)

Gets the Channels of the given ChannelCategory.

Parameters:

channelCategory - the ChannelCategory

Returns:

a map of EdgeConfig.Component.Channels

getStateChannels

public Map<String,EdgeConfig.Component.Channel> getStateChannels()

Gets the StateChannels.

Returns:

the StateChannels

isStateChannel

public boolean isStateChannel(String channelId)

Is the given Channel-ID a StateChannel?.

Parameters:

channelId - the Channel-ID

Returns:

true if it is a StateChannel

getStateChannel

public Optional<EdgeConfig.Component.Channel> getStateChannel(String channelId)

Get the StateChannel with the given Channel-ID.

Parameters:

channelId - the Channel-ID

Returns:

the Channel; or empty if the Channel does not exist or is not a StateChannel.

toJson

public com.google.gson.JsonObject toJson(EdgeConfig.Component.JsonFormat jsonFormat)

Returns the Component configuration as a JSON Object.

 {
   alias: string,
   factoryId: string,
         properties: {
     [key: string]: value
   },
   channels: {
     [channelId: string]: {}
   }
 }
 

Parameters:

jsonFormat - the EdgeConfig.Component.JsonFormat

Returns:

configuration as a JSON Object

fromJson

public static EdgeConfig.Component fromJson(String componentId,
 com.google.gson.JsonElement json)
                                     throws OpenemsError.OpenemsNamedException

Creates a Component from JSON.

Parameters:

componentId - the Component-ID

json - the JSON

Returns:

the Component

Throws:

OpenemsError.OpenemsNamedException - on error