org.universAAL.ontology.location

Class Location

java.lang.Object

org.universAAL.middleware.rdf.Resource

org.universAAL.middleware.rdf.FinalizedResource

org.universAAL.middleware.owl.ManagedIndividual

org.universAAL.middleware.owl.ComparableIndividual

org.universAAL.middleware.owl.supply.AbsLocation

org.universAAL.ontology.location.Location

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

Place, Point

public class Location
extends AbsLocation

Ontological representation of the location of a physical thing. Methods included in this class are the mandatory ones for representing an ontological concept in Java classes for universAAL. Usually it includes getters and setters for most of its properties.

Author:

chwirth

Field Summary

Fields

Modifier and Type	Field and Description
static String	MY_URI
static String	PROP_CONTAINS
static String	PROP_HAS_NAME
static String	PROP_IS_ADJACENT_TO
static String	PROP_IS_CONNECTED_TO
static String	PROP_IS_CONTAINED_IN

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

NON_COMPARABLE_INDIVIDUALS

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

Constructor Summary

Constructors

Constructor and Description
Location() Constructor just for usage by de-serializers.
Location(String uri) Constructor just for usage by de-serializers.
Location(String uri, String name) Creates a new Location object

Method Summary

Modifier and Type	Method and Description
void	addAdjacentLocation(Location location) Set the "is adjacent to" attribute.
void	addConnectedLocation(Location location) Adds a value to the "is connected to" attribute.
void	addContainedLocation(Location location) Adds a value to the "contains" attribute.
void	clearAdjacentLocations() removes all adjacent locations from this location.
void	clearConnectedLocations() removes all connected locations from this location.
void	clearContainedLocations() removes all contained locations from this location.
void	clearContainingLocations() removes all containing locations from this location.
int	compareTo(Object arg0) Compare this object to the given object.
Location[]	getAdjacentLocations()
String	getClassURI() Get the class URI for this ManagedIndividual.
Location[]	getConnectedLocations()
Location[]	getContainedLocations()
Location	getContainingLocation()
float	getDistanceTo(AbsLocation other) Returns the distance (meters) between the current location and the argument location.
ComparableIndividual	getNext() Get the next value according to the total order of this comparable individual.
ComparableIndividual	getPrevious() Get the previous value according to the total order of this comparable individual.
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.
boolean	hasConnectionTo(AbsLocation arg0)
boolean	isAdjacentTo(AbsLocation arg0)
int	ord() If there is a total strict order between the class members, then it must return the "serial number" of this instance, otherwise Integer.MIN_VALUE must be returned.
void	removeAdjacentLocation(Location location) removes a location from the "is adjacent to" attribute.
void	removeConnectedLocation(Location location) removes a location from the "is connected to" attribute.
void	removeContainedLocation(Location location) removes a location from the "contains" attribute.
void	setContainingLocation(Location location) Sets the "is contained in" attribute.
boolean	setProperty(String propURI, Object value) Sets a property.

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

equal, getClassMaximum, getClassMaximum, getClassMinimum, getClassMinimum, getMaximum, getMinimum, greater, greaterEqual, less, lessEqual

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

checkCompatibility, checkMembership, copy, deepCopy, getClassRestrictionsOnProperty, 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, 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

PROP_HAS_NAME

public static final String PROP_HAS_NAME

See Also:

Constant Field Values

PROP_IS_ADJACENT_TO

public static final String PROP_IS_ADJACENT_TO

See Also:

Constant Field Values

PROP_IS_CONNECTED_TO

public static final String PROP_IS_CONNECTED_TO

See Also:

Constant Field Values

PROP_IS_CONTAINED_IN

public static final String PROP_IS_CONTAINED_IN

See Also:

Constant Field Values

PROP_CONTAINS

public static final String PROP_CONTAINS

See Also:

Constant Field Values

Constructor Detail

Location

public Location()

Constructor just for usage by de-serializers. Do not use this constructor within applications as it may lead to incomplete instances that cause exceptions.

Location

public Location(String uri)

