org.universAAL.ontology.questionnaire
Class Questionnaire

java.lang.Object
  org.universAAL.middleware.rdf.Resource
      org.universAAL.middleware.rdf.FinalizedResource
          org.universAAL.middleware.owl.ManagedIndividual
              org.universAAL.ontology.questionnaire.Questionnaire

public class Questionnaire
extends ManagedIndividual

This class describes the concept of Questionnaire, its properties and its associated methods. A questionnaire is a composition of questions and answers, given by an examined user.

Author:

mdelafuente

Field Summary

static String	MY_URI
static String	PROP_DESCRIPTION
static String	PROP_HAS_QUESTION
static String	PROP_NAME
static String	PROP_ORDERED_QUESTIONS

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

Questionnaire()

Questionnaire(String uri)

Questionnaire(String name, String description)

Questionnaire(String name, String description, Question question)

Questionnaire(String name, String description, Question[] questions)

Questionnaire(String name, String description, Question[] questions, boolean ordered)

Method Summary

void	addQuestion(Question question) The following method sets the question associated to a questionnaire.
boolean	containsConditionalQuestion() The following method checks if the questionnaire contains ConditionalQuestions.
boolean	containsMultiChoiceQuestion() The following method checks if the questionnaire contains MultiChoiceQuestions
boolean	containsQuestionWithMedia() The following method checks if the questionnaire contains QuestionWithMedia
boolean	containsSingleChoiceQuestion() The following method checks if the questionnaire contains SingleChoiceQuestions
String	getClassURI() Get the class URI for this ManagedIndividual.
ConditionalQuestion[]	getConditionalQuestions() The following method returns all the ConditionalChoiceQuestions within a questionnaire.
String	getDescription() The following method gets the description of a questionnaire
MultiChoiceQuestion[]	getMultiChoiceQuestions() The following method returns all the MultiChoiceQuestions within a questionnaire.
String	getName() The following method gets the name of a questionnaire
int	getNumberOfTotalQuestions() The following method calculates the number of questions within a questionnaire.
int	getNumberOfXQuestion(String uri) The following method gets the number of type of question, within the questionnaire.
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.
Question[]	getQuestions() The following method gets the questions associated to a questionnaire.
QuestionWithMedia[]	getQuestionsWithImage() The following method returns all the QuestionWithMedia within a questionnaire.
SingleChoiceQuestion[]	getSingleChoiceQuestions() The following method returns all the SingleChoiceQuestions within a questionnaire.
boolean	isOrderedQuestions() The following method checks if the questions within a questionnaire are ordered.
boolean	isWellFormed() Returns true, if the state of the resource is valid, otherwise false.
String	questionnaireToString() The following method parses to String a questionnaire
void	setDescription(String qDescription) The following method sets the name of a questionnaire
void	setName(String qName) The following method sets the name of a questionnaire
void	setOrderedQuestions(boolean isOrdered) The following method sets if the questions within a questionnaire are ordered or not.
void	setQuestions(Question[] questions) The following method sets the questions associated to a questionnaire.
Question	writeAConditionalQuestion(String qWording, Object triggerAnswer, Question dependingQuestion, String answerType)
Question	writeAConditionalQuestion(String qWording, Object triggerAnswer, Question dependingQuestion, String[] answerType, ChoiceLabel[] choices, Object[] correctAnswer)
Question	writeAConditionalQuestion(String qWording, Object triggerAnswer, Question dependingQuestion, String answerType, ChoiceLabel[] choices)
Question	writeAConditionalQuestion(String qWording, Object triggerAnswer, Question dependingQuestion, String answerType, ChoiceLabel[] choices, Object correctAnswer)
Question	writeAMultiChoiceQuestion(String qWording, Object[] correctAnswer, String[] answerType, ChoiceLabel[] choices)
Question	writeAMultiChoiceQuestion(String qWording, String answerType, ChoiceLabel[] choices)
Question	writeASingleChoiceQuestion(String qWording, Object correctAnswer, String answerType, ChoiceLabel[] choices)
Question	writeASingleChoiceQuestion(String qWording, String answerType)
Question	writeASingleChoiceQuestion(String qWording, String answerType, ChoiceLabel[] choices)
Question	writeQuestionWithMedia(MediaObject image, String questionWording, String answerType)
Question	writeQuestionWithMedia(String qWording, Object[] correctAnswer, String[] answerType, ChoiceLabel[] choices, MediaObject image)
Question	writeQuestionWithMedia(String qWording, Object correctAnswer, String answerType, ChoiceLabel[] choices, MediaObject image)
Question	writeQuestionWithMedia(String qWording, String answerType, ChoiceLabel[] choices, MediaObject image)

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_DESCRIPTION

