org.da.protoframework.uaappli

Class AbstractFunctionalUA

java.lang.Object

org.da.protoframework.uaappli.AbstractFunctionalUA

All Implemented Interfaces:

FunctionalUA

Direct Known Subclasses:

ScriptedFunctionalUA

public abstract class AbstractFunctionalUA
extends java.lang.Object
implements FunctionalUA

The abstract User Applications implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected arinc661.client.api.StatefullAPI	api The ARINC 661 API.
protected org.da.protoframework.conf.FrameworkLogger	logger The Logger.
protected org.da.protoframework.model.core.Module	module The Module.
protected org.da.protoframework.model.core.ServiceInstance<?,?>	provideService The default Service Instance.
protected A661RuntimeAPI	runtimeAPIHelper The ARINC 661 runtime API helper.
protected java.util.Map<org.da.protoframework.model.namespace.NamespaceKey,org.da.protoframework.model.core.ServiceInstance<?,?>>	services The Services Instances.
protected java.util.Map<java.lang.String,org.da.protoframework.model.core.ServiceInstance<?,?>>	servicesByName The Services Instances.
protected org.da.protoframework.model.core.ServiceInstance<?,?>	subscribeService The default Service Instance.

Constructor Summary

Constructors

Constructor and Description
AbstractFunctionalUA()

Method Summary

Modifier and Type	Method and Description
java.lang.String	formatValueAsString(java.lang.String name, java.lang.String format) Return the value of a Data as a String.
java.lang.String	formatValueAsString(java.lang.String serviceName, java.lang.String name, java.lang.String format) Return the value of a Data as a String.
java.lang.String	formatValueAsString(java.lang.String uri, java.lang.String serviceName, java.lang.String name, java.lang.String format) Return the value of a Data as a String.
A661RuntimeAPI	getA661RuntimeAPI() Return the A661 runtime API helper.
java.util.List<java.lang.Object>	getArrayValue(java.lang.String name) Return the data value as an array.
java.util.List<java.lang.Object>	getArrayValue(java.lang.String serviceName, java.lang.String name) Return the data value as an array.
java.util.List<java.lang.Object>	getArrayValue(java.lang.String uri, java.lang.String serviceName, java.lang.String name) Return the data value as an array.
boolean	getBooleanValue(java.lang.String name) Return the value of a Data as a boolean.
boolean	getBooleanValue(java.lang.String serviceName, java.lang.String name) Return the value of a Data as a boolean.
boolean	getBooleanValue(java.lang.String uri, java.lang.String serviceName, java.lang.String name) Return the value of a Data as a boolean.
java.lang.ClassLoader	getClassLoader() Return the ClassLoader used for loading the UA
org.da.protoframework.model.core.Data<?>	getData(java.lang.String name) Return the Data of a specified name for the default subscribed Service.
org.da.protoframework.model.core.Data<?>	getData(java.lang.String serviceName, java.lang.String name) Return the Data of a specified name for a specified Service.
org.da.protoframework.model.core.Data<?>	getData(java.lang.String uri, java.lang.String serviceName, java.lang.String name) Return the Data of a specified name for a specified Service.
float	getFloatValue(java.lang.String name) Return the value of a Data as a float.
float	getFloatValue(java.lang.String name, short unit) Return the value of a Data as a float.
float	getFloatValue(java.lang.String serviceName, java.lang.String name) Return the value of a Data as a float.
float	getFloatValue(java.lang.String serviceName, java.lang.String name, short unit) Return the value of a Data as a float.
float	getFloatValue(java.lang.String uri, java.lang.String serviceName, java.lang.String name) Return the value of a Data as a float.
float	getFloatValue(java.lang.String uri, java.lang.String serviceName, java.lang.String name, short unit) Return the value of a Data as a float.
int	getIntValue(java.lang.String name) Return the value of a Data as an int.
int	getIntValue(java.lang.String serviceName, java.lang.String name) Return the value of a Data as an int.
int	getIntValue(java.lang.String uri, java.lang.String serviceName, java.lang.String name) Return the value of a Data as an int.
short	getShortValue(java.lang.String name) Return the value of a Data as a short.
short	getShortValue(java.lang.String serviceName, java.lang.String name) Return the value of a Data as a short.
short	getShortValue(java.lang.String uri, java.lang.String serviceName, java.lang.String name) Return the value of a Data as a short.
java.lang.String	getStateValueAsString(java.lang.String name) Return the value of a enumeration state as a String.
java.lang.String	getStateValueAsString(java.lang.String serviceName, java.lang.String name) Return the value of a enumeration state as a String.
java.lang.String	getStateValueAsString(java.lang.String uri, java.lang.String serviceName, java.lang.String name) Return the value of a enumeration state as a String.
java.lang.String	getStringValue(java.lang.String name) Return the value of a Data as a String.
java.lang.String	getStringValue(java.lang.String serviceName, java.lang.String name) Return the value of a Data as a String.
java.lang.String	getStringValue(java.lang.String uri, java.lang.String serviceName, java.lang.String name) Return the value of a Data as a String.
java.util.List<java.lang.Object>	getStructureValue(java.lang.String name) Return the value of a Data as a structure.
java.util.List<java.lang.Object>	getStructureValue(java.lang.String serviceName, java.lang.String name) Return the value of a Data as a structure.
java.util.List<java.lang.Object>	getStructureValue(java.lang.String uri, java.lang.String serviceName, java.lang.String name) Return the value of a Data as a structure.
java.lang.Object	getValue(java.lang.String name) Return the value of a Data.
java.lang.Object	getValue(java.lang.String serviceName, java.lang.String name) Return the value of a Data.
java.lang.Object	getValue(java.lang.String uri, java.lang.String serviceName, java.lang.String name) Return the value of a Data.
boolean	hasChanged(java.lang.String name) Return true if a Data has changed.
boolean	hasChanged(java.lang.String serviceName, java.lang.String name) Return true if a Data has changed.
boolean	hasChanged(java.lang.String uri, java.lang.String serviceName, java.lang.String name) Return true if a Data has changed.
void	hideServerFrame() Hide the Server frame.
boolean	isStateValue(java.lang.String name, java.lang.String stateAsString) Return true if the value of a enumeration state as a String is equal to a specified String.
boolean	isStateValue(java.lang.String serviceName, java.lang.String name, java.lang.String stateAsString) Return true if the value of a enumeration state as a String is equal to a specified String.
boolean	isStateValue(java.lang.String uri, java.lang.String serviceName, java.lang.String name, java.lang.String stateAsString) Return true if the value of a enumeration state as a String is equal to a specified String.
void	setAPI(arinc661.client.api.StatefullAPI api) Set the API.
void	setClassLoader(java.lang.ClassLoader loader) Set the ClassLoader used for loading the UA.
void	setDatasToService(java.util.Map<java.lang.String,org.da.protoframework.model.core.ServiceInstance<?,?>> data2Service)
void	setDefaultProvideService(org.da.protoframework.model.core.ServiceInstance<?,?> service) Set the Service Instance.
void	setDefaultSubscribeService(org.da.protoframework.model.core.ServiceInstance<?,?> service) Set the Service Instance.
void	setModule(org.da.protoframework.model.core.Module module) Set the Module.
void	setServerAlwaysOnTop() Set the Server frame as always on top.
void	setServerToFront() Set the Server frame to front.
void	setServices(java.util.Map<org.da.protoframework.model.namespace.NamespaceKey,org.da.protoframework.model.core.ServiceInstance<?,?>> services) Set the Services Instances.
void	setUAApplication(UAApplication uaAppli) Set the UAApplication module.
void	showServerFrame() Show the Server frame.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.da.protoframework.uaappli.FunctionalUA

connected, disconnected, init, preConfigure, push, subscribe

