org.universAAL.middleware.service.owl
Class UserInterfaceService

java.lang.Object
  org.universAAL.middleware.rdf.Resource
      org.universAAL.middleware.rdf.FinalizedResource
          org.universAAL.middleware.owl.ManagedIndividual
              org.universAAL.middleware.service.owl.Service
                  org.universAAL.middleware.service.owl.UserInterfaceService

Direct Known Subclasses:

InitialServiceDialog

public class UserInterfaceService
extends Service

Author:

mtazari - Saied Tazari

Field Summary

static String	MY_URI
static String	OUTPUT_INSTANCE_INFO
static String	PROP_CORRELATED_SERVICE_CLASS
static String	PROP_DESCRIPTION
static String	PROP_HAS_INFO_RETRIEVAL_PROCESS
static String	PROP_HAS_VENDOR
static String	SERVICE_REQUEST_URI_PREFIX_INFO
static String	SERVICE_REQUEST_URI_PREFIX_START

Fields inherited from class org.universAAL.middleware.service.owl.Service

instanceLevelRestrictions, myProfile, numberOfValueRestrictions, OWLS_NAMESPACE_PREFIX, OWLS_SERVICE_NAMESPACE, PROP_INSTANCE_LEVEL_RESTRICTIONS, PROP_NUMBER_OF_VALUE_RESTRICTIONS, PROP_OWLS_PRESENTED_BY, PROP_OWLS_PRESENTS

Fields inherited from class org.universAAL.middleware.owl.ManagedIndividual

OWL_NAMESPACE, TYPE_OWL_INDIVIDUAL, TYPE_OWL_THING

Fields inherited from class org.universAAL.middleware.rdf.Resource

ANON_URI_PREFIX, blockAddingTypes, isXMLLiteral, ns_delim_index, PROP_RDF_FIRST, PROP_RDF_REST, PROP_RDF_TYPE, PROP_RDFS_COMMENT, PROP_RDFS_LABEL, PROP_SERIALIZATION_FULL, PROP_SERIALIZATION_OPTIONAL, PROP_SERIALIZATION_REDUCED, PROP_SERIALIZATION_UNDEFINED, PROP_uAAL_INVOLVED_HUMAN_USER, props, RDF_EMPTY_LIST, RDF_NAMESPACE, RDFS_NAMESPACE, TYPE_RDF_LIST, TYPE_RDFS_CLASS, uAAL_NAMESPACE_PREFIX, uAAL_SERVICE_NAMESPACE, uAAL_VOCABULARY_NAMESPACE, uri

Constructor Summary

protected	UserInterfaceService()
protected	UserInterfaceService(String uri)

Method Summary

static ServiceProfile	createServiceProfile(String serviceClassURI, String vendor, String description, String startServiceURI) Creates and returns an appropriate ServiceProfile for a UI service.
protected static ServiceProfile	createServiceProfile(UserInterfaceService uis, String serviceClassURI, String vendor, String description, String startServiceURI) Same method with different arguments.
int	getPropSerializationType(String propURI) Answers if the given property has to be considered when serializing this individual in a minimized way, and if not ignore-able, whether its value should be presented in its full form or can be reduced.
static String	getUIServiceDescription(String serviceClassURI, String vendor, ServiceCaller theCaller)
protected static String	getUIServiceDescription(UserInterfaceService requestedService, String serviceClassURI, String vendor, ServiceCaller theCaller) Gets the UI service description of the service.
static UserInterfaceService[]	getUIServiceInfo(String serviceClassURI, ServiceCaller theCaller)
protected static UserInterfaceService[]	getUIServiceInfo(UserInterfaceService requestedService, String serviceClassURI, ServiceCaller theCaller)
static ServiceRequest	getUIServiceRequest(String serviceClassURI, String vendor, Resource requestingUser) Gets the UI service request.
protected static ServiceRequest	getUIServiceRequest(UserInterfaceService requestedService, String serviceClassURI, String vendor, Resource requestingUser) Gets the UI service request.

Methods inherited from class org.universAAL.middleware.service.owl.Service

