topic Re: Retrieve Coded Domain Values from Query in ArcGIS API for Flex Questions

Retrieve Coded Domain Values from Query

DonCaviness — Fri, 13 Aug 2010 20:13:50 GMT

I am running a query on a dataset and the data that is being returned has coded domain values in the database. How do I get the name returned instead of the value? In other words I am getting the value of '1' but I would like returned 'School'. I can see in the REST directory that the all the info is there, I am just not sure how to display 'School' instead of '1'. Any examples or help would be greatly appreciated.

Re: Retrieve Coded Domain Values from Query

DasaPaddock — Fri, 13 Aug 2010 20:41:34 GMT

The server won't return the query results with the name instead of the value, but you can use the LayerDetails.fields and types to get to the domains and then show the name instead of the value when you're displaying the results.

Reference:
http://help.arcgis.com/en/webapi/flex/apiref/com/esri/ags/layers/supportClasses/LayerDetails.html
http://help.arcgis.com/en/webapi/flex/apiref/com/esri/ags/layers/supportClasses/Domain.html

Re: Retrieve Coded Domain Values from Query

DonCaviness — Mon, 16 Aug 2010 15:33:13 GMT

The server won't return the query results with the name instead of the value, but you can use the LayerDetails.fields and types to get to the domains and then show the name instead of the value when you're displaying the results.

Reference:
http://help.arcgis.com/en/webapi/flex/apiref/com/esri/ags/layers/supportClasses/LayerDetails.html
http://help.arcgis.com/en/webapi/flex/apiref/com/esri/ags/layers/supportClasses/Domain.html

Dasa, is there a sample or code snippet of how this works?

Re: Retrieve Coded Domain Values from Query

RobertScheitlin__GISP — Sun, 12 Dec 2021 03:34:12 GMT

Don,

I am not sure why the api team has not shared a sample for this yet, so I created one.

<?xml version="1.0" encoding="utf-8"?>
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
      xmlns:s="library://ns.adobe.com/flex/spark"
      xmlns:mx="library://ns.adobe.com/flex/mx"
      xmlns:esri="http://www.esri.com/2008/ags"
      pageTitle="Query with Domain Values Returned" currentState="test">
 <!--
 This sample shows how to query the server and displaying
 the result in a datagrid with domain values returned or not.
  
 This sample sets up a QueryTask (what layer on what server to query).
 When the user clicks the "Search" button, a Query is sent.
 The results are displayed in the DataGrid and if the option for 
 "results with domain values" is chosen than the featurelayers'
 layerDetails fields is used to retrieve the value of the domain.
 -->

 <fx:Declarations>
  <s:RadioButtonGroup id="qGroup"/>
 </fx:Declarations>
 <s:layout>
  <s:VerticalLayout gap="0" horizontalAlign="center"/>
 </s:layout>

 <fx:Script>
  <![CDATA[
   import com.esri.ags.FeatureSet;
   import com.esri.ags.Graphic;
   import com.esri.ags.layers.supportClasses.CodedValue;
   import com.esri.ags.layers.supportClasses.CodedValueDomain;
   import com.esri.ags.layers.supportClasses.Domain;
   import com.esri.ags.layers.supportClasses.LayerDetails;
   import com.esri.ags.layers.supportClasses.RangeDomain;
   import com.esri.ags.tasks.QueryTask;
   import com.esri.ags.tasks.supportClasses.Query;
   
   import mx.collections.ArrayCollection;
   import mx.controls.Alert;
   import mx.rpc.AsyncResponder;
   import mx.utils.ObjectUtil;
   
   private function getDomainValue(fieldName:String,code:String):String
   {
    var returnValue:String = "";
    var fld:Object;
    var cVal:CodedValue;
    var cDomain:CodedValueDomain;
    for each (fld in fLayer.layerDetails.fields)
    {
     if(fld.name == fieldName){
      cDomain = fld.domain;
      if (cDomain){
       for each (cVal in cDomain.codedValues)
       {
        if(cVal.code == code)
         returnValue = cVal.name;
       }
      }
     }
    }
    return returnValue;
   }
   
   protected function doQuery():void
   {
    myMap.cursorManager.setBusyCursor();
    var queryTask:QueryTask = new QueryTask("http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/SanFrancisco/311Incidents/MapServer/0");
    queryTask.useAMF = true;
    var query:Query = new Query();
    query.where = "status > 1";
    query.outFields = ["*"];
    query.returnGeometry = true;
    query.outSpatialReference = myMap.spatialReference;
    queryTask.execute(query, new AsyncResponder(onResult, onFault));
    
    // on result
    function onResult(featureSet:FeatureSet, token:Object = null):void                
    {   
     try
     {
      var qResults:Array = [];
      for each (var myGraphic:Graphic in featureSet.features)
      {
       var qObj:Object = new Object();
       
       var obj:Object = myGraphic.attributes;
       var fld:String;
       var value:String;
       
       for (fld in obj)
       {
        try{                            
         value = obj[fld].toString();
        } catch (error: Error){
         value = "";
        }
        
        if (fld.toUpperCase().indexOf("SHAPE") < 0)
        {
         if(qGroup.selectedValue == "Results with domain values"){
          var cval:String = getDomainValue(fld,value);
          if (cval != "")
           value = cval;
         }
         qObj[fld] = value;
        }
       }
       qResults.push(qObj);
      }
      resultsGrid.dataProvider = qResults;
      myMap.cursorManager.removeBusyCursor();
     }
     catch (error:Error)
     {
      Alert.show(error.message);
     } 
    }
    
    //on fault
    function onFault(info:Object, token:Object = null) : void
    {                 
     Alert.show(info.toString());         
    }
   }
  ]]>
 </fx:Script>
 <s:controlBarLayout>
  <s:HorizontalLayout horizontalAlign="center"
       verticalAlign="middle"
       paddingBottom="7"
       paddingTop="7"/>
 </s:controlBarLayout>
 <s:controlBarContent>
  <s:RadioButton groupName="qGroup" label="Results with domain values"/>
  <s:RadioButton groupName="qGroup" label="Results with out domain values (Normal Results)" selected="true"/>
  <s:Button click="doQuery()" label="Search"/>
 </s:controlBarContent>
 <esri:Map id="myMap">
  <esri:extent>
   <esri:Extent xmin="-14181000" ymin="4306000" xmax="-12917000" ymax="4767000">
    <esri:SpatialReference wkid="102100"/>
   </esri:Extent>
  </esri:extent>
  <esri:ArcGISTiledMapServiceLayer url="http://server.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer"/>
  <esri:FeatureLayer id="fLayer" mode="onDemand" outFields="*" url="http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/SanFrancisco/311Incidents/MapServer/0"/>
 </esri:Map>
 <mx:DataGrid id="resultsGrid" width="100%">
  <mx:columns>
   <mx:DataGridColumn dataField="req_id" headerText="Request Id"/>
   <mx:DataGridColumn dataField="req_type" headerText="Request Type"/>
   <mx:DataGridColumn dataField="req_date" headerText="Request Date"/>
   <mx:DataGridColumn dataField="req_time" headerText="Request Time"/>
   <mx:DataGridColumn dataField="address" headerText="Address"/>
   <mx:DataGridColumn dataField="district" headerText="District"/>
   <mx:DataGridColumn dataField="status" headerText="Status, Domain"/>
  </mx:columns>
 </mx:DataGrid>
