org.universAAL.ontology.location.address
Class Address

Package class diagram package Address
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.ontology.location.address.Address
Direct Known Subclasses:
MailBox, PhysicalAddress

public class Address
extends ManagedIndividual

Ontological representation of an Address. It can be used on its own but it is recommended to use one of its subclasses. 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:
alfiva

Field Summary
static String MY_URI
           
static String PROP_HAS_CITY
           
static String PROP_HAS_CITYPLACE
           
static String PROP_HAS_CITYQUARTER
           
static String PROP_HAS_CITYREGION
           
static String PROP_HAS_COUNTRY
           
static String PROP_HAS_EXTENDEDADDRESS
           
static String PROP_HAS_POSTALCODE
           
static String PROP_HAS_REGION
           
static String PROP_HAS_STATE
           
 
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
Address()
          Creates a Address object
Address(String uri)
          Creates a Address object
 
Method Summary
 City getCity()
          Gets the City value of the Address
 CityPlace getCityPlace()
          Gets the CityPlace value of the Address
 CityQuarter getCityQuarter()
          Gets the CityQuarter value of the Address
 CityRegion getCityRegion()
          Gets the CityRegion value of the Address
 String getClassURI()
          Get the class URI for this ManagedIndividual.
 Country getCountry()
          Gets the Country value of the Address
 String getExtAddress()
          Gets the External Address value of the Address
 String getPostalCode()
          Gets the PostalCode value of the Address
 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.
 Region getRegion()
          Gets the Region value of the Address
 State getState()
          Gets the State value of the Address
 boolean isWellFormed()
          Returns true, if the state of the resource is valid, otherwise false.
 void setCity(City val)
          Sets the City value of the Address
 void setCityPlace(CityPlace val)
          Sets the CityPlace value of the Address
 void setCityQuarter(CityQuarter val)
          Sets the CityQuarter value of the Address
 void setCityRegion(CityRegion val)
          Sets the CityRegion value of the Address
 void setCountry(Country val)
          Sets the Country value of the Address
 void setExtAddress(String val)
          Sets the ExternalAddress value of the Address
 void setPostalCode(String val)
          Sets the PostalCode value of the Address
 void setRegion(Region reg)
          Sets the Region value of the Address
 void setState(State val)
          Sets the State value of the Address
 String toReadableString()
          Returns a printable summary of the Address with all its values.
 
Methods inherited from class org.universAAL.middleware.owl.ManagedIndividual
checkCompatibility, checkMembership, copy, deepCopy, getClassRestrictionsOnProperty, getInstance, getNonAbstractSuperClasses, getNonabstractSuperClasses, getOntClassInfo, getTypeURI, isRegisteredClassURI, setProperty, 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_REGION

public static final String PROP_HAS_REGION
See Also:
Constant Field Values

PROP_HAS_COUNTRY

public static final String PROP_HAS_COUNTRY
See Also:
Constant Field Values

PROP_HAS_STATE

public static final String PROP_HAS_STATE
See Also:
Constant Field Values

PROP_HAS_CITY

public static final String PROP_HAS_CITY
See Also:
Constant Field Values

PROP_HAS_CITYQUARTER

public static final String PROP_HAS_CITYQUARTER
See Also:
Constant Field Values

PROP_HAS_CITYREGION

public static final String PROP_HAS_CITYREGION
See Also:
Constant Field Values

PROP_HAS_CITYPLACE

public static final String PROP_HAS_CITYPLACE
See Also:
Constant Field Values

PROP_HAS_POSTALCODE

public static final String PROP_HAS_POSTALCODE
See Also:
Constant Field Values

PROP_HAS_EXTENDEDADDRESS

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

Address

public Address()
Creates a Address object


Address

public Address(String uri)
Creates a Address object

Parameters:
uri - the object URI
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 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
See Also:
Resource.isWellFormed()

getRegion

public Region getRegion()
Gets the Region value of the Address

Returns:
The Region value

setRegion

public void setRegion(Region reg)
Sets the Region value of the Address

Parameters:
reg - The value to set

getCountry

public Country getCountry()
Gets the Country value of the Address

Returns:
The Country value

setCountry

public void setCountry(Country val)
Sets the Country value of the Address

Parameters:
reg - The value to set

getState

public State getState()
Gets the State value of the Address

Returns:
The State value

setState

public void setState(State val)
Sets the State value of the Address

Parameters:
reg - The value to set

getCity

public City getCity()
Gets the City value of the Address

Returns:
The City value

setCity

public void setCity(City val)
Sets the City value of the Address

Parameters:
reg - The value to set

getCityQuarter

public CityQuarter getCityQuarter()
Gets the CityQuarter value of the Address

Returns:
The CityQuarter value

setCityQuarter

public void setCityQuarter(CityQuarter val)
Sets the CityQuarter value of the Address

Parameters:
reg - The value to set

getCityRegion

public CityRegion getCityRegion()
Gets the CityRegion value of the Address

Returns:
The CityRegion value

setCityRegion

public void setCityRegion(CityRegion val)
Sets the CityRegion value of the Address

Parameters:
reg - The value to set

getCityPlace

public CityPlace getCityPlace()
Gets the CityPlace value of the Address

Returns:
The CityPlace value

setCityPlace

public void setCityPlace(CityPlace val)
Sets the CityPlace value of the Address

Parameters:
reg - The value to set

getPostalCode

public String getPostalCode()
Gets the PostalCode value of the Address

Returns:
The PostalCode value

setPostalCode

public void setPostalCode(String val)
Sets the PostalCode value of the Address

Parameters:
reg - The value to set

getExtAddress

public String getExtAddress()
Gets the External Address value of the Address

Returns:
The External Address value

setExtAddress

public void setExtAddress(String val)
Sets the ExternalAddress value of the Address

Parameters:
reg - The value to set

toReadableString

public String toReadableString()
Returns a printable summary of the Address with all its values.

Returns:
A string with the Address values. May have several lines.


Copyright © 2014 universAAL Consortium. All Rights Reserved.