Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.realtime

Class DynamicEntityDataSourceInfo

java.lang.Object
com.esri.arcgisruntime.realtime.DynamicEntityDataSourceInfo
public final class DynamicEntityDataSourceInfo extends Object
Metadata for a DynamicEntityDataSource.

An object of this type must be provided by classes that derive from DynamicEntityDataSource as the return value of DynamicEntityDataSource.onLoadAsync().

Since:
200.2.0

  • Property Details

  • Constructor Details

    • DynamicEntityDataSourceInfo

      public DynamicEntityDataSourceInfo(String entityIdFieldName, Iterable<Field> fields)
      Creates a new data source info.
      Parameters:
      entityIdFieldName - the name of the field containing values that uniquely identify each entity. For example, the track id field with a unique identifier for each track from track-aware data, or the object id field for discrete data.
      fields - the data source's field definitions
      Throws:
      NullPointerException - if entityIdFieldName is null
      NullPointerException - if fields is null
      Since:
      200.2.0

  • Method Details

    • descriptionProperty

      public StringProperty descriptionProperty()
      The description of the data source.

      Attempting to set the value to null will throw a NullPointerException exception.

      Returns:
      the description property
      Since:
      200.2.0
      See Also:

    • getDescription

      public String getDescription()
      Gets the value of the description property.
      Property description:
      The description of the data source.

      Attempting to set the value to null will throw a NullPointerException exception.

      Returns:
      the value of the description property
      Since:
      200.2.0
      See Also:

    • setDescription

      public void setDescription(String description)
      Sets the value of the description property.
      Property description:
      The description of the data source.

      Attempting to set the value to null will throw a NullPointerException exception.

      Parameters:
      description - the value for the description property
      Since:
      200.2.0
      See Also:

    • entityIdFieldNameProperty

      public ReadOnlyStringProperty entityIdFieldNameProperty()
      The name of the field from getFields() containing values that uniquely identify each entity. For example, the track id field with a unique identifier for each track from track-aware data, or the object id field for discrete data.

      The field name should reference a field from DynamicEntityDataSourceInfo.getFields(). The values in this field help the underlying data source to associate observations with their related dynamic entities.

      Returns:
      the entityIdFieldName property
      Since:
      200.2.0
      See Also:

    • getEntityIdFieldName

      public String getEntityIdFieldName()
      Gets the value of the entityIdFieldName property.
      Property description:
      The name of the field from getFields() containing values that uniquely identify each entity. For example, the track id field with a unique identifier for each track from track-aware data, or the object id field for discrete data.

      The field name should reference a field from DynamicEntityDataSourceInfo.getFields(). The values in this field help the underlying data source to associate observations with their related dynamic entities.

      Returns:
      the value of the entityIdFieldName property
      Since:
      200.2.0
      See Also:

    • getFields

      public List<Field> getFields()
      Gets the data source's field definitions.
      Returns:
      the data source's field definitions
      Since:
      200.2.0

    • fullExtentProperty

      public ObjectProperty<Envelope> fullExtentProperty()
      The full extent of the source data.
      Returns:
      the fullExtent property
      Since:
      200.2.0
      See Also:

    • getFullExtent

      public Envelope getFullExtent()
      Gets the value of the fullExtent property.
      Property description:
      The full extent of the source data.
      Returns:
      the value of the fullExtent property
      Since:
      200.2.0
      See Also:

    • setFullExtent

      public void setFullExtent(Envelope fullExtent)
      Sets the value of the fullExtent property.
      Property description:
      The full extent of the source data.
      Parameters:
      fullExtent - the value for the fullExtent property
      Since:
      200.2.0
      See Also:

    • spatialReferenceProperty

      public ObjectProperty<SpatialReference> spatialReferenceProperty()
      The SpatialReference of this data source.

      The default is WGS84 (4326).

      Returns:
      the spatialReference property
      Since:
      200.2.0
      See Also:

    • getSpatialReference

      public SpatialReference getSpatialReference()
      Gets the value of the spatialReference property.
      Property description:
      The SpatialReference of this data source.

      The default is WGS84 (4326).

      Returns:
      the value of the spatialReference property
      Since:
      200.2.0
      See Also:

    • setSpatialReference

      public void setSpatialReference(SpatialReference spatialReference)
      Sets the value of the spatialReference property.
      Property description:
      The SpatialReference of this data source.

      The default is WGS84 (4326).

      Parameters:
      spatialReference - the value for the spatialReference property
      Since:
      200.2.0
      See Also: