org.javarosa.form.api.FormEntryModel

public class FormEntryModel
extends Object

The data model used during form entry. Represents the current state of the form and provides access to the objects required by the view and the controller.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`REPEAT_STRUCTURE_LINEAR`	Repeats should be a prompted linear set of questions, either with a fixed set of repetitions, or a prompt for creating a new one.
`static int`	`REPEAT_STRUCTURE_NON_LINEAR`	Repeats should be a custom juncture point with centralized "Create/Remove/Interact" hub.

Constructor Summary

Constructors
Constructor	Description
`FormEntryModel(FormDef form)`
`FormEntryModel(FormDef form, int repeatStructure)`	Creates a new entry model for the form with the appropriate repeat structure

Method Summary

Modifier and Type	Method	Description
`FormIndex`	`decrementIndex(FormIndex index)`
`FormEntryCaption[]`	`getCaptionHierarchy()`	Returns a hierarchical list of FormEntryCaption objects for the current FormIndex
`FormEntryCaption[]`	`getCaptionHierarchy(FormIndex index)`	Returns a hierarchical list of FormEntryCaption objects for the given FormIndex
`FormEntryCaption`	`getCaptionPrompt()`	When you have a non-question event, a CaptionPrompt will have all the information needed to display to the user.
`FormEntryCaption`	`getCaptionPrompt(FormIndex index)`	When you have a non-question event, a CaptionPrompt will have all the information needed to display to the user.
`int`	`getCompletedRelevantQuestionCount()`	Not yet implemented Should get the number of completed questions to this point.
`FormIndex[]`	`getCompoundIndices()`
`FormIndex[]`	`getCompoundIndices(FormIndex container)`
`int`	`getEvent()`
`int`	`getEvent(FormIndex index)`	Given a FormIndex, returns the event this FormIndex represents.
`FormDef`	`getForm()`
`FormIndex`	`getFormIndex()`
`String`	`getFormTitle()`
`String`	`getLanguage()`
`String[]`	`getLanguages()`
`int`	`getNumQuestions()`
`FormEntryPrompt`	`getQuestionPrompt()`
`FormEntryPrompt`	`getQuestionPrompt(FormIndex index)`
`int`	`getRepeatStructure()`
`int`	`getTotalRelevantQuestionCount()`	Not yet implemented Should get the total possible questions given the current path through the form.
`protected TreeElement`	`getTreeElement(FormIndex index)`
`FormIndex`	`incrementIndex(FormIndex index)`
`FormIndex`	`incrementIndex(FormIndex index, boolean descend)`
`boolean`	`isIndexCompoundContainer()`
`boolean`	`isIndexCompoundContainer(FormIndex index)`
`boolean`	`isIndexCompoundElement()`
`boolean`	`isIndexCompoundElement(FormIndex index)`
`boolean`	`isIndexReadonly()`
`boolean`	`isIndexReadonly(FormIndex index)`
`boolean`	`isIndexRelevant()`	Determine if the current FormIndex is relevant.
`boolean`	`isIndexRelevant(FormIndex index)`	Determine if the current FormIndex is relevant.
`protected void`	`setLanguage(String language)`
`void`	`setQuestionIndex(FormIndex index)`	Set the FormIndex for the current question.

Methods inherited from class java.lang.Object

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

Field Details
- REPEAT_STRUCTURE_LINEAR
  
  public static final int REPEAT_STRUCTURE_LINEAR
  
  Repeats should be a prompted linear set of questions, either with a fixed set of repetitions, or a prompt for creating a new one.
  
  See Also:
  
  Constant Field Values
- REPEAT_STRUCTURE_NON_LINEAR
  
  public static final int REPEAT_STRUCTURE_NON_LINEAR
  
  Repeats should be a custom juncture point with centralized "Create/Remove/Interact" hub.
  
  See Also:
  
  Constant Field Values
Constructor Details
- FormEntryModel
  
  public FormEntryModel(FormDef form)
- FormEntryModel
  
  public FormEntryModel(FormDef form, int repeatStructure)
  
  Creates a new entry model for the form with the appropriate repeat structure
  
  Parameters:
  
  form -
  
  repeatStructure - The structure of repeats (the repeat signals which should be sent during form entry)
  
  Throws:
  
  IllegalArgumentException - If repeatStructure is not valid
Method Details
- getEvent
  
  public int getEvent(FormIndex index)
  
  Given a FormIndex, returns the event this FormIndex represents.
  
  See Also:
  
  FormEntryController
- getTreeElement
  
  protected TreeElement getTreeElement(FormIndex index)
  
  Parameters:
  
  index -
  
  Returns:
