Package-level declarations
Types
An ArcGIS specific feature stored in an ArcGISFeatureTable. ArcGIS features are stored in ArcGIS specific data sources such as a GeodatabaseFeatureTable or ServiceFeatureTable. Since ArcGISFeature is a subclass of Feature, it contains a geometry that defines its location and shape, and a set of attributes that describe the real-world entity it represents.
A table of features that typically represent real-world objects created from an ArcGIS feature service or an ArcGIS geodatabase. This is the base class for the ArcGIS specific feature tables GeodatabaseFeatureTable and ServiceFeatureTable. You can create instances of these subclasses using their constructors.
A file (such as an image or document) attached to a feature in a ServiceFeatureTable or a GeodatabaseFeatureTable. Attachments allow you to associate files containing additional information with specific, relevant features. For example, a building inspector could attach a PDF of a permit to a building feature. Attachments are not stored as attributes, rather the attachment data is linked with the feature inside its ServiceFeatureTable or a GeodatabaseFeatureTable.
The coded value found in a CodedValueDomain. The coded value consists of a code and a name. For example, to represent road surfaces, a code of 1, 2, and 3 could have corresponding name values of gravel, asphalt, and concrete. The code is stored in the geodatabase and the corresponding user-friendly name is presented to the user for viewing or editing.
The description of the CodedValue to be created. Each CodedValueDescription consists of a value and a name. For example, for roads data the values 1, 2, and 3 might correspond to three types of road surface such as gravel, asphalt, and concrete. Coded value domains are typically created and assigned to your datasets using ArcGIS Pro, ArcGIS Online, or ArcGIS Enterprise.
An appropriate list of values for a Field. A coded value domain consists of a collection of coded values that are saved in the dataset. When a user is editing data, you can present the list of coded values for the fields (attributes) they edit, or validate their input values against the coded value domain before changes are saved. This ensures that the user maintains data integrity by only applying values that are in the CodedValueDomain.codedValues.
The description of the CodedValueDomain to be created. Use the CodedValueDomainDescription to create a new CodedValueDomain in a mobile geodatabase, by calling Geodatabase.createDomain. The mobile geodatabase must have been created in ArcGIS Pro or using Geodatabase.create.
An object that defines a contingency.
An object that defines a contingency constraint violation.
The different types of contingency constraint violations.
An object that indicates any domain value is allowed in a contingency.
An object that defines a coded value specified in a contingency.
An object that indicates a null value is allowed in a contingency.
An object that defines a min and max range specified in a contingency.
An object that defines possible field values for fields participating in contingent field groups.
An object that defines a contingent values definition.
An object that defines possible values for a field in the context of the contingent field groups it participates in.
The list or range of appropriate values for a particular Field. This is the base class for domains such as the CodedValueDomain and RangeDomain. Domains are important for maintaining data integrity, especially when users collect data in your app. Domains are typically created and assigned to your datasets using ArcGIS Pro, ArcGIS Online, or ArcGIS Enterprise.
The description of the domain to be created. This is the base class for domain descriptions such as CodedValueDomainDescription and RangeDomainDescription. It defines a domain name and field type to which domain values are applied.
An enumeration of available drawing tools.
The various types of edits.
The result of an attempt to apply a local edit to a service. This is a base class for edit results, such as FeatureEditResult. If an edit fails to be applied, the EditResult.completedWithErrors value will be true and you can investigate the failure using the EditResult.error.
A representation of a real-world geographic entity. Features are composed of both a geometry (point, polyline, or polygon) and attributes. The geometry represents the location and shape of the real-world entity; the attributes (key-value pairs) represent the fields and values that describe the entity. Examples of features include roads, fire hydrants, and property boundaries. Applications can access features from a feature layer or a feature collection to visualize the feature's geographic and attribute information, execute spatial queries, perform analyses, or make edits to the feature's data directly. Feature attribute values can be changed, but attribute definitions cannot be added, deleted, or modified.
A feature collection represents a lightweight collection of features that can be saved in a map or portal item. A feature collection is typically used to hold features with mixed geometry or unstructured data. The features are stored in feature collection tables, where all the features that belong to a table share the same attribute schema (fields), geometry type, and spatial reference. The feature collection groups these different feature tables together so that you can display and manage them in a single layer.
A feature collection table represents an individual feature table in a FeatureCollection. A FeatureCollectionTable consists of a feature definition (table schema) and a set of features that match that feature definition. You can obtain a FeatureCollectionTable from an existing FeatureCollection.tables collection or you can create a new FeatureCollectionTable programmatically in your app.
The result of an attempt to apply a local feature edit to a feature service. You can attempt to apply feature edits to a feature service by calling ServiceGeodatabase.applyEdits. When complete, a collection of FeatureTableEditResult objects is returned. There is one FeatureTableEditResult for each edited ServiceFeatureTable in the ServiceGeodatabase.
The result of a query, select, or populate features operation made on a feature table or layer. Operations that query, select and populate features, such as FeatureTable.queryFeatures, com.arcgismaps.mapping.layers.FeatureLayer.selectFeatures, com.arcgismaps.mapping.layers.AnnotationLayer.getSelectedFeatures, or ServiceFeatureTable.populateFromService, return their resulting features in a collection of FeatureQueryResult objects.
The feature request mode for a service feature table. It determines (1) whether features are cached locally (for quicker access by map and scene layers) and (2) whether queries are performed on the local cache or on the server.
An interface for feature sets. This interface encapsulates some common read-only operations that could be applied to various sets of features.
A feature subtype describes a subset of features in an ArcGISFeatureTable that share the same integer attribute value. Feature subtypes categorize features in a dataset based on the value of an integer attribute. A subtype can define different default values or domains for fields. For example, city streets in a feature table could be categorized into three feature subtypes: local streets, collector streets, and arterial streets. Feature subtypes can also be used with utility networks to represent asset groups.
A table of features that typically represent real-world objects such as fire hydrants, roads, and forests. This is the base class for a number of different feature tables, such as ServiceFeatureTable, FeatureCollectionTable, and GeoPackageFeatureTable.
The result of an attempt to apply feature edits to a specific layer in a feature service. You can attempt to apply feature edits to a feature service by calling ServiceGeodatabase.applyEdits. When complete, a collection of FeatureTableEditResult objects is returned. There is one FeatureTableEditResult for each edited ServiceFeatureTable in the ServiceGeodatabase. To investigate whether any feature edits failed to be applied to the feature service, examine the array of feature edits returned by FeatureTableEditResult.editResults.
A feature template defines the default attribute values for the fields of a newly created ArcGISFeature and suggests a type of drawing tool to sketch the feature's geometry. The owner of the ArcGIS feature service can define one or more feature templates when they publish the service. These are held within the "Templates" tag of the ArcGIS feature service's REST Services Directory. Each template has a name, description, suggested drawing tool, and a list of attributes with their initial values (called prototype). You can obtain the feature service's collection of feature templates from the ArcGISFeatureTable.featureTemplates. Alternatively, if you are using a FeatureType, you can obtain its templates from FeatureType.templates. Use ArcGISFeatureTable.createFeature to create a feature with the feature template.
A feature type defines the domains and feature templates that are used to create a new feature. A feature type is used to ensure that appropriate attribute values are captured when a new feature is created. A FeatureType can specify the domains for the attribute values and can provide a template that populates the feature with initial values. For example, a roads layer may contain different types of roads, such as main roads, city streets, and unpaved tracks. The owner could set up a feature type named 'main road' to ensure that new features are only populated with attribute values appropriate for a 'main road', and so on.
An object that describes a Field to be created. Creation of fields and tables is currently only supported on mobile geodatabases, either created in ArcGIS Pro or via Geodatabase.create.
An object that defines a field group.
A mobile geodatabase containing geographic data and non-spatial tables. Geodatabase is used to open and access the contents of a mobile geodatabase (.geodatabase file) that can contain geographic features, non-spatial tabular data, and data such as attachments, utility networks, field domain definitions, contingent values, and relationships between layers/tables.
An interface for geodatabase dataset. Describes common part of functionality for all geodatabase datasets. Supports types of geodatabase datasets presents in GeodatabaseDatasetType enum.
The types of geodatabase datasets.
A feature table stored in a Geodatabase. For mobile geodatabases created by ArcGIS Pro, renderer information isn't stored in the geodatabase. A default renderer is therefore used to display mobile geodatabase feature tables in a feature layer. In most cases, this default should be replaced with a custom renderer.
A GeoPackage file (.gpkg) that can contain multiple datasets of geographic features, non-spatial tabular data, and raster dataset that conform to the OGC GeoPackage format. A GeoPackage is an open, standards-based, platform-independent, portable, self-describing, compact format for transferring geospatial information. It is a platform-independent SQLite database file that contains the GeoPackage data and metadata tables. See GeoPackage Encoding Standard for more information.
A dataset in a GeoPackage containing features or non-spatial records. A GeoPackageFeatureTable supports core GeoPackage geometry types and represents them as com.arcgismaps.geometry.Point, com.arcgismaps.geometry.Multipoint, com.arcgismaps.geometry.Polyline, or com.arcgismaps.geometry.Polygon. The GeoPackage specification supports a geometry collection type (storing a variety of core geometry types in a single table). For these tables, the first geometry type found in the collection is rendered.
An object that specifies an inherited domain that specifies the valid values for a Field. An inherited domain may be part of a FeatureType. An InheritedDomain indicates that the domain for a field in the feature type is the same as the domain for the field in the ArcGISFeatureTable.
An object that represents a pending feature edit specifying its edit operation and most recent edit time.
An object that represents the LocalFeatureEdit results in ascending order based on edit time.
An OGC API - Features feature collection table. To display data from an OGC feature collection table in a com.arcgismaps.mapping.layers.FeatureLayer use the com.arcgismaps.mapping.layers.FeatureLayer.FeatureLayer constructor where the OgcFeatureCollectionTable is the parameter that is passed into the constructor. Note: The OgcFeatureCollectionTable should not be confused with FeatureCollectionTable which is used as an input to create a FeatureCollection.
Controls which attributes are included in the features returned by ServiceFeatureTable.queryFeatures or ServiceFeatureTable.queryRelatedFeatures.
Parameters to perform a query on a dataset. These parameters provide attribute, spatial, and temporal criteria that you can use to filter features. You can define attribute criteria using a standard SQL expression based on the available attribute fields, spatial criteria using a geometry and a spatial relationship (such as within, contains, intersect), or temporal filters using a single date/time, or a range. You can also control how the results are sorted and whether to return geometry.
The range of valid numbers or dates for a Field. A range domain can specify the minimum and maximum value of a number or date for a field. Data entries outside the range will not be accepted in the field. When a user is editing data, you can present the RangeDomain.minValue and RangeDomain.maxValue to guide the user, and validate their input against the range domain before changes are saved. This helps to maintain data integrity.
The description of the RangeDomain to be created. Use the RangeDomainDescription to create a new RangeDomain in a mobile geodatabase, by calling Geodatabase.createDomain. The mobile geodatabase must have been created in ArcGIS Pro or using Geodatabase.create.
Contains the features that have been returned from a related tables query. Instances of this class represents the result of related queries. 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. An array of instances are returned, one per related table containing features related to the queried feature. This class has methods that can be used to iterate over the collection of related features.
Parameters to perform a related query on an ArcGISFeatureTable. When querying related features, all participating tables must be included in the same com.arcgismaps.mapping.ArcGISMap or com.arcgismaps.mapping.ArcGISScene, as either feature layers or non-spatial tables. The query that uses these parameters will load these related tables.
The various constraint violations that may occur when relating two features.
A table of features that typically represent real-world objects created from an ArcGIS feature service. An instance of this class represents the dataset of an individual layer or table in an ArcGIS map or feature service. The map or feature service may be hosted in the cloud on ArcGIS Online, or on-premises on an ArcGIS Server. To access these services you may need to provide authentication in your application.
A container for a collection of ServiceFeatureTable connected to a feature service. A ServiceGeodatabase connects to a feature service as a whole, grouping together ServiceFeatureTable instances for related records queries, connecting to a version in a branch-versioned service, and managing edits for all tables.
A table of features that typically represents real-world objects created from a local shapefile data source. A shapefile is a vector data storage format that stores the location, shape, and attributes of geographic features with the same geometry type (such as point, line, and polygon) and the same spatial reference. A shapefile dataset consists of at least three files (.shp, .shx, .dbf), and may include many others. Each of the component files of a shapefile must be smaller than 2 GB. If the minimum required files are not present (or are larger than 2 GB), the table will fail to load. If the file permissions are read-only, features cannot be edited.
An object that represents a shapefile info. If a shapefile has an associated .xml file, shapefile info will be created and populated with metadata from the file. If an .xml file does not exist, this object will be null.
The various operators for spatially relating geometries.
Represents a type used for defining a statistic to be queried for in the table.
Represents a value within the StatisticsQueryResult iterator.
Parameters to perform a statistical query on a FeatureTable. Perform statistical analyses such as average, count, maximum, and standard deviation on a feature table by defining a StatisticType on a StatisticDefinition. Use a combination of attribute, spatial, and temporal criteria to filter the features to be analyzed. If no filters are defined, all features in the table are included in the statistical query. You can also control how to group the results.
Represents a type that contains the results of a statistics query.
An enumeration that represents the various statistics that can be calculated for values in a field in a table.
A child table that allows custom editing of features of a particular subtype. Query and edit methods are not available until this table is added to ArcGISFeatureTable.subtypeSubtables. This SubtypeSubtable.subtype must be part of the ArcGISFeatureTable.featureSubtypes.
An object that describes a GeodatabaseFeatureTable to be created. Creation of fields and tables is currently only supported on mobile geodatabases, either created in ArcGIS Pro or via Geodatabase.create.
A transportation network dataset of a map or scene stored in a mobile map or scene package. A transportation network, such as a street, pedestrian, or railroad network, models networks that typically permit travel in both directions. Map and scene authors can use ArcGIS Pro to create a mobile map or scene package that includes transportation networks. For more information, see Create a mobile map package or Author a mobile scene package.
A table of features that typically represents real-world objects from an OGC Web Feature Service (WFS) dataset. You can create WFS feature table using the URL of an OGC Web Feature Service and a specified layer name. Alternatively, you may connect to a com.arcgismaps.mapping.layers.WfsService, obtain its metadata from com.arcgismaps.mapping.layers.WfsService.serviceInfo, and discover its available layers using com.arcgismaps.mapping.layers.WfsServiceInfo.layerInfos. You can then create a WfsFeatureTable from an individual layer using WfsFeatureTable.WfsFeatureTable.