public static final String PROP_DESCRIPTION

See Also:

Constant Field Values

PROP_HAS_QUESTION

public static final String PROP_HAS_QUESTION

See Also:

Constant Field Values

PROP_ORDERED_QUESTIONS

public static final String PROP_ORDERED_QUESTIONS

See Also:

Constant Field Values

Constructor Detail

Questionnaire

public Questionnaire()

Questionnaire

public Questionnaire(String uri)

Questionnaire

public Questionnaire(String name,
                     String description,
                     Question[] questions)

Questionnaire

public Questionnaire(String name,
                     String description,
                     Question question)

Questionnaire

public Questionnaire(String name,
                     String description,
                     Question[] questions,
                     boolean ordered)

Questionnaire

public Questionnaire(String name,
                     String description)

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()

getQuestions

public Question[] getQuestions()

The following method gets the questions associated to a questionnaire. For more intuitive use, the method's name has been changed from "getHasQuestion" to "getQuestions"

Returns:

Question[] (Question)

See Also:

Questionnaire, Question

setQuestions

public void setQuestions(Question[] questions)

The following method sets the questions associated to a questionnaire. For more intuitive use, the method's name has been changed from "setHasQuestion" to "setQuestions"

Parameters:

questions - , the array of questions that composes the questionnaire

See Also:

Question

addQuestion

public void addQuestion(Question question)

The following method sets the question associated to a questionnaire.

Parameters:

question - , the array of questions that composes the questionnaire

See Also:

Question

getName

public String getName()

The following method gets the name of a questionnaire

Returns:

the questionnaire's name (String)

setName

public void setName(String qName)

The following method sets the name of a questionnaire

Parameters:

name - , the questionnaire's name (String)

getDescription

public String getDescription()

The following method gets the description of a questionnaire

Returns:

the questionnaire's name (String)

setDescription

public void setDescription(String qDescription)

The following method sets the name of a questionnaire

Parameters:

qDescription - , the questionnaire's name (String)

isOrderedQuestions

public boolean isOrderedQuestions()

The following method checks if the questions within a questionnaire are ordered.

Returns:

true if the questions are ordered

setOrderedQuestions

public void setOrderedQuestions(boolean isOrdered)

The following method sets if the questions within a questionnaire are ordered or not.

Parameters:

isOrdered - (true if the questions are ordered, false if not)

getNumberOfTotalQuestions

public int getNumberOfTotalQuestions()

The following method calculates the number of questions within a questionnaire.

Returns:

number of questions (integer)

containsConditionalQuestion

public boolean containsConditionalQuestion()

The following method checks if the questionnaire contains ConditionalQuestions.

Returns:

true if the questionnaire contains conditional questions

See Also:

ConditionalQuestion

containsMultiChoiceQuestion

public boolean containsMultiChoiceQuestion()

The following method checks if the questionnaire contains MultiChoiceQuestions

Returns:

true if the questionnaire contains multi-choice questions

See Also:

MultiChoiceQuestion

containsSingleChoiceQuestion

public boolean containsSingleChoiceQuestion()

The following method checks if the questionnaire contains SingleChoiceQuestions

Returns:

true if the questionnaire contains single-choice questions

See Also:

SingleChoiceQuestion

containsQuestionWithMedia

public boolean containsQuestionWithMedia()

The following method checks if the questionnaire contains QuestionWithMedia

Returns:

true if the questionnaire contains questions with media

See Also:

QuestionWithMedia

getConditionalQuestions