- getEvent
  
  public int getEvent()
  
  Returns:
  
  the event for the current FormIndex
  
  See Also:
  
  FormEntryController
- getFormTitle
  
  public String getFormTitle()
  
  Returns:
  
  Form title
- getQuestionPrompt
  
  public FormEntryPrompt getQuestionPrompt(FormIndex index)
  
  Parameters:
  
  index -
  
  Returns:
  
  Returns the FormEntryPrompt for the specified FormIndex if the index represents a question.
- getQuestionPrompt
  
  public FormEntryPrompt getQuestionPrompt()
  
  Returns:
  
  Returns the FormEntryPrompt for the current FormIndex if the index represents a question.
- getCaptionPrompt
  
  public FormEntryCaption getCaptionPrompt(FormIndex index)
  
  When you have a non-question event, a CaptionPrompt will have all the information needed to display to the user.
  
  Parameters:
  
  index -
  
  Returns:
  
  Returns the FormEntryCaption for the given FormIndex if is not a question.
- getCaptionPrompt
  
  public FormEntryCaption getCaptionPrompt()
  
  When you have a non-question event, a CaptionPrompt will have all the information needed to display to the user.
  
  Returns:
  
  Returns the FormEntryCaption for the current FormIndex if is not a question.
- getLanguages
  
  public String[] getLanguages()
  
  Returns:
  
  an array of Strings of the current langauges. Null if there are none.
- getCompletedRelevantQuestionCount
  
  public int getCompletedRelevantQuestionCount()
  
  Not yet implemented Should get the number of completed questions to this point.
- getTotalRelevantQuestionCount
  
  public int getTotalRelevantQuestionCount()
  
  Not yet implemented Should get the total possible questions given the current path through the form.
- getNumQuestions
  
  public int getNumQuestions()
  
  Returns:
  
  total number of questions in the form, regardless of relevancy
- getFormIndex
  
  public FormIndex getFormIndex()
  
  Returns:
  
  Returns the current FormIndex referenced by the FormEntryModel.
- setLanguage
  
  protected void setLanguage(String language)
- getLanguage
  
  public String getLanguage()
  
  Returns:
  
  Returns the currently selected language.
- setQuestionIndex
  
  public void setQuestionIndex(FormIndex index)
  
  Set the FormIndex for the current question.
  
  Parameters:
  
  index -
- getForm
  
  public FormDef getForm()
  
  Returns:
- getCaptionHierarchy
  
  public FormEntryCaption[] getCaptionHierarchy(FormIndex index)
  
  Returns a hierarchical list of FormEntryCaption objects for the given FormIndex
  
  Parameters:
  
  index -
  
  Returns:
  
  list of FormEntryCaptions in hierarchical order
- getCaptionHierarchy
  
  public FormEntryCaption[] getCaptionHierarchy()
  
  Returns a hierarchical list of FormEntryCaption objects for the current FormIndex
  
  Returns:
  
  list of FormEntryCaptions in hierarchical order
- isIndexReadonly
  
  public boolean isIndexReadonly(FormIndex index)
  
  Parameters:
  
  index -
  
  Returns:
  
  true if the element at the specified index is read only
- isIndexReadonly
  
  public boolean isIndexReadonly()
  
  Returns:
  
  true if the element at the current index is read only
- isIndexRelevant
  
  public boolean isIndexRelevant(FormIndex index)
  
  Determine if the current FormIndex is relevant. Only relevant indexes should be returned when filling out a form.
  
  Parameters:
  
  index -
  
  Returns:
  
  true if current element at FormIndex is relevant
- isIndexRelevant
  
  public boolean isIndexRelevant()
  
  Determine if the current FormIndex is relevant. Only relevant indexes should be returned when filling out a form.
  
  Returns:
  
  true if current element at FormIndex is relevant
- isIndexCompoundContainer
  
  public boolean isIndexCompoundContainer()
- isIndexCompoundContainer
  
  public boolean isIndexCompoundContainer(FormIndex index)
- isIndexCompoundElement
  
  public boolean isIndexCompoundElement()
- isIndexCompoundElement
  
  public boolean isIndexCompoundElement(FormIndex index)
- getCompoundIndices
  
  public FormIndex[] getCompoundIndices()
- getCompoundIndices
  
  public FormIndex[] getCompoundIndices(FormIndex container)
- getRepeatStructure
  
  public int getRepeatStructure()
  
  Returns:
  
  The Current Repeat style which should be used.
- incrementIndex
  
  public FormIndex incrementIndex(FormIndex index)
- incrementIndex
  
  public FormIndex incrementIndex(FormIndex index, boolean descend)
- decrementIndex
  
  public FormIndex decrementIndex(FormIndex index)

Class FormEntryModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details