org.universAAL.ontology.location
Class Place

Package class diagram package Place
java.lang.Object
  extended by org.universAAL.middleware.rdf.Resource
      extended by org.universAAL.middleware.rdf.FinalizedResource
          extended by org.universAAL.middleware.owl.ManagedIndividual
              extended by org.universAAL.middleware.owl.ComparableIndividual
                  extended by org.universAAL.middleware.owl.supply.AbsLocation
                      extended by org.universAAL.ontology.location.Location
                          extended by org.universAAL.ontology.location.Place
All Implemented Interfaces:
Comparable
Direct Known Subclasses:
AALSpace, IndoorPlace, OutdoorPlace, Way

public class Place
extends Location

Ontological representation of a place (which is not only a location but also has some more properties. It is more concrete). Methods included in this class are the mandatory ones for representing an ontological concept in Java classes for uAAL. Usually it includes getters and setters for most of its properties.

Author:
chwirth

Field Summary
static String MY_URI
           
static String PROP_HAS_ADDRESS
           
static String PROP_HAS_SHAPE
           
static String PROP_LOCATION_OF_PHYSICAL_THING
           
 
Fields inherited from class org.universAAL.ontology.location.Location
PROP_CONTAINS, PROP_HAS_NAME, PROP_IS_ADJACENT_TO, PROP_IS_CONNECTED_TO, 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, 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
Place()
          Creates a Place object
Place(Shape shape)
          for interal use only
Place(String uri)
          Creates a Place object
Place(String uri, Shape shape)
          Creates a Place object
Place(String uri, String name)
          Creates a Place object
Place(String uri, String name, Shape shape)
          Creates a Place object
 
Method Summary
 void addContainedLocation(Place location, float x, float y, float z)
          Adds a place this place contains, originated at the given point
 void addContainedLocationRelativeToCorner(Place location, float x, float y, float z)
          Adds a place this place contains, originated at the given point.
 boolean contains(Point p)
           
 Address getAddress()
          Gets the Address value
 String getClassURI()
          Get the class URI for this ManagedIndividual.
 Location getContainingLocation()
           
 float getDistanceTo(Location other)
          This method calculates the distance between a Place object and a Location object.
 PhysicalThing getPhysicalThingofLocation()
           
 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.
 Shape getShape()
           
 Place getSmallestContaining(Point p)
          returns the smallest, contained place that contains the given point does not consider overlapping Places
 void setAddress(Address val)
          Sets the Address value
 void setContainingLocation(Place place, float x, float y, float z)
          Sets the place this place is contained in, originated at the given point
 void setPhysicalThingofLocation(PhysicalThing pt)
          this is a simple setter method of the property location_of_physical_thing of the location
 
Methods inherited from class org.universAAL.ontology.location.Location
addAdjacentLocation, addConnectedLocation, addContainedLocation, clearAdjacentLocations, clearConnectedLocations, clearContainedLocations, clearContainingLocations, compareTo, getAdjacentLocations, getConnectedLocations, getContainedLocations, getDistanceTo, getNext, getPrevious, hasConnectionTo, isAdjacentTo, ord, removeAdjacentLocation, removeConnectedLocation, removeContainedLocation, setContainingLocation, setProperty
 
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, 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

MY_URI

public static final String MY_URI
See Also:
Constant Field Values

PROP_HAS_SHAPE

public static final String PROP_HAS_SHAPE
See Also:
Constant Field Values

PROP_LOCATION_OF_PHYSICAL_THING

public static final String PROP_LOCATION_OF_PHYSICAL_THING
See Also:
Constant Field Values

PROP_HAS_ADDRESS

public static final String PROP_HAS_ADDRESS
See Also:
Constant Field Values
Constructor Detail

Place

public Place(String uri)
Creates a Place object

Parameters:
uri - the object URI

Place

public Place()
Creates a Place object


Place

public Place(String uri,
             String name)
Creates a Place object

Parameters:
uri - this value can also be a null object
name - The place name. A null object is not allowed

Place

public Place(String uri,
             String name,
             Shape shape)
Creates a Place object

Parameters:
uri - this value can also be a null object
name - The place name. A null object is not allowed
shape - the shape of the place. IS not allowed to have a OriginedMetric as local Coordinate System

Place

public Place(Shape shape)
for interal use only

Parameters:
shape -

Place

public Place(String uri,
             Shape shape)
Creates a Place object

Parameters:
uri - this value can also be a null object
shape - the shape of the place. IS not allowed to have a OriginedMetric as local Coordinate System
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 Location
Returns:
The class URI.
See Also:
ManagedIndividual.getClassURI()

getShape

public Shape getShape()

getPhysicalThingofLocation

public PhysicalThing getPhysicalThingofLocation()

setPhysicalThingofLocation

public void setPhysicalThingofLocation(PhysicalThing pt)
this is a simple setter method of the property location_of_physical_thing of the location

Parameters:
pt -

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 Location

getDistanceTo

public float getDistanceTo(Location other)
This method calculates the distance between a Place object and a Location object.

Parameters:
other - the Location object
Returns:
a float value which provides information about the distance between the Place object and the Location Object

getSmallestContaining

public Place getSmallestContaining(Point p)
returns the smallest, contained place that contains the given point does not consider overlapping Places

Parameters:
p -
Returns:
the smallest containing place or null if the point is not contained

contains

public boolean contains(Point p)

getContainingLocation

public Location getContainingLocation()
Overrides:
getContainingLocation in class Location
Returns:
The value of "is contained in" property. If the property is not present a null object is returned.

setContainingLocation

public void setContainingLocation(Place place,
                                  float x,
                                  float y,
                                  float z)
Sets the place this place is contained in, originated at the given point

Parameters:
place - must have a shape
x - the x origin of this place
y - the y origin of this place
z - the z origin of this place

addContainedLocation

public void addContainedLocation(Place location,
                                 float x,
                                 float y,
                                 float z)
Adds a place this place contains, originated at the given point

Parameters:
place - must have a shape
x - the x origin of this place
y - the y origin of this place
z - the z origin of this place

addContainedLocationRelativeToCorner

public void addContainedLocationRelativeToCorner(Place location,
                                                 float x,
                                                 float y,
                                                 float z)
Adds a place this place contains, originated at the given point. The origin is not the center of the object, but the lower, left corner

Parameters:
place - must have a box shape
x - the x origin of this place
y - the y origin of this place
z - the z origin of this place

getAddress

public Address getAddress()
Gets the Address value

Returns:
The Address value

setAddress

public void setAddress(Address val)
Sets the Address value

Parameters:
reg - The value to set


Copyright © 2014 universAAL Consortium. All Rights Reserved.