Field Detail

subscribeService

protected org.da.protoframework.model.core.ServiceInstance<?,?> subscribeService

The default Service Instance.

provideService

protected org.da.protoframework.model.core.ServiceInstance<?,?> provideService

The default Service Instance.

services

protected java.util.Map<org.da.protoframework.model.namespace.NamespaceKey,org.da.protoframework.model.core.ServiceInstance<?,?>> services

The Services Instances.

servicesByName

protected java.util.Map<java.lang.String,org.da.protoframework.model.core.ServiceInstance<?,?>> servicesByName

The Services Instances.

api

protected arinc661.client.api.StatefullAPI api

The ARINC 661 API.

runtimeAPIHelper

protected A661RuntimeAPI runtimeAPIHelper

The ARINC 661 runtime API helper.

logger

protected org.da.protoframework.conf.FrameworkLogger logger

The Logger.

module

protected org.da.protoframework.model.core.Module module

The Module.

Constructor Detail

AbstractFunctionalUA

public AbstractFunctionalUA()

Method Detail

setUAApplication

public void setUAApplication(UAApplication uaAppli)

Set the UAApplication module.

Specified by:

setUAApplication in interface FunctionalUA

Parameters:

uaAppli - the UAApplication module

getA661RuntimeAPI

public A661RuntimeAPI getA661RuntimeAPI()

Return the A661 runtime API helper.

Specified by:

getA661RuntimeAPI in interface FunctionalUA

Returns:

the the A661 runtime API helper

setServerAlwaysOnTop

public void setServerAlwaysOnTop()

Set the Server frame as always on top.

setServerToFront

public void setServerToFront()

Set the Server frame to front.

hideServerFrame

public void hideServerFrame()

Hide the Server frame.

showServerFrame

public void showServerFrame()

Show the Server frame.

setDatasToService

public void setDatasToService(java.util.Map<java.lang.String,org.da.protoframework.model.core.ServiceInstance<?,?>> data2Service)

Specified by:

setDatasToService in interface FunctionalUA

setClassLoader

public void setClassLoader(java.lang.ClassLoader loader)

Set the ClassLoader used for loading the UA.

Specified by:

setClassLoader in interface FunctionalUA

Parameters:

loader - the ClassLoader

getClassLoader

public java.lang.ClassLoader getClassLoader()

Return the ClassLoader used for loading the UA

Returns:

the ClassLoader

setModule

public void setModule(org.da.protoframework.model.core.Module module)

Set the Module.

Specified by:

setModule in interface FunctionalUA

Parameters:

module - the Module

setServices

public void setServices(java.util.Map<org.da.protoframework.model.namespace.NamespaceKey,org.da.protoframework.model.core.ServiceInstance<?,?>> services)

Set the Services Instances.

Specified by:

setServices in interface FunctionalUA

Parameters:

services - the Services Instances

setDefaultSubscribeService

public void setDefaultSubscribeService(org.da.protoframework.model.core.ServiceInstance<?,?> service)

Set the Service Instance.

Specified by:

setDefaultSubscribeService in interface FunctionalUA

Parameters:

service - the Service Instance

setDefaultProvideService

public void setDefaultProvideService(org.da.protoframework.model.core.ServiceInstance<?,?> service)

Set the Service Instance.

Specified by:

setDefaultProvideService in interface FunctionalUA

Parameters:

service - the Service Instance

hasChanged

public boolean hasChanged(java.lang.String uri,
                          java.lang.String serviceName,
                          java.lang.String name)

Return true if a Data has changed.

Parameters:

uri - the service namespace URI

serviceName - the Service name

name - the data name

Returns:

true if the Data has changed

hasChanged

public boolean hasChanged(java.lang.String serviceName,
                          java.lang.String name)

Return true if a Data has changed.

Parameters:

serviceName - the Service name

name - the data name

Returns:

true if the Data has changed

hasChanged

public boolean hasChanged(java.lang.String name)