public ConditionalQuestion[] getConditionalQuestions()

The following method returns all the ConditionalChoiceQuestions within a questionnaire.

Returns:

the set of conditional-choice questions

See Also:

ConditionalChoiceQuestion

getMultiChoiceQuestions

public MultiChoiceQuestion[] getMultiChoiceQuestions()

The following method returns all the MultiChoiceQuestions within a questionnaire. Although a conditional question can be itself also a multi-choice or single-choice question, we consider them separately.

Returns:

the set of multi-choice questions

See Also:

MultiChoiceQuestion

getSingleChoiceQuestions

public SingleChoiceQuestion[] getSingleChoiceQuestions()

The following method returns all the SingleChoiceQuestions within a questionnaire. Although a conditional question can be itself also a multi-choice or single-choice question, we consider them separately.

Returns:

the set of single-choice questions

See Also:

SingleChoiceQuestion

getQuestionsWithImage

public QuestionWithMedia[] getQuestionsWithImage()

The following method returns all the QuestionWithMedia within a questionnaire. Although a question with media can be itself also a multi-choice or single-choice question, we consider them separately.

Returns:

the set of questions with media

See Also:

QuestionWithMedia

getNumberOfXQuestion

public int getNumberOfXQuestion(String uri)

The following method gets the number of type of question, within the questionnaire.

Parameters:

uri - , that indicates whether the question is MultiChoice, SingleChoice, Conditional or WithImage

Returns:

the number of that type of question within the questionnaire.

writeASingleChoiceQuestion

public Question writeASingleChoiceQuestion(String qWording,
                                           String answerType)

writeASingleChoiceQuestion

public Question writeASingleChoiceQuestion(String qWording,
                                           String answerType,
                                           ChoiceLabel[] choices)

writeASingleChoiceQuestion

public Question writeASingleChoiceQuestion(String qWording,
                                           Object correctAnswer,
                                           String answerType,
                                           ChoiceLabel[] choices)

writeAMultiChoiceQuestion

public Question writeAMultiChoiceQuestion(String qWording,
                                          String answerType,
                                          ChoiceLabel[] choices)

writeAMultiChoiceQuestion

public Question writeAMultiChoiceQuestion(String qWording,
                                          Object[] correctAnswer,
                                          String[] answerType,
                                          ChoiceLabel[] choices)

writeAConditionalQuestion

public Question writeAConditionalQuestion(String qWording,
                                          Object triggerAnswer,
                                          Question dependingQuestion,
                                          String answerType)

writeAConditionalQuestion

public Question writeAConditionalQuestion(String qWording,
                                          Object triggerAnswer,
                                          Question dependingQuestion,
                                          String answerType,
                                          ChoiceLabel[] choices)

writeAConditionalQuestion

public Question writeAConditionalQuestion(String qWording,
                                          Object triggerAnswer,
                                          Question dependingQuestion,
                                          String answerType,
                                          ChoiceLabel[] choices,
                                          Object correctAnswer)

writeAConditionalQuestion

public Question writeAConditionalQuestion(String qWording,
                                          Object triggerAnswer,
                                          Question dependingQuestion,
                                          String[] answerType,
                                          ChoiceLabel[] choices,
                                          Object[] correctAnswer)

writeQuestionWithMedia

public Question writeQuestionWithMedia(MediaObject image,
                                       String questionWording,
                                       String answerType)

writeQuestionWithMedia

public Question writeQuestionWithMedia(String qWording,
                                       String answerType,
                                       ChoiceLabel[] choices,
                                       MediaObject image)

writeQuestionWithMedia

public Question writeQuestionWithMedia(String qWording,
                                       Object correctAnswer,
                                       String answerType,
                                       ChoiceLabel[] choices,
                                       MediaObject image)

writeQuestionWithMedia

public Question writeQuestionWithMedia(String qWording,
                                       Object[] correctAnswer,
                                       String[] answerType,
                                       ChoiceLabel[] choices,
                                       MediaObject image)

questionnaireToString

public String questionnaireToString()

The following method parses to String a questionnaire

Returns:

the questionnaire as a String.

See Also:

Question