org.universAAL.ontology.health.owl
Class Treatment

Package class diagram package Treatment
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.health.owl.Treatment
Direct Known Subclasses:
HealthyHabitsAdoption, TakeMeasurementActivity

public abstract class Treatment
extends ManagedIndividual


Field Summary
 float completenessUnit
           
static String MY_URI
           
static String PROP_COMPLETENESS
           
static String PROP_DESCRIPTION
           
static String PROP_HAS_PERFORMED_SESSION
           
static String PROP_HAS_PRIVACY
           
static String PROP_HAS_TREATMENT_PLANNING
           
static String PROP_IS_ASSOCIATED_TO_DISEASE
           
static String PROP_IS_PRESCRIBED_BY_CAREGIVER
           
static String PROP_MOTIVATIONAL_STATUS
           
static String PROP_NAME
           
static String PROP_STATUS
           
 
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
Treatment()
           
Treatment(AssistedPersonProfile assistedPerson, Caregiver caregiver, String tname, String description, XMLGregorianCalendar stDt, String diseaseURI)
           
Treatment(AssistedPersonProfile assistedPerson, Caregiver caregiver, String tname, TreatmentPlanning tp, String description, String diseaseURI)
           
Treatment(String uri)
           
Treatment(String tname, String description, String diseaseURI)
           
Treatment(String tname, String description, TreatmentPlanning tp, String diseaseURI)
           
Treatment(String tname, String description, XMLGregorianCalendar stDt, String diseaseURI)
           
 
Method Summary
 boolean addPerformedSession(PerformedSession pSession)
           
 void cancelTreatment()
          The following method changes the treatment status to "cancelled".
 void changeToActived()
          The following method changes the treatment status to "actived".
 void changeToFinished()
          The following method changes the treatment status to "finished".
 void changeToPlanned()
          The following method changes the treatment status to "planned".
 void checkStatus()
           
 void checkStatus(XMLGregorianCalendar stDate)
          This method checks if the start date of the treatment has passed or not, so as to establish the treatment status (planned or actived)
 String getAssociatedDiseaseURI()
           
 Caregiver getCaregiver()
           
 String getClassURI()
          Get the class URI for this ManagedIndividual.
 float getCompleteness()
           
 float getCompletenessUnit()
           
 String getDescription()
           
 MotivationalStatusType getMotivationalStatus()
           
 String getName()
           
 PerformedSession[] getPerformedSessions()
           
 int getPropSerializationType(String arg0)
          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.
 StatusType getStatus()
           
 TreatmentPlanning getTreatmentPlanning()
           
 void inicializateTP(XMLGregorianCalendar stDt, XMLGregorianCalendar endDt)
          The following method initializes the treatment planning
 boolean isActived()
          This method checks if the start date of the treatment has passed or not, so as to establish the treatment status (planned or actived)
 boolean isCancelled()
          The following method checks if the treatment has been cancelled
 boolean isFinished()
          The following method checks if the treatment is finished, that is if the current date is after the end date.
 boolean isPlanned()
          The following method checks if the treatment is planned, that is if the current date is after the start date.
 boolean isWellFormed()
          Returns true, if the state of the resource is valid, otherwise false.
 void setAssociatedDisease(String diseaseURI)
           
 void setCaregiver(Caregiver caregiver)
           
 void setCompleteness(float completeness)
           
 void setCompletenessUnit(float unit)
           
 void setDescription(String treatmentDescription)
           
 void setMotivationalStatus(MotivationalStatusType motStatus)
           
 void setName(String treatmentName)
           
 void setPerformedSessions(PerformedSession[] pSession)
           
 void setStatus(StatusType status)
           
 void setTreatmentPlanning(TreatmentPlanning treatmentPlanning)
           
 
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_NAME

public static final String PROP_NAME
See Also:
Constant Field Values

PROP_COMPLETENESS

public static final String PROP_COMPLETENESS
See Also:
Constant Field Values

PROP_STATUS

public static final String PROP_STATUS
See Also:
Constant Field Values

PROP_HAS_TREATMENT_PLANNING

public static final String PROP_HAS_TREATMENT_PLANNING
See Also:
Constant Field Values

PROP_IS_PRESCRIBED_BY_CAREGIVER

public static final String PROP_IS_PRESCRIBED_BY_CAREGIVER
See Also:
Constant Field Values

PROP_MOTIVATIONAL_STATUS