Constructor just for usage by de-serializers. Do not use this constructor within applications as it may lead to incomplete instances that cause exceptions.

Location

public Location(String uri,
                String name)

Creates a new Location object

Parameters:

uri - The Location instance URI

name - The name of the location

Method Detail

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 AbsLocation

Returns:

The class URI.

See Also:

ManagedIndividual.getClassURI()

setProperty

public boolean setProperty(String propURI,
                           Object value)

Sets a property. Ensures that the given property is of a valid type (List or non-List).

Overrides:

setProperty in class ManagedIndividual

Returns:

true if the property changed as a result of the call

See Also:

org.universAAL.middleware.owl.ManagedIndividual#setProperty(java.lang .String, java.lang.Object)

getAdjacentLocations

public Location[] getAdjacentLocations()

Returns:

The value of "is adjacent to" property. If the property is not present a null object is returned.

addAdjacentLocation

public void addAdjacentLocation(Location location)

Set the "is adjacent to" attribute.

Parameters:

location - A null value is not admitted.

removeAdjacentLocation

public void removeAdjacentLocation(Location location)

removes a location from the "is adjacent to" attribute.

clearAdjacentLocations

public void clearAdjacentLocations()

removes all adjacent locations from this location.

getConnectedLocations

public Location[] getConnectedLocations()

Returns:

The value of "is connected to" property. If the property is not present a null object is returned.

addConnectedLocation

public void addConnectedLocation(Location location)

Adds a value to the "is connected to" attribute.

Parameters:

location - A null value is not admitted.

removeConnectedLocation

public void removeConnectedLocation(Location location)

removes a location from the "is connected to" attribute.

clearConnectedLocations

public void clearConnectedLocations()

removes all connected locations from this location.

getContainedLocations

public Location[] getContainedLocations()

Returns:

The value of "contains" property. If the property is not present a null object is returned.

addContainedLocation

public void addContainedLocation(Location location)

Adds a value to the "contains" attribute. it also sets the location.containedBy property if not set.

Parameters:

location - A null value is not admitted.

removeContainedLocation

public void removeContainedLocation(Location location)

removes a location from the "contains" attribute.

clearContainedLocations

public void clearContainedLocations()

removes all contained locations from this location.

getContainingLocation

public Location getContainingLocation()

Returns:

The value of "is contained in" property. If the property is not present a null object is returned.

setContainingLocation

public void setContainingLocation(Location location)

Sets the "is contained in" attribute.

Parameters:

location - A null value is not admitted.

clearContainingLocations

public void clearContainingLocations()

removes all containing locations from this location.

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

compareTo

public int compareTo(Object arg0)

Description copied from class: ComparableIndividual

Compare this object to the given object.

Specified by:

compareTo in interface Comparable

Specified by:

compareTo in class ComparableIndividual

Returns:

0if current location and argument location are in the same Place.
-1 if current location is in a Place contained in argument location Place.
1 if argument location is in a Place contained in current location Place.
ComparableIndividual.NON_COMPARABLE_INDIVIDUALS if two locations are not comparable.

hasConnectionTo

public boolean hasConnectionTo(AbsLocation arg0)

isAdjacentTo

public boolean isAdjacentTo(AbsLocation arg0)

getNext

public ComparableIndividual getNext()

Description copied from class: ComparableIndividual

Get the next value according to the total order of this comparable individual.

Specified by:

getNext in class ComparableIndividual

Returns:

the next value

getPrevious

public ComparableIndividual getPrevious()

Description copied from class: ComparableIndividual

Get the previous value according to the total order of this comparable individual.

Specified by:

getPrevious in class ComparableIndividual

Returns:

the previous value

ord

public int ord()

Description copied from class: ComparableIndividual

If there is a total strict order between the class members, then it must return the "serial number" of this instance, otherwise Integer.MIN_VALUE must be returned.

Specified by:

ord in class ComparableIndividual

getDistanceTo

public float getDistanceTo(AbsLocation other)

Description copied from class: AbsLocation

Returns the distance (meters) between the current location and the argument location.

Specified by:

getDistanceTo in class AbsLocation