</s:Application>

Re: Retrieve Coded Domain Values from Query

DonCaviness — Mon, 23 Aug 2010 13:06:00 GMT

Thank you Robert! That example is exactly what I was looking for.

Re: Retrieve Coded Domain Values from Query

KathleenBrenkert — Sun, 12 Dec 2021 03:34:15 GMT

I'm trying to use a modified version of this code to populate a dropdownlist as the application initializes, but I keep getting the error message "cannot access a property or mehtod of a null object reference.' Any ideas?

private function getcodedValues(fieldName:String):ArrayCollection
   {
    var returnValues:ArrayCollection=new ArrayCollection();
    var fld:Object;
    var cVal:CodedValue;
    var cDomain:CodedValueDomain;
    for each (fld in myFeatureLayer.layerDetails.fields)
    {
     if(fld.name==fieldName)
     {
      cDomain=fld.domain;
      if (cDomain)
      {
       for each (cVal in cDomain.codedValues)
       {
        returnValues.addItem({label:cVal.name,data:cVal.code});
       }
      }
     }
    }
    return returnValues;
   }

Re: Retrieve Coded Domain Values from Query

DasaPaddock — Fri, 03 Dec 2010 19:00:25 GMT

You may be calling it too early. Is myFeatureLayer loaded? What is the line of code where the error occurs?

Re: Retrieve Coded Domain Values from Query

KathleenBrenkert — Fri, 03 Dec 2010 19:16:09 GMT

Thank you! now it works!

Re: Retrieve Coded Domain Values from Query -couldn't it be simplier

RamonaNavarrete — Thu, 03 Mar 2011 21:18:25 GMT

This seems like a common requirement, since most of our customers don't like viewing the coded value and prefer the actual value.

Are there any plans to set this up as an export option?

Just frustrated that something so simple is complicated for us non-programmer types.

thank you

Re: Retrieve Coded Domain Values from Query

RobertMyers — Sun, 12 Dec 2021 03:34:18 GMT

The code below from a post a while back worked at one point. Flex is not showing an error but the app hangs in the browser. Any idea what is wrong with the code?