Return true if a Data has changed.

Parameters:

name - the data name

Returns:

true if the Data has changed

getStateValueAsString

public java.lang.String getStateValueAsString(java.lang.String uri,
                                              java.lang.String serviceName,
                                              java.lang.String name)

Return the value of a enumeration state as a String.

Parameters:

uri - the namespace URI

serviceName - the Service name

name - the enumeration data name

Returns:

the state value as a String

getStateValueAsString

public java.lang.String getStateValueAsString(java.lang.String serviceName,
                                              java.lang.String name)

Return the value of a enumeration state as a String. If the service does not have a data with this name, it will return an empty String.

Parameters:

serviceName - the Service name

name - the enumeration data name

Returns:

the state value as a String

getStateValueAsString

public java.lang.String getStateValueAsString(java.lang.String name)

Return the value of a enumeration state as a String. If there is no service having a data of this name, or if there are more than one service having a data of this name, the method will return an empty String.

Parameters:

name - the enumeration data name

Returns:

the state value as a String

isStateValue

public boolean isStateValue(java.lang.String uri,
                            java.lang.String serviceName,
                            java.lang.String name,
                            java.lang.String stateAsString)

Return true if the value of a enumeration state as a String is equal to a specified String.

Parameters:

uri - the namespace URI

serviceName - the Service name

name - the enumeration data name

stateAsString - the requested state value as a String

Returns:

true if the value of a enumeration state as a String is equal to the specified String

isStateValue

public boolean isStateValue(java.lang.String serviceName,
                            java.lang.String name,
                            java.lang.String stateAsString)

Return true if the value of a enumeration state as a String is equal to a specified String.

Parameters:

serviceName - the Service name

name - the enumeration data name

stateAsString - the requested state value as a String

Returns:

true if the value of a enumeration state as a String is equal to the specified String

isStateValue

public boolean isStateValue(java.lang.String name,
                            java.lang.String stateAsString)

Return true if the value of a enumeration state as a String is equal to a specified String.

Parameters:

name - the enumeration data name

stateAsString - the requested state value as a String

Returns:

true if the value of a enumeration state as a String is equal to the specified String

getData

public org.da.protoframework.model.core.Data<?> getData(java.lang.String name)

Return the Data of a specified name for the default subscribed Service.

Parameters:

name - the Data name

Returns:

the Data

getData

public org.da.protoframework.model.core.Data<?> getData(java.lang.String uri,
                                                        java.lang.String serviceName,
                                                        java.lang.String name)

Return the Data of a specified name for a specified Service.

Parameters:

uri - the namesdpace URI

serviceName - the Service name

name - the Data name

Returns:

the Data

getData

public org.da.protoframework.model.core.Data<?> getData(java.lang.String serviceName,
                                                        java.lang.String name)

Return the Data of a specified name for a specified Service.

Parameters:

serviceName - the Service name

name - the Data name

Returns:

the Data

getIntValue

public int getIntValue(java.lang.String uri,
                       java.lang.String serviceName,
                       java.lang.String name)

Return the value of a Data as an int. If the service does not have a data with this name, it will return 0.

Parameters:

uri - the namespace URI

serviceName - the Service name

name - the data name

Returns:

the data value as an int

getIntValue

public int getIntValue(java.lang.String serviceName,
                       java.lang.String name)

Return the value of a Data as an int. If the service does not have a data with this name, it will return 0.

Parameters:

serviceName - the Service name

name - the data name

Returns:

the data value as an int

getShortValue

public short getShortValue(java.lang.String name)

Return the value of a Data as a short. If there is no service having a data of this name, or if there are more than one service having a data of this name, the method will return 0.

Parameters:

name - the data name

Returns:

the data value as a short

getShortValue

public short getShortValue(java.lang.String uri,
                           java.lang.String serviceName,
                           java.lang.String name)

Return the value of a Data as a short. If the service does not have a data with this name, it will return 0.

Parameters:

