Package com.esri.arcgisruntime.data

Class RelatedFeatureQueryResult

  • All Implemented Interfaces:
    FeatureSet, Iterable<Feature>
    public final class RelatedFeatureQueryResult
extends Object
implements FeatureSet
    Represents the results of a related tables query. This iterator traverses the features found by the query.

    A prerequisite for querying related features is that all the participating tables must be part of a map, as either feature layers or non-spatial tables.

    Example usage: 

     
 List<RelatedFeatureQueryResult> relatedFeatureQueryResultList = relatedFeatureQueryResultFuture.get();
 //iterate over returned RelatedFeatureQueryResults
 for(RelatedFeatureQueryResult relatedQueryResult : relatedFeatureQueryResultList){
   //iterate over Features returned
   for (Feature relatedFeature : relatedQueryResult) {
     ArcGISFeature agsFeature = (ArcGISFeature) relatedFeature;
   }
 }
    Since:
    100.1.0

    • Method Detail

      • getFields

        public List<Field> getFields()
        Description copied from interface: FeatureSet
        Gets the fields of the feature set.
        Specified by:
        getFields in interface FeatureSet
        Returns:
        the fields of the feature set

      • iterator

        public Iterator<Feature> iterator()
        Returns a new iterator over the set of features. Iterators previously returned from this method will become invalid and their methods will throw an IllegalStateException.
        Specified by:
        iterator in interface Iterable<Feature>
        Returns:
        a new iterator over the set of features in this RelatedFeatureQueryResult
        Since:
        100.1.0

      • getFeature

        public ArcGISFeature getFeature()
        Gets the feature for which related features were queried.
        Returns:
        the feature
        Since:
        100.1.0

      • getRelationshipInfo

        public RelationshipInfo getRelationshipInfo()
        Gets the relationship info for this query result.
        Returns:
        the relationship info
        Since:
        100.1.0

      • isTransferLimitExceeded

        public boolean isTransferLimitExceeded()
        Gets if the transfer limit on the service was exceeded.
        Returns:
        true if the transfer limit was exceeded, false otherwise
        Since:
        100.1.0

      • getRelatedTable

        public ArcGISFeatureTable getRelatedTable()
        Gets the related table for this query result. There can be more than one instance of the same table or layer on the map with different scale level visibility, definition expression, and so on. All such instances share the same RelationshipInfo with the table the query operation is called on. In such cases, results from all such instances are returned, and the relatedTable property is used to distinguish between them.
        Returns:
        the related table
        Since:
        100.1.0