org.javarosa.form.api

Class FormEntryController

java.lang.Object

org.javarosa.form.api.FormEntryController

public class FormEntryController
extends Object

This class is used to navigate through an xform and appropriately manipulate the FormEntryModel's state.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANSWER_CONSTRAINT_VIOLATED
static int	ANSWER_OK
static int	ANSWER_REQUIRED_BUT_EMPTY
static int	EVENT_BEGINNING_OF_FORM
static int	EVENT_END_OF_FORM
static int	EVENT_GROUP
static int	EVENT_PROMPT_NEW_REPEAT
static int	EVENT_QUESTION
static int	EVENT_REPEAT
static int	EVENT_REPEAT_JUNCTURE

Constructor Summary

Constructors

Constructor and Description
FormEntryController(FormEntryModel model) Creates a new form entry controller for the model provided

Method Summary

Modifier and Type	Method and Description
void	addPostProcessor(FormEntryFinalizationProcessor formEntryFinalizationProcessor)
int	answerQuestion(FormIndex index, IAnswerData data, boolean midSurvey) Attempts to save the answer at the given FormIndex into the instance and returns one of three possible int attempt result codes: ANSWER_OK ANSWER_REQUIRED_BUT_EMPTY ANSWER_CONSTRAINT_VIOLATED
int	answerQuestion(IAnswerData data, boolean midSurvey) Attempts to save answer at the current FormIndex into the datamodel.
FormIndex	deleteRepeat() Deletes a repeated instance of a group referenced by the current FormIndex.
FormIndex	deleteRepeat(FormIndex questionIndex) Deletes a repeated instance of a group referenced by the specified FormIndex.
void	deleteRepeat(int n)
FormIndex	descendIntoNewRepeat()
FormIndex	descendIntoRepeat(int n)
void	finalizeFormEntry()
FormEntryModel	getModel()
int	jumpToIndex(FormIndex index) Jumps to a given FormIndex.
void	jumpToNewRepeatPrompt() Jump to the prompt to add a new repeat for the repeat the controller is currently in.
void	newRepeat() Creates a new repeated instance of the group referenced by the current FormIndex.
void	newRepeat(FormIndex questionIndex) Creates a new repeated instance of the group referenced by the specified FormIndex.
boolean	saveAnswer(FormIndex index, IAnswerData data, boolean midSurvey) saveAnswer attempts to save the current answer into the data model without doing any constraint checking.
boolean	saveAnswer(IAnswerData data, boolean midSurvey) saveAnswer attempts to save the current answer into the data model without doing any constraint checking.
void	setLanguage(String language) Sets the current language.
int	stepToNextEvent() Navigates forward in the form.
int	stepToPreviousEvent() Navigates backward in the form.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ANSWER_OK

public static final int ANSWER_OK

See Also:

Constant Field Values

ANSWER_REQUIRED_BUT_EMPTY

public static final int ANSWER_REQUIRED_BUT_EMPTY

See Also:

Constant Field Values

ANSWER_CONSTRAINT_VIOLATED

public static final int ANSWER_CONSTRAINT_VIOLATED

See Also:

Constant Field Values

EVENT_BEGINNING_OF_FORM

public static final int EVENT_BEGINNING_OF_FORM

See Also:

Constant Field Values

EVENT_END_OF_FORM

public static final int EVENT_END_OF_FORM

See Also:

Constant Field Values

EVENT_PROMPT_NEW_REPEAT

public static final int EVENT_PROMPT_NEW_REPEAT

See Also:

Constant Field Values

EVENT_QUESTION

public static final int EVENT_QUESTION

See Also:

Constant Field Values

EVENT_GROUP

public static final int EVENT_GROUP

See Also:

Constant Field Values

EVENT_REPEAT

public static final int EVENT_REPEAT

See Also:

Constant Field Values

EVENT_REPEAT_JUNCTURE

public static final int EVENT_REPEAT_JUNCTURE

See Also:

Constant Field Values

Constructor Detail

FormEntryController

public FormEntryController(FormEntryModel model)

Creates a new form entry controller for the model provided

Parameters:

model -

Method Detail

getModel

public FormEntryModel getModel()

answerQuestion

public int answerQuestion(IAnswerData data,
                          boolean midSurvey)

Attempts to save answer at the current FormIndex into the datamodel.

Parameters:

data -

Returns:

answerQuestion

public int answerQuestion(FormIndex index,
                          IAnswerData data,
                          boolean midSurvey)

Attempts to save the answer at the given FormIndex into the instance and returns one of three possible int attempt result codes:

• ANSWER_OK
• ANSWER_REQUIRED_BUT_EMPTY
• ANSWER_CONSTRAINT_VIOLATED

Side effects: When it returns ANSWER_OK, it mutates the TreeElement corresponding to the given FormIndex by setting its value to the given IAnswerData or by copying an itemset answer if the question is complex.

Parameters:

index - The index of the question/prompt that is being currently evaluated

data - The data to attempt to answer the question with.

Returns:

the attempt's int result code

Throws:

RuntimeException - when the question is complex and it has constraints. See inline comments.

See Also:

QuestionDef.isComplex()

saveAnswer

public boolean saveAnswer(FormIndex index,
                          IAnswerData data,
                          boolean midSurvey)

saveAnswer attempts to save the current answer into the data model without doing any constraint checking. Only use this if you know what you're doing. For normal form filling you should always use answerQuestion or answerCurrentQuestion.

Parameters:

index -

data -

Returns:

true if saved successfully, false otherwise.

saveAnswer

public boolean saveAnswer(IAnswerData data,
                          boolean midSurvey)

saveAnswer attempts to save the current answer into the data model without doing any constraint checking. Only use this if you know what you're doing. For normal form filling you should always use answerQuestion().

Parameters:

data -

Returns:

true if saved successfully, false otherwise.

stepToNextEvent

public int stepToNextEvent()

Navigates forward in the form.

Returns:

the next event that should be handled by a view.

stepToPreviousEvent

public int stepToPreviousEvent()

Navigates backward in the form.

Returns:

the next event that should be handled by a view.

finalizeFormEntry

public void finalizeFormEntry()

addPostProcessor

public void addPostProcessor(FormEntryFinalizationProcessor formEntryFinalizationProcessor)

jumpToIndex

public int jumpToIndex(FormIndex index)

Jumps to a given FormIndex.

Parameters:

index -

Returns:

EVENT for the specified Index.

descendIntoRepeat

public FormIndex descendIntoRepeat(int n)

descendIntoNewRepeat

public FormIndex descendIntoNewRepeat()

newRepeat

public void newRepeat(FormIndex questionIndex)

Creates a new repeated instance of the group referenced by the specified FormIndex.

Parameters:

questionIndex -

newRepeat

public void newRepeat()

Creates a new repeated instance of the group referenced by the current FormIndex.

deleteRepeat

public FormIndex deleteRepeat(FormIndex questionIndex)

Deletes a repeated instance of a group referenced by the specified FormIndex.

Parameters:

questionIndex -

Returns:

deleteRepeat

public FormIndex deleteRepeat()

Deletes a repeated instance of a group referenced by the current FormIndex.

Returns:

deleteRepeat

public void deleteRepeat(int n)

setLanguage

public void setLanguage(String language)

Sets the current language.

Parameters:

language -

jumpToNewRepeatPrompt

public void jumpToNewRepeatPrompt()

Jump to the prompt to add a new repeat for the repeat the controller is currently in. If the current position in the form is not in a repeat nothing will happen.