addFilteringInput, addFilteringType, addInputWithAddEffect, addInputWithChangeEffect, addInputWithRemoveEffect, addInstanceLevelRestriction, addOutput, addRestriction, createInput, getInstanceLevelFixedValueOnProp, getInstanceLevelRestrictionOnProp, getNumberOfValueRestrictions, getProfile, getRestrictedPropsOnInstanceLevel, getRestrictionOnPropPath, setProperty

Methods inherited from class org.universAAL.middleware.owl.ManagedIndividual

checkCompatibility, checkMembership, copy, deepCopy, getClassRestrictionsOnProperty, getClassURI, getInstance, getNonAbstractSuperClasses, getNonabstractSuperClasses, getOntClassInfo, getTypeURI, isRegisteredClassURI, isWellFormed, setPropertyPathFromOffset, toManagedIndividual

Methods inherited from class org.universAAL.middleware.rdf.FinalizedResource

addType, getLocalName, getNamespace, getProperty, getPropertyURIs, getType, getTypes, getURI, hasQualifiedName, isAnon, numberOfProperties

Methods inherited from class org.universAAL.middleware.rdf.Resource

addMultiLangProp, asList, asList, asRDFList, changeProperty, equals, generateAnonURI, getDefaultLang, getFilename, getMultiLangProp, getOrConstructLabel, getResource, getResourceComment, getResourceLabel, getStaticFieldValue, hashCode, hasProperty, isAnon, isBlockingAddingTypes, isClosedCollection, isQualifiedName, literal, representsQualifiedURI, serializesAsXMLLiteral, setPropertyPath, setPropertyPath, setResourceComment, setResourceLabel, toString, toStringRecursive, toStringRecursive, unliteral

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERVICE_REQUEST_URI_PREFIX_INFO

public static final String SERVICE_REQUEST_URI_PREFIX_INFO

See Also:

Constant Field Values

SERVICE_REQUEST_URI_PREFIX_START

public static final String SERVICE_REQUEST_URI_PREFIX_START

See Also:

Constant Field Values

OUTPUT_INSTANCE_INFO

public static final String OUTPUT_INSTANCE_INFO

See Also:

Constant Field Values

MY_URI

public static final String MY_URI

PROP_CORRELATED_SERVICE_CLASS

public static final String PROP_CORRELATED_SERVICE_CLASS

PROP_DESCRIPTION

public static final String PROP_DESCRIPTION

PROP_HAS_INFO_RETRIEVAL_PROCESS

public static final String PROP_HAS_INFO_RETRIEVAL_PROCESS

PROP_HAS_VENDOR

public static final String PROP_HAS_VENDOR

Constructor Detail

UserInterfaceService

protected UserInterfaceService()

UserInterfaceService

protected UserInterfaceService(String uri)

Parameters:

uri -

Method Detail

createServiceProfile

public static final ServiceProfile createServiceProfile(String serviceClassURI,
                                                        String vendor,
                                                        String description,
                                                        String startServiceURI)

Creates and returns an appropriate ServiceProfile for a UI service. This service is called from the main menu when the UI service is selected. Typically, the UI service that registers this ServiceProfile will then send a UI request to present the main dialog of the UI service.

Parameters:

serviceClassURI - the URI of the service class from an underlying ontology, e.g. the value of Lighting.MY_URI from the lighting example.

vendor - the URL of the partner home page that provides the UI e.g. "http://www.igd.fraunhofer.de"

description - describes what the service does, e.g. "The main screen of a lighting service component by Fraunhofer-IGD that allows human users to view and change the states of light sources found on a connected KNX bus. Special visualization techniques, such as usage of 3D scenes and moving the camera from the current viewpoint of the user all the way towards the location of a currently selected light source, lead to a unique user experience in controlling light sources."

startServiceURI - a URI identifying this service. When the UI service is called, i.e. when the method ServiceCallee.handleCall(ServiceCall) is called, the ServiceCall will have this URI as process URI and can be retrieved by calling ServiceCall.getProcessURI().

Returns:

The created service profile that can be used to register the UI service at the service bus.

createServiceProfile

protected static ServiceProfile createServiceProfile(UserInterfaceService uis,
                                                     String serviceClassURI,
                                                     String vendor,
                                                     String description,
                                                     String startServiceURI)

Same method with different arguments. This time a User Interface Service will be required to create a service profile for a UI.