Don,

I am not sure why the api team has not shared a sample for this yet, so I created one.

<?xml version="1.0" encoding="utf-8"?>
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
      xmlns:s="library://ns.adobe.com/flex/spark"
      xmlns:mx="library://ns.adobe.com/flex/mx"
      xmlns:esri="http://www.esri.com/2008/ags"
      pageTitle="Query with Domain Values Returned" currentState="test">
 <!--
 This sample shows how to query the server and displaying
 the result in a datagrid with domain values returned or not.
  
 This sample sets up a QueryTask (what layer on what server to query).
 When the user clicks the "Search" button, a Query is sent.
 The results are displayed in the DataGrid and if the option for 
 "results with domain values" is chosen than the featurelayers'
 layerDetails fields is used to retrieve the value of the domain.
 -->

 <fx:Declarations>
  <s:RadioButtonGroup id="qGroup"/>
 </fx:Declarations>
 <s:layout>
  <s:VerticalLayout gap="0" horizontalAlign="center"/>
 </s:layout>

 <fx:Script>
  <![CDATA[
   import com.esri.ags.FeatureSet;
   import com.esri.ags.Graphic;
   import com.esri.ags.layers.supportClasses.CodedValue;
   import com.esri.ags.layers.supportClasses.CodedValueDomain;
   import com.esri.ags.layers.supportClasses.Domain;
   import com.esri.ags.layers.supportClasses.LayerDetails;
   import com.esri.ags.layers.supportClasses.RangeDomain;
   import com.esri.ags.tasks.QueryTask;
   import com.esri.ags.tasks.supportClasses.Query;
   
   import mx.collections.ArrayCollection;
   import mx.controls.Alert;
   import mx.rpc.AsyncResponder;
   import mx.utils.ObjectUtil;
   
   private function getDomainValue(fieldName:String,code:String):String
   {
    var returnValue:String = "";
    var fld:Object;
    var cVal:CodedValue;
    var cDomain:CodedValueDomain;
    for each (fld in fLayer.layerDetails.fields)
    {
     if(fld.name == fieldName){
      cDomain = fld.domain;
      if (cDomain){
       for each (cVal in cDomain.codedValues)
       {
        if(cVal.code == code)
         returnValue = cVal.name;
       }
      }
     }
    }
    return returnValue;
   }
   
   protected function doQuery():void
   {
    myMap.cursorManager.setBusyCursor();
    var queryTask:QueryTask = new QueryTask("http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/SanFrancisco/311Incidents/MapServer/0");
    queryTask.useAMF = true;
    var query:Query = new Query();
    query.where = "status > 1";
    query.outFields = ["*"];
    query.returnGeometry = true;
    query.outSpatialReference = myMap.spatialReference;
    queryTask.execute(query, new AsyncResponder(onResult, onFault));
    
    // on result
    function onResult(featureSet:FeatureSet, token:Object = null):void                
    {   
     try
     {
      var qResults:Array = [];
      for each (var myGraphic:Graphic in featureSet.features)
      {
       var qObj:Object = new Object();
       
       var obj:Object = myGraphic.attributes;
       var fld:String;
       var value:String;
       
       for (fld in obj)
       {
        try{                            
         value = obj[fld].toString();
        } catch (error: Error){
         value = "";
        }
        
        if (fld.toUpperCase().indexOf("SHAPE") < 0)
        {
         if(qGroup.selectedValue == "Results with domain values"){
          var cval:String = getDomainValue(fld,value);
          if (cval != "")
           value = cval;
         }
         qObj[fld] = value;
        }
       }
       qResults.push(qObj);
      }
      resultsGrid.dataProvider = qResults;
      myMap.cursorManager.removeBusyCursor();
     }
     catch (error:Error)
     {
      Alert.show(error.message);
     } 
    }
    
    //on fault
    function onFault(info:Object, token:Object = null) : void
    {                 
     Alert.show(info.toString());         
    }
   }
  ]]>
 </fx:Script>
 <s:controlBarLayout>
  <s:HorizontalLayout horizontalAlign="center"
       verticalAlign="middle"
       paddingBottom="7"
       paddingTop="7"/>
 </s:controlBarLayout>
 <s:controlBarContent>
  <s:RadioButton groupName="qGroup" label="Results with domain values"/>
  <s:RadioButton groupName="qGroup" label="Results with out domain values (Normal Results)" selected="true"/>
  <s:Button click="doQuery()" label="Search"/>
 </s:controlBarContent>
 <esri:Map id="myMap">
  <esri:extent>
   <esri:Extent xmin="-14181000" ymin="4306000" xmax="-12917000" ymax="4767000">
    <esri:SpatialReference wkid="102100"/>
   </esri:Extent>
  </esri:extent>
  <esri:ArcGISTiledMapServiceLayer url="http://server.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer"/>
  <esri:FeatureLayer id="fLayer" mode="onDemand" outFields="*" url="http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/SanFrancisco/311Incidents/MapServer/0"/>
 </esri:Map>
 <mx:DataGrid id="resultsGrid" width="100%">
  <mx:columns>
   <mx:DataGridColumn dataField="req_id" headerText="Request Id"/>
   <mx:DataGridColumn dataField="req_type" headerText="Request Type"/>
   <mx:DataGridColumn dataField="req_date" headerText="Request Date"/>
   <mx:DataGridColumn dataField="req_time" headerText="Request Time"/>
   <mx:DataGridColumn dataField="address" headerText="Address"/>
   <mx:DataGridColumn dataField="district" headerText="District"/>
   <mx:DataGridColumn dataField="status" headerText="Status, Domain"/>
  </mx:columns>
 </mx:DataGrid>
