Class DynamicEntityDataSourceInfo
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 Summary
TypePropertyDescriptionThe description of the data source.The name of the field fromgetFields()
containing values that uniquely identify each entity.The full extent of the source data.TheSpatialReference
of this data source. -
Constructor Summary
ConstructorDescriptionDynamicEntityDataSourceInfo
(String entityIdFieldName, Iterable<Field> fields) Creates a new data source info. -
Method Summary
Modifier and TypeMethodDescriptionThe description of the data source.The name of the field fromgetFields()
containing values that uniquely identify each entity.The full extent of the source data.Gets the value of thedescription
property.Gets the value of theentityIdFieldName
property.Gets the data source's field definitions.Gets the value of thefullExtent
property.Gets the value of thespatialReference
property.void
setDescription
(String description) Sets the value of thedescription
property.void
setFullExtent
(Envelope fullExtent) Sets the value of thefullExtent
property.void
setSpatialReference
(SpatialReference spatialReference) Sets the value of thespatialReference
property.TheSpatialReference
of this data source.
-
Property Details
-
description
The description of the data source.Attempting to set the value to null will throw a NullPointerException exception.
- Since:
- 200.2.0
- See Also:
-
entityIdFieldName
The name of the field fromgetFields()
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.- Since:
- 200.2.0
- See Also:
-
fullExtent
The full extent of the source data.- Since:
- 200.2.0
- See Also:
-
spatialReference
TheSpatialReference
of this data source.The default is WGS84 (4326).
- Since:
- 200.2.0
- See Also:
-
-
Constructor Details
-
DynamicEntityDataSourceInfo
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 nullNullPointerException
- if fields is null- Since:
- 200.2.0
-
-
Method Details
-
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
Gets the value of thedescription
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
Sets the value of thedescription
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 thedescription
property- Since:
- 200.2.0
- See Also:
-
entityIdFieldNameProperty
The name of the field fromgetFields()
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
Gets the value of theentityIdFieldName
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
Gets the data source's field definitions.- Returns:
- the data source's field definitions
- Since:
- 200.2.0
-
fullExtentProperty
The full extent of the source data.- Returns:
- the
fullExtent
property - Since:
- 200.2.0
- See Also:
-
getFullExtent
Gets the value of thefullExtent
property.- Property description:
- The full extent of the source data.
- Returns:
- the value of the
fullExtent
property - Since:
- 200.2.0
- See Also:
-
setFullExtent
Sets the value of thefullExtent
property.- Property description:
- The full extent of the source data.
- Parameters:
fullExtent
- the value for thefullExtent
property- Since:
- 200.2.0
- See Also:
-
spatialReferenceProperty
TheSpatialReference
of this data source.The default is WGS84 (4326).
- Returns:
- the
spatialReference
property - Since:
- 200.2.0
- See Also:
-
getSpatialReference
Gets the value of thespatialReference
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
Sets the value of thespatialReference
property.- Property description:
- The
SpatialReference
of this data source.The default is WGS84 (4326).
- Parameters:
spatialReference
- the value for thespatialReference
property- Since:
- 200.2.0
- See Also:
-