Name is shown instead of label in hierarchy view for external itemsets

[lognaturel]

Software and hardware versions

Collect v1.12.2

Problem description

Name is shown instead of label in hierarchy view for external itemsets.

Steps to reproduce the problem

Load a form with external itemsets such as cascading_select_external_itemsets.xml.txt and
itemsets.csv.txt. Select some options and go to the jump screen / hierarchy view. Notice that the value names rather than the labels are shown. For that specific form above, the first choice (state) is from internal choices so it works properly. The following cascading choices are from the external csv. Choose Texas > Cameron > This is a test to see the problem clearly.

Expected behavior

The labels should be shown in the jump screen / hierarchy view.

[codedsun]

@lognaturel how can I load the form, I am unable to reproduce the problem. Can u tell me how to do that plz

[lognaturel]

Hi @codedsun! You can start with step 3 at https://github.com/opendatakit/collect#testing-a-form-locally. In this case, you'll push the form to /sdcard/odk/forms and you'll also need to push the csv file to a media folder. What I usually do is adb shell to go into the device and then mkdir /sdcard/odk/forms/cascading_select_external_itemsets-media to create the media folder. Then you can adb push itemsets.csv /sdcard/odk/forms/cascading_select_external_itemsets-media

[codedsun]

@lognature in the hierarchy view, we are getting city as test1? is this the issue as far as I have understood, it should be showing the value?

[lognaturel]

Yes, that’s right.

[codedsun]

@lognaturel Could you guide me more on which class file corresponds to showing name from datasets :( I am unable to track

[akshay-ap]

@opendatakit-bot claim

[akshay-ap]

Initial analysis show that in org.odk.collect.android.utilities.FormEntryPromptUtils.getAnswerText() is returning name. i.e if Label is This is a test then its name test1 is returned.
This is due to FormEntryPrompt.getAnswerText()
In given cascading_select_external_itemsets.xml. form, this happens for county and city. But, works correctly for state.

[getodk-bot]

Hello @akshay-ap, you claimed this issue to work on it, but this issue and any referenced pull requests haven't been updated for 7 days. Are you still working on this issue?

If so, please update this issue by leaving a comment on this issue to let me know that you're still working on it. Otherwise, I'll automatically remove you from this issue in 3 days.

If you've decided to work on something else, simply comment @opendatakit-bot unclaim so that someone else can claim it and continue from where you left off.

Thank you for your valuable contributions to Open Data Kit!

[akshay-ap]

The issue needs a bit of understanding of javarosa library source code. I would need more time to find the cause of the problem. I am learning gradle build process to make changes in javarosa and easily test it on collect.
There has been discussion on it here :
https://opendatakit.slack.com/archives/C389J6X0W/p1516726596000326

[akshay-ap]

Flow goes like this:
To display the selected labels :
In FormHierarchyActivity
line 304 :
String answerDisplay = FormEntryPromptUtils.getAnswerText(fp, this);

In FormEntryPromptUtils
The method getAnswerText(FormEntryPrompt fep, Context context)
uses javarosa API org.javarosa.form.api.FormEntryPromt

In org.javarosa.form.api.FormEntryPromt.java
Line 176 onwards :

        if(data instanceof SelectOneData) {
            //This is Excecuted for selecting `state` (for the mentioned form cascading_select_external_itemsets.xml.txt )
            text = this.getSelectItemText((Selection)data.getValue());
        } else if(data  instanceof SelectMultiData) {
            StringBuilder b = new StringBuilder();
        List<Selection> values = (List<Selection>)data.getValue();
            for(Selection value : values) {
                b.append(this.getSelectItemText(value)).append(" ");
            }
            text = b.toString();
        } else {
            //This is Excecuted for selecting `city` and `county`
            // `data` is an instance of `StringData` class
            text = data.getDisplayText();
        }

In StringData class name is stored and getDisplayText() method returns it. This is the reason why name is displayed in hierarchy view.

Hope I am able to explain the senario.

The solution is to query the label instead of name. I am working on it to find where and how label is stored. @lognaturel Do you know how label is stored during form loading?

[getodk-bot]

Hello @akshay-ap, you have been unassigned from this issue because you have not updated this issue or any referenced pull requests for over 10 days.

You can reclaim this issue or claim any other issue by commenting @opendatakit-bot claim on that issue.

Thanks for your contributions, and hope to see you again soon!