</s:Application>

Re: Retrieve Coded Domain Values from Query

RobertScheitlin__GISP — Sun, 22 May 2011 19:36:03 GMT

Robert,

Just remove the

currentState="test"

from the application tag.

Re: Retrieve Coded Domain Values from Query

BrendanLee — Wed, 29 Jun 2011 17:36:40 GMT

Is there a way to do this with ArcGIS API for Flex 1.3?
I can't upgrade to 2.3 yet...so I'm hoping I can get to the domain values and not have to do a lot of coding to assign the values.

Thanks!

Re: Retrieve Coded Domain Values from Query

GreigOldford — Fri, 12 Aug 2011 13:30:47 GMT

Really useful snippet of code, thanks!

I'd like to apply this to a SearchWidget query result. I'm not sure where to begin - where would I insert the modified snippet of code? So far I've only been working with the SearchWidget XML files.

Cheers,

Re: Retrieve Coded Domain Values from Query

RobertScheitlin__GISP — Fri, 12 Aug 2011 15:00:20 GMT

Greig,

The searchWidget has had this since Flex Viewer 2.2.

Re: Retrieve Coded Domain Values from Query

DanielEisenberg — Thu, 20 Oct 2011 19:25:20 GMT

"The searchWidget has had this since Flex Viewer 2.2."

We are using the eSearch Widget and want the domain values instead of the code returned.

I see the feature works in the widget results, floatDG, and the resulting info popup on rollover.

But it doesn't work on the fixedDG, which is what we want. (See attached image) I'm thinking it is probably an easy fix, but haven't found it yet. Ideas?

Re: Retrieve Coded Domain Values from Query

RobertScheitlin__GISP — Tue, 25 Oct 2011 12:51:41 GMT

Daniel,

I do see an issue in the code and will get it fixed in the next release. In the mean time a work around is to run the query a second time and the code values appear correctly.

Re: Retrieve Coded Domain Values from Query

RobertScheitlin__GISP — Tue, 25 Oct 2011 14:40:55 GMT

Daniel,

Version 2.4.0.12 is now released and fixes this issue.

Re: Retrieve Coded Domain Values from Query

Rocky_ — Thu, 18 Oct 2018 21:03:36 GMT

Hi Robert, i saw lots of discussions on coded Domain values when doing Query tasks. But not a single is useful for me yet. I am having same question as you explain here. Can you please help me with the same for 4.9 API.

I am having 2 attributes with coded values..I want to add a drop down menu to selecting values for that specific attribute. So user can select specific value of that attribute and perform query task.

Right now am using below function..

Thank you.

let Status = new Query({
   returnGeometry: false,
   where: '1=1',
   returnDistinctValues: true,
   outFields: ['STATUS']
});
qTask1.execute(Status).then(function(results) {
      results.features.map(function(feat) {
      let opt5 = document.createElement('option');
      opt5.value = feat.attributes.STATUS;
      opt5.innerHTML = feat.attributes.STATUS;
      stadd.appendChild(opt5);
});
view.graphic.add(selectedGraphics);
});
let qSubtype = new Query({
   returnGeometry: false,
   where: '1=1',
   returnDistinctValues: true,
   outFields: ['SUBTYPE']
});
qTask72.execute(qSubtype).then(function(results) {
      results.features.map(function(feat) {
      let opt3 = document.createElement('option');
      opt3.value = feat.attributes.SUBTYPE;
      opt3.innerHTML = feat.attributes.SUBTYPE;
      subdd.appendChild(opt3);
});
view.graphic.add(selectedGraphics);
});

Re: Retrieve Coded Domain Values from Query

RobertScheitlin__GISP — Fri, 19 Oct 2018 12:41:13 GMT

RAJ,

You need to start a new thread in the JS API space as this space is about an old technology called Flex.