Class GenerateLayerOption

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  GenerateLayerOption.QueryOption
      Query option determines the set of features that will be downloaded when creating a geodatabase.
    • Constructor Summary

      Constructors 
      Constructor Description
      GenerateLayerOption()
      Constructs a GenerateLayerOption with default values.
      GenerateLayerOption​(long layerId)
      Constructs a GenerateLayerOption with a given layer ID and default values.
      GenerateLayerOption​(long layerId, boolean includeRelated)
      Constructs a GenerateLayerOption with a given layer ID and the includeRelated flag which causes the generated geodatabase to include features in this layer that are related to features in other layers in the generated geodatabase.
      GenerateLayerOption​(long layerId, String whereClause)
      Constructs a GenerateLayerOption with a given layer ID and where-clause which is an attribute query used to select which features in this layer are included in the generated geodatabase.
    • Constructor Detail

      • GenerateLayerOption

        public GenerateLayerOption()
        Constructs a GenerateLayerOption with default values.
        Since:
        100.0.0
      • GenerateLayerOption

        public GenerateLayerOption​(long layerId)
        Constructs a GenerateLayerOption with a given layer ID and default values.
        Parameters:
        layerId - the ID of the layer this GenerateLayerOption relates to, this can be retrieved from ArcGISFeatureLayerInfo.getServiceLayerId()
        Since:
        100.0.0
      • GenerateLayerOption

        public GenerateLayerOption​(long layerId,
                                   boolean includeRelated)
        Constructs a GenerateLayerOption with a given layer ID and the includeRelated flag which causes the generated geodatabase to include features in this layer that are related to features in other layers in the generated geodatabase. See setIncludeRelated(boolean) for more information.
        Parameters:
        layerId - the ID of the layer this GenerateLayerOption relates to, this can be retrieved from ArcGISFeatureLayerInfo.getServiceLayerId()
        includeRelated - true to include any data from this layer that is related to data in other layers in the geodatabase. This parameters is only valid if the layer participates in any relationships, and if those related layers are also included in the geodatabase.
        Since:
        100.0.0
      • GenerateLayerOption

        public GenerateLayerOption​(long layerId,
                                   String whereClause)
        Constructs a GenerateLayerOption with a given layer ID and where-clause which is an attribute query used to select which features in this layer are included in the generated geodatabase. See setWhereClause(String) for more information.
        Parameters:
        layerId - the ID of the layer this GenerateLayerOption relates to
        whereClause - an attribute query used to select which features in this layer are included in the generated geodatabase
        Since:
        100.0.0
    • Method Detail

      • isIncludeRelated

        public boolean isIncludeRelated()
        Gets the value of the includeRelated flag. If this is true it causes the generated geodatabase to include features in this layer that are related to features in other layers in the generated geodatabase. It is applicable only if the data has relationship classes.
        Returns:
        the value of the includeRelated flag
        Since:
        100.0.0
      • setIncludeRelated

        public void setIncludeRelated​(boolean includeRelated)
        Sets the value of the includeRelated flag. Setting this true causes the generated geodatabase to include features in this layer that are related to features in other layers in the generated geodatabase.

        Setting includeRelated to true causes the geometry and where-clause properties to be ignored, and is applicable only if the data has relationship classes. The default value is false.

        Parameters:
        includeRelated - true to include features in this layer that are related to features in other layers in the generated geodatabase
        Since:
        100.0.0
      • getLayerId

        public long getLayerId()
        Gets the ID of the layer this GenerateLayerOption relates to.
        Returns:
        the layer ID, or 0 if none has been set
        Since:
        100.0.0
      • setLayerId

        public void setLayerId​(long layerId)
        Sets the ID of the layer this GenerateLayerOption relates to.
        Parameters:
        layerId - the layer ID
        Since:
        100.0.0
      • setUseGeometry

        public void setUseGeometry​(boolean useGeometry)
        Sets the value of the useGeometry flag. This specifies whether the extent set by GenerateGeodatabaseParameters.setExtent(com.esri.arcgisruntime.geometry.Geometry) is used to filter the features in this layer that are included in the generated geodatabase.

        This property is only applicable if the query option is GenerateLayerOption.QueryOption.USE_FILTER. When it is true, features intersecting the extent that's been set are candidates for taking offline. When it is false, all features are candidates. If a where-clause is also set, it further reduces the features.

        The default value is true. For non-spatial tables it must be set to false.

        Parameters:
        useGeometry - true to use the extent set in GenerateGeodatabaseParameters to filter the features in this layer that are included in the generated geodatabase
        Since:
        100.0.0
      • getWhereClause

        public String getWhereClause()
        Gets the where-clause of the layer this GenerateLayerOption relates to. The where-clause is an attribute query used to select which features in this layer are included in the generated geodatabase.
        Returns:
        the where-clause, or an empty String if none has been set
        Since:
        100.0.0
        See Also:
        setWhereClause(String)