Returns:

The created service profile that can be used to register the UI service at the service bus.

getUIServiceDescription

public static final String getUIServiceDescription(String serviceClassURI,
                                                   String vendor,
                                                   ServiceCaller theCaller)

Parameters:

serviceClassURI - the URI of the service class from an underlying ontology, e.g. the value of Lighting.MY_URI from the lighting example.

vendor - the URL of the partner home page that provides the UI e.g. "http://www.igd.fraunhofer.de"

theCaller - instance of ServiceCaller that will be used to issue the service request to get the information.

Returns:

The description of the service profile.

getUIServiceDescription

protected static String getUIServiceDescription(UserInterfaceService requestedService,
                                                String serviceClassURI,
                                                String vendor,
                                                ServiceCaller theCaller)

Gets the UI service description of the service.

Parameters:

requestedService -

serviceClassURI - the URI of the service class from an underlying ontology, e.g. the value of Lighting.MY_URI from the lighting example.

vendor - the URL of the partner home page that provides the UI e.g. "http://www.igd.fraunhofer.de"

theCaller - instance of ServiceCaller that will be used to issue the service request to get the information.

Returns:

The description of the service profile.

getUIServiceInfo

public static final UserInterfaceService[] getUIServiceInfo(String serviceClassURI,
                                                            ServiceCaller theCaller)

Parameters:

serviceClassURI - the URI of the service class from an underlying ontology, e.g. the value of Lighting.MY_URI from the lighting example.

theCaller -

Returns:

getUIServiceInfo

protected static UserInterfaceService[] getUIServiceInfo(UserInterfaceService requestedService,
                                                         String serviceClassURI,
                                                         ServiceCaller theCaller)

Parameters:

requestedService -

serviceClassURI - the URI of the service class from an underlying ontology, e.g. the value of Lighting.MY_URI from the lighting example.

theCaller -

Returns:

getUIServiceRequest

public static final ServiceRequest getUIServiceRequest(String serviceClassURI,
                                                       String vendor,
                                                       Resource requestingUser)

Gets the UI service request. This request is sent at the service bus to present the main dialog of the UI service.

Parameters:

serviceClassURI - the URI of the service class from an underlying ontology, e.g. the value of Lighting.MY_URI from the lighting example.

vendor - the URL of the partner home page that provides the UI e.g. "http://www.igd.fraunhofer.de"

requestingUser - the user that requested the UI service.

Returns:

the UI service request.

getUIServiceRequest

protected static ServiceRequest getUIServiceRequest(UserInterfaceService requestedService,
                                                    String serviceClassURI,
                                                    String vendor,
                                                    Resource requestingUser)

Gets the UI service request. This request is sent at the service bus to present the main dialog of the UI service.

Parameters:

serviceClassURI - the URI of the service class from an underlying ontology, e.g. the value of Lighting.MY_URI from the lighting example.

vendor - the URL of the partner home page that provides the UI e.g. "http://www.igd.fraunhofer.de"

requestingUser - the user that requested the UI service.

Returns:

the UI service request.

getPropSerializationType

public int getPropSerializationType(String propURI)

Description copied from class: ManagedIndividual

Answers if the given property has to be considered when serializing this individual in a minimized way, and if not ignore-able, whether its value should be presented in its full form or can be reduced. The return value must be one of Resource.PROP_SERIALIZATION_OPTIONAL, Resource.PROP_SERIALIZATION_REDUCED, or Resource.PROP_SERIALIZATION_FULL. It can be assumed that the given property is one of those returned by FinalizedResource.getPropertyURIs(). Decision criterion should be if the value of this property is absolutely necessary when this resource is being sent to a remote node. If the subclass rates it as unlikely that the receiver side would need this info, the answer should be PROP_SERIALIZATION_OPTIONAL in favor of lower communication traffic and higher performance even at risk of a possible additional query on the receiver side for fetching this info. With the same rationale, if a property should be included in the process of serialization, it is preferable to include it in a reduced form; in this case the return value should be PROP_SERIALIZATION_REDUCED, otherwise PROP_SERIALIZATION_FULL can be returned.

Overrides:

getPropSerializationType in class Service

See Also:

ManagedIndividual.getPropSerializationType(String)