|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.universAAL.middleware.rdf.Resource
org.universAAL.middleware.rdf.FinalizedResource
org.universAAL.middleware.ui.UIResponse
public class UIResponse
Instances of this class can be used to exchange info about user input.
Field Summary | |
---|---|
static String |
MY_URI
The Constant MY_URI. |
static String |
PROP_DIALOG_DATA
The Constant PROP_DIALOG_DATA. |
static String |
PROP_DIALOG_ID
The Constant PROP_DIALOG_ID. |
static String |
PROP_IS_DIALOG_MANAGER_RESPONSE
The Constant PROP_IS_DIALOG_MANAGER_RESPONSE. |
static String |
PROP_IS_SUBDIALOG_CALL
The Constant PROP_IS_SUBDIALOG_CALL. |
static String |
PROP_SUBMISSION_ID
The Constant PROP_SUBMISSION_ID. |
static String |
PROP_SUBMISSION_LOCATION
The Constant PROP_SUBMISSION_LOCATION. |
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 | |
---|---|
UIResponse()
This constructor is for the exclusive usage by deserializers. |
|
UIResponse(Resource user,
AbsLocation inputLocation,
Submit submit)
This constructor is used in the context of a running dialog. |
Method Summary | |
---|---|
String |
getDialogID()
Gets the dialog id. |
String |
getParentDialogURI()
Gets the parent dialog uri. |
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. |
String |
getSubmissionID()
Gets the submission id. |
AbsLocation |
getSubmissionLocation()
Gets the submission location. |
Resource |
getSubmittedData()
Gets the submitted data. |
Resource |
getUser()
Gets the User . |
Object |
getUserInput(String[] propPath)
Gets the user input. |
boolean |
isForDialogManagerCall()
Checks if is the response is for the IDialogManager. |
boolean |
isSubdialogCall()
Checks if is subdialog call. |
boolean |
isSubdialogSubmission()
Checks if is subdialog submission. |
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, copy, deepCopy, equals, generateAnonURI, getDefaultLang, getFilename, getMultiLangProp, getOrConstructLabel, getResource, getResourceComment, getResourceLabel, getStaticFieldValue, hashCode, hasProperty, isAnon, isBlockingAddingTypes, isClosedCollection, isQualifiedName, isWellFormed, literal, representsQualifiedURI, serializesAsXMLLiteral, setProperty, setPropertyPath, setPropertyPath, setPropertyPathFromOffset, setResourceComment, setResourceLabel, toString, toStringRecursive, toStringRecursive, unliteral |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String MY_URI
public static final String PROP_DIALOG_DATA
public static final String PROP_DIALOG_ID
public static final String PROP_SUBMISSION_LOCATION
public static final String PROP_IS_SUBDIALOG_CALL
public static final String PROP_SUBMISSION_ID
public static final String PROP_IS_DIALOG_MANAGER_RESPONSE
Constructor Detail |
---|
public UIResponse()
public UIResponse(Resource user, AbsLocation inputLocation, Submit submit)
user
- reference to the User
inputLocation
- location of the User
submit
- instance of a submit button that has finished the dialogMethod Detail |
---|
public String getDialogID()
public AbsLocation getSubmissionLocation()
public String getParentDialogURI()
public int getPropSerializationType(String propURI)
Resource
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
Resource.getPropertyURIs()
. 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.
Subclasses should normally overwrite this method as this default
implementation returns always PROP_SERIALIZATION_FULL
.
getPropSerializationType
in class Resource
Resource.getPropSerializationType(java.lang.String)
public String getSubmissionID()
public Resource getSubmittedData()
public Resource getUser()
User
.
User
. It is declared as Resource because the type User is defined
in the Profiling Ontology. The type is not needed for for matchmaking Either.public Object getUserInput(String[] propPath)
propPath
- array of property URIs, path of a certain expected user input
public boolean isSubdialogCall()
public boolean isSubdialogSubmission()
public boolean isForDialogManagerCall()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |