org.universAAL.middleware.ui.owl

Class Modality

java.lang.Object

org.universAAL.middleware.rdf.Resource

org.universAAL.middleware.rdf.FinalizedResource

org.universAAL.middleware.owl.ManagedIndividual

org.universAAL.middleware.ui.owl.Modality

public class Modality
extends ManagedIndividual

Defines modalities which can be: voice, gui, gesture, sms, web or mobile

Author:

mtazari, Carsten Stockloew, eandgrg

Field Summary

Fields

Modifier and Type	Field and Description
static Modality	gesture
static int	GESTURE
static Modality	gui
static int	GUI
static Modality	mobile
static int	MOBILE
static String	MY_URI
static Modality	sms
static int	SMS
static Modality	voice
static int	VOICE
static Modality	web
static int	WEB

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, NAMESPACE_PREFIX, ns_delim_index, PROP_INVOLVED_HUMAN_USER, 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, props, RDF_EMPTY_LIST, RDF_NAMESPACE, RDFS_NAMESPACE, SERVICE_NAMESPACE, TYPE_RDF_LIST, TYPE_RDFS_CLASS, uri, VOCABULARY_NAMESPACE

Method Summary

Modifier and Type	Method and Description
String	getClassURI() Get the class URI for this ManagedIndividual.
static Modality	getLevelByOrder(int order)
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 int	getSize()
boolean	isWellFormed() Returns true, if the state of the resource is valid, otherwise false.
String	name()
int	ord()
boolean	setProperty(String propURI, Object o) The default implementation that will set a property if it was not set before and the given value complies with the restrictions defined by this class of managed individuals for the given propURI.
static Modality	valueOf(String name)

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

checkCompatibility, checkMembership, copy, deepCopy, getClassRestrictionsOnProperty, getInstance, getNonAbstractSuperClasses, getNonabstractSuperClasses, getOntClassInfo, getTypeURI, isRegisteredClassURI, 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, getOrConstructLabel, getResource, getResourceComment, getResourceLabel, 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

MY_URI

public static final String MY_URI

See Also:

Constant Field Values

VOICE

public static final int VOICE

See Also:

Constant Field Values

GUI

public static final int GUI

See Also:

Constant Field Values

GESTURE

public static final int GESTURE

See Also:

Constant Field Values

SMS

public static final int SMS

See Also:

Constant Field Values

WEB

public static final int WEB

See Also:

Constant Field Values

MOBILE

public static final int MOBILE

See Also:

Constant Field Values

voice

public static final Modality voice

gui

public static final Modality gui

gesture

public static final Modality gesture

sms

public static final Modality sms

web

public static final Modality web

mobile

public static final Modality mobile

Method Detail

getLevelByOrder

public static Modality getLevelByOrder(int order)

Parameters:

order - order

Returns:

modality based on given order

valueOf

public static final Modality valueOf(String name)

Parameters:

name - name of modality

Returns:

Modality based on name

getClassURI

public String getClassURI()

Description copied from class: ManagedIndividual

Get the class URI for this ManagedIndividual. All non-abstract subclasses MUST overwrite this method!

Overrides:

getClassURI in class ManagedIndividual

Returns:

The class URI.

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.

Specified by:

getPropSerializationType in class ManagedIndividual

isWellFormed

public boolean isWellFormed()

Description copied from class: Resource

Returns true, if the state of the resource is valid, otherwise false.

Subclasses should overwrite this methods as the default implementation returns always true.

Overrides:

isWellFormed in class ManagedIndividual

name

public String name()

Returns:

name based on order defined at the time of construction

ord

public int ord()

Returns:

order defined at the time of construction

getSize

public static int getSize()

Returns:

number of defined modalities

setProperty

public boolean setProperty(String propURI,
                           Object o)

Description copied from class: ManagedIndividual

The default implementation that will set a property if it was not set before and the given value complies with the restrictions defined by this class of managed individuals for the given propURI.

Overrides:

setProperty in class ManagedIndividual

Returns:

true if the property changed as a result of the call

See Also:

ManagedIndividual.setProperty(String, Object)