public static final String PROP_MOTIVATIONAL_STATUS
See Also:
Constant Field Values

PROP_HAS_PRIVACY

public static final String PROP_HAS_PRIVACY
See Also:
Constant Field Values

PROP_DESCRIPTION

public static final String PROP_DESCRIPTION
See Also:
Constant Field Values

PROP_HAS_PERFORMED_SESSION

public static final String PROP_HAS_PERFORMED_SESSION
See Also:
Constant Field Values

PROP_IS_ASSOCIATED_TO_DISEASE

public static final String PROP_IS_ASSOCIATED_TO_DISEASE
See Also:
Constant Field Values

completenessUnit

public float completenessUnit
Constructor Detail

Treatment

public Treatment()

Treatment

public Treatment(String uri)

Treatment

public Treatment(AssistedPersonProfile assistedPerson,
                 Caregiver caregiver,
                 String tname,
                 String description,
                 XMLGregorianCalendar stDt,
                 String diseaseURI)

Treatment

public Treatment(AssistedPersonProfile assistedPerson,
                 Caregiver caregiver,
                 String tname,
                 TreatmentPlanning tp,
                 String description,
                 String diseaseURI)

Treatment

public Treatment(String tname,
                 String description,
                 String diseaseURI)

Treatment

public Treatment(String tname,
                 String description,
                 XMLGregorianCalendar stDt,
                 String diseaseURI)

Treatment

public Treatment(String tname,
                 String description,
                 TreatmentPlanning tp,
                 String diseaseURI)
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 arg0)
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()

getName

public String getName()

setName

public void setName(String treatmentName)

getCompleteness

public float getCompleteness()

setCompleteness

public void setCompleteness(float completeness)

getStatus

public StatusType getStatus()

setStatus

public void setStatus(StatusType status)

getMotivationalStatus

public MotivationalStatusType getMotivationalStatus()

setMotivationalStatus

public void setMotivationalStatus(MotivationalStatusType motStatus)

getDescription

public String getDescription()

setDescription

public void setDescription(String treatmentDescription)

getTreatmentPlanning

public TreatmentPlanning getTreatmentPlanning()

setTreatmentPlanning

public void setTreatmentPlanning(TreatmentPlanning treatmentPlanning)

getCaregiver

public Caregiver getCaregiver()

setCaregiver

public void setCaregiver(Caregiver caregiver)

getAssociatedDiseaseURI

public String getAssociatedDiseaseURI()

setAssociatedDisease

public void setAssociatedDisease(String diseaseURI)

setPerformedSessions

public void setPerformedSessions(PerformedSession[] pSession)

addPerformedSession

public boolean addPerformedSession(PerformedSession pSession)

getPerformedSessions

public PerformedSession[] getPerformedSessions()

checkStatus

public void checkStatus(XMLGregorianCalendar stDate)
This method checks if the start date of the treatment has passed or not, so as to establish the treatment status (planned or actived)

Parameters:
void -

checkStatus

public void checkStatus()

isActived

public boolean isActived()
This method checks if the start date of the treatment has passed or not, so as to establish the treatment status (planned or actived)

Parameters:
void -
Returns:
void

isPlanned

public boolean isPlanned()
The following method checks if the treatment is planned, that is if the current date is after the start date.

Parameters:
void -
Returns:
isPlanned (boolean)

isCancelled

public boolean isCancelled()
The following method checks if the treatment has been cancelled

Parameters:
void -
Returns:
isCancelled (boolean)

isFinished

public boolean isFinished()
The following method checks if the treatment is finished, that is if the current date is after the end date.

Parameters:
void -
Returns:
isFinished (boolean)

cancelTreatment

public void cancelTreatment()
The following method changes the treatment status to "cancelled".

Parameters:
void -

changeToPlanned

public void changeToPlanned()
The following method changes the treatment status to "planned".

Parameters:
void -

changeToActived

public void changeToActived()
The following method changes the treatment status to "actived".

Parameters:
void -

changeToFinished

public void changeToFinished()
The following method changes the treatment status to "finished".

Parameters:
void -

inicializateTP

public void inicializateTP(XMLGregorianCalendar stDt,
                           XMLGregorianCalendar endDt)
The following method initializes the treatment planning

Parameters:
void -

setCompletenessUnit

public void setCompletenessUnit(float unit)

getCompletenessUnit

public float getCompletenessUnit()


Copyright © 2014 universAAL Consortium. All Rights Reserved.