uri - the namespace URI

serviceName - the Service name

name - the data name

Returns:

the data value as a short

getShortValue

public short getShortValue(java.lang.String serviceName,
                           java.lang.String name)

Return the value of a Data as a short. If the service does not have a data with this name, it will return 0.

Parameters:

serviceName - the Service name

name - the data name

Returns:

the data value as a short

getIntValue

public int getIntValue(java.lang.String name)

Return the value of a Data as an int. If there is no service having a data of this name, or if there are more than one service having a data of this name, the method will return 0.

Parameters:

name - the data name

Returns:

the data value as an int

getFloatValue

public float getFloatValue(java.lang.String uri,
                           java.lang.String serviceName,
                           java.lang.String name)

Return the value of a Data as a float. If the service does not have a data with this name, it will return 0.

Parameters:

uri - the namespace URI

serviceName - the Service name

name - the data name

Returns:

the data value as a float

getFloatValue

public float getFloatValue(java.lang.String serviceName,
                           java.lang.String name)

Return the value of a Data as a float. If the service does not have a data with this name, it will return 0.

Parameters:

serviceName - the Service name

name - the data name

Returns:

the data value as a float

getFloatValue

public float getFloatValue(java.lang.String uri,
                           java.lang.String serviceName,
                           java.lang.String name,
                           short unit)

Return the value of a Data as a float. If the service does not have a data with this name, it will return 0.

Parameters:

uri - the namespace URI

serviceName - the Service name

name - the data name

unit - the unit

Returns:

the data value as a float

getFloatValue

public float getFloatValue(java.lang.String serviceName,
                           java.lang.String name,
                           short unit)

Return the value of a Data as a float. If the service does not have a data with this name, it will return 0.

Parameters:

serviceName - the Service name

name - the data name

unit - the unit

Returns:

the data value as a float

getFloatValue

public float getFloatValue(java.lang.String name)

Return the value of a Data as a float. If there is no service having a data of this name, or if there are more than one service having a data of this name, the method will return 0.

Parameters:

name - the data name

Returns:

the data value as a float

getFloatValue

public float getFloatValue(java.lang.String name,
                           short unit)

Return the value of a Data as a float. If the service does not have a data with this name, it will return 0.

Parameters:

name - the data name

unit - the unit

Returns:

the data value as a float

getBooleanValue

public boolean getBooleanValue(java.lang.String uri,
                               java.lang.String serviceName,
                               java.lang.String name)

Return the value of a Data as a boolean. If the service does not have a data with this name, it will return false.

Parameters:

uri - the namespace URI

serviceName - the Service name

name - the data name

Returns:

the data value as a boolean

getBooleanValue

public boolean getBooleanValue(java.lang.String serviceName,
                               java.lang.String name)

Return the value of a Data as a boolean. If the service does not have a data with this name, it will return false.

Parameters:

serviceName - the Service name

name - the data name

Returns:

the data value as a boolean

getBooleanValue

public boolean getBooleanValue(java.lang.String name)

Return the value of a Data as a boolean. If there is no service having a data of this name, or if there are more than one service having a data of this name, the method will return false.

Parameters:

name - the data name

Returns:

the data value as a boolean

getStringValue

public java.lang.String getStringValue(java.lang.String uri,
                                       java.lang.String serviceName,
                                       java.lang.String name)

Return the value of a Data as a String. If the service does not have a data with this name, it will return an empty String.

Parameters:

uri - the namespace URI

serviceName - the Service name

name - the data name

Returns:

the data value as a String

getStringValue

public java.lang.String getStringValue(java.lang.String serviceName,
                                       java.lang.String name)

Return the value of a Data as a String. If the service does not have a data with this name, it will return an empty String.

Parameters:

serviceName - the Service name

name - the data name

Returns:

the data value as a String

formatValueAsString

public java.lang.String formatValueAsString(java.lang.String uri,
                                            java.lang.String serviceName,
                                            java.lang.String name,
                                            java.lang.String format)

Return the value of a Data as a String. If the service does not have a data with this name, it will return an empty String. If the data is not a numeric value, it will return the data value.

Parameters:

uri - the service uri

serviceName - the Service name

name - the data name

format - the format pattern

Returns:

the data value as a String

formatValueAsString

public java.lang.String formatValueAsString(java.lang.String serviceName,
                                            java.lang.String name,
                                            java.lang.String format)

Return the value of a Data as a String. If the service does not have a data with this name, it will return an empty String. If the data is not a numeric value, it will return the data value.

Parameters:

serviceName - the Service name

name - the data name

format - the format pattern

Returns:

the data value as a String

formatValueAsString

public java.lang.String formatValueAsString(java.lang.String name,
                                            java.lang.String format)

Return the value of a Data as a String. If there is no service having a data of this name, or if there are more than one service having a data of this name, the method will return an empty String. If the data is not a numeric value, it will return the data value.

Parameters:

name - the data name

format - the format pattern

Returns:

the data value as a String

getStringValue

public java.lang.String getStringValue(java.lang.String name)

Return the value of a Data as a String. If there is no service having a data of this name, or if there are more than one service having a data of this name, the method will return an empty String.

Parameters:

name - the data name

Returns:

the data value as a String

getValue

public java.lang.Object getValue(java.lang.String name)

Return the value of a Data. If there is no service having a data of this name, or if there are more than one service having a data of this name, the method will return null.

Parameters:

name - the data name

Returns:

the data value

getValue

public java.lang.Object getValue(java.lang.String uri,
                                 java.lang.String serviceName,
                                 java.lang.String name)

Return the value of a Data.

Parameters:

uri - the namespace URI

serviceName - the service name

name - the data name

Returns:

the data value

getValue

public java.lang.Object getValue(java.lang.String serviceName,
                                 java.lang.String name)

Return the value of a Data.

Parameters:

serviceName - the service name

name - the data name

Returns:

the data value

getArrayValue

public java.util.List<java.lang.Object> getArrayValue(java.lang.String name)

Return the data value as an array. If there is no service having a data of this name, or if there are more than one service having a data of this name, the method will return an empty List.

Parameters:

name - the data name

Returns:

the value

getArrayValue

public java.util.List<java.lang.Object> getArrayValue(java.lang.String uri,
                                                      java.lang.String serviceName,
                                                      java.lang.String name)

Return the data value as an array. If the service does not have a data with this name, it will return an empty List.

Parameters:

uri - the namespace URI

serviceName - the Service name

name - the data name

Returns:

the value

getArrayValue

public java.util.List<java.lang.Object> getArrayValue(java.lang.String serviceName,
                                                      java.lang.String name)

Return the data value as an array. If the service does not have a data with this name, it will return an empty List.

Parameters:

serviceName - the Service name

name - the data name

Returns:

the value

getStructureValue

public java.util.List<java.lang.Object> getStructureValue(java.lang.String name)

Return the value of a Data as a structure. If there is no service having a data of this name, or if there are more than one service having a data of this name, the method will return an empty List.

Parameters:

name - the data name

Returns:

the data value

getStructureValue

public java.util.List<java.lang.Object> getStructureValue(java.lang.String uri,
                                                          java.lang.String serviceName,
                                                          java.lang.String name)

Return the value of a Data as a structure. If the service does not have a data with this name, it will return an empty List.

Parameters:

uri - the namespace URI

serviceName - the service name

name - the data name

Returns:

the data value

getStructureValue

public java.util.List<java.lang.Object> getStructureValue(java.lang.String serviceName,
                                                          java.lang.String name)

Return the value of a Data as a structure.

Parameters:

serviceName - the service name

name - the data name

Returns:

the data value

setAPI

public void setAPI(arinc661.client.api.StatefullAPI api)

Set the API.

Specified by:

setAPI in interface FunctionalUA

Parameters:

api - the API