Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.realtime

Class DynamicEntityDataSourcePurgeOptions

java.lang.Object

com.esri.arcgisruntime.realtime.DynamicEntityDataSourcePurgeOptions

public final class DynamicEntityDataSourcePurgeOptions
extends Object

Purge options for a dynamic entity data source.

Data received from a DynamicEntityDataSource is cached in memory on the client and can grow quickly depending on the number of dynamic entities and frequency of updates. Use this class and the DynamicEntityDataSource.purgeOptionsProperty() property to control app storage in the local data cache.

Properties on this object affect cached observations and should not be confused with similar options in TrackDisplayProperties which are applied on the DynamicEntityLayer and affect visibility of observations on a map or scene.

By default, the maximum total number of observations stored is 100,000 with no limit to the number of observations per track and no observation age limit.

Since:

200.1.0

Property Summary

Properties

Type	Property	Description
DoubleProperty	maximumDuration	The maximum time (in seconds) an observation remains in the application.
IntegerProperty	maximumObservationsPerTrack	The maximum number of observations per track.
LongProperty	maximumObservations	The maximum number of observations cached by the application.

Method Summary

Modifier and Type	Method	Description
double	getMaximumDuration()	Gets the value of the maximumDuration property.
long	getMaximumObservations()	Gets the value of the maximumObservations property.
int	getMaximumObservationsPerTrack()	Gets the value of the maximumObservationsPerTrack property.
DoubleProperty	maximumDurationProperty()	The maximum time (in seconds) an observation remains in the application.
IntegerProperty	maximumObservationsPerTrackProperty()	The maximum number of observations per track.
LongProperty	maximumObservationsProperty()	The maximum number of observations cached by the application.
void	setMaximumDuration(double maximumDuration)	Sets the value of the maximumDuration property.
void	setMaximumObservations(long maximumObservations)	Sets the value of the maximumObservations property.
void	setMaximumObservationsPerTrack(int maximumObservationsPerTrack)	Sets the value of the maximumObservationsPerTrack property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Details

maximumDuration

public DoubleProperty maximumDurationProperty

The maximum time (in seconds) an observation remains in the application.

Observations older than the specified maximum duration are removed from the local data cache.

The default value is 0.0 seconds which means the maximum duration is disabled and duration is not used to purge observations from the local data cache. Setting maximum duration to anything else below 1.0 defaults to 1.0.

Since:

200.1.0

See Also:

• getMaximumDuration()
• setMaximumDuration(double)
• maximumDurationProperty()

maximumObservations

public LongProperty maximumObservationsProperty

The maximum number of observations cached by the application.

Use this property to limit the total number of observations cached in the local data cache without regard to the track the observations belong to.

The default value is 100,000. A value of 0 disables the maximum observations purge option.

Since:

200.1.0

See Also:

• getMaximumObservations()
• setMaximumObservations(long)
• maximumObservationsProperty()

maximumObservationsPerTrack

public IntegerProperty maximumObservationsPerTrackProperty

The maximum number of observations per track.

Use this property to limit the number of observations cached in the local data cache per unique track ID.

The default value is 0 which means the maximum observations per track purge option is disabled.

Since:

200.1.0

See Also:

• getMaximumObservationsPerTrack()
• setMaximumObservationsPerTrack(int)
• maximumObservationsPerTrackProperty()

Method Details

maximumDurationProperty

public DoubleProperty maximumDurationProperty()

The maximum time (in seconds) an observation remains in the application.

Observations older than the specified maximum duration are removed from the local data cache.

The default value is 0.0 seconds which means the maximum duration is disabled and duration is not used to purge observations from the local data cache. Setting maximum duration to anything else below 1.0 defaults to 1.0.

Returns:

the maximumDuration property

Since:

200.1.0

See Also:

• getMaximumDuration()
• setMaximumDuration(double)

getMaximumDuration

public double getMaximumDuration()

Gets the value of the maximumDuration property.

Property description:

The maximum time (in seconds) an observation remains in the application.

Observations older than the specified maximum duration are removed from the local data cache.

The default value is 0.0 seconds which means the maximum duration is disabled and duration is not used to purge observations from the local data cache. Setting maximum duration to anything else below 1.0 defaults to 1.0.

Returns:

the value of the maximumDuration property

Since:

200.1.0

See Also:

• setMaximumDuration(double)
• maximumDurationProperty()

setMaximumDuration

public void setMaximumDuration(double maximumDuration)

Sets the value of the maximumDuration property.

Property description:

The maximum time (in seconds) an observation remains in the application.

Observations older than the specified maximum duration are removed from the local data cache.

The default value is 0.0 seconds which means the maximum duration is disabled and duration is not used to purge observations from the local data cache. Setting maximum duration to anything else below 1.0 defaults to 1.0.

Parameters:

maximumDuration - the value for the maximumDuration property

Since:

200.1.0

See Also:

• getMaximumDuration()
• maximumDurationProperty()

maximumObservationsProperty

public LongProperty maximumObservationsProperty()

The maximum number of observations cached by the application.

Use this property to limit the total number of observations cached in the local data cache without regard to the track the observations belong to.

The default value is 100,000. A value of 0 disables the maximum observations purge option.

Returns:

the maximumObservations property

Since:

200.1.0

See Also:

• getMaximumObservations()
• setMaximumObservations(long)

getMaximumObservations

public long getMaximumObservations()

Gets the value of the maximumObservations property.

Property description:

The maximum number of observations cached by the application.

Use this property to limit the total number of observations cached in the local data cache without regard to the track the observations belong to.

The default value is 100,000. A value of 0 disables the maximum observations purge option.

Returns:

the value of the maximumObservations property

Since:

200.1.0

See Also:

• setMaximumObservations(long)
• maximumObservationsProperty()

setMaximumObservations

public void setMaximumObservations(long maximumObservations)

Sets the value of the maximumObservations property.

Property description:

The maximum number of observations cached by the application.

Use this property to limit the total number of observations cached in the local data cache without regard to the track the observations belong to.

The default value is 100,000. A value of 0 disables the maximum observations purge option.

Parameters:

maximumObservations - the value for the maximumObservations property

Since:

200.1.0

See Also:

• getMaximumObservations()
• maximumObservationsProperty()

maximumObservationsPerTrackProperty

public IntegerProperty maximumObservationsPerTrackProperty()

The maximum number of observations per track.

Use this property to limit the number of observations cached in the local data cache per unique track ID.

The default value is 0 which means the maximum observations per track purge option is disabled.

Returns:

the maximumObservationsPerTrack property

Since:

200.1.0

See Also:

• getMaximumObservationsPerTrack()
• setMaximumObservationsPerTrack(int)

getMaximumObservationsPerTrack

public int getMaximumObservationsPerTrack()

Gets the value of the maximumObservationsPerTrack property.

Property description:

The maximum number of observations per track.

Use this property to limit the number of observations cached in the local data cache per unique track ID.

The default value is 0 which means the maximum observations per track purge option is disabled.

Returns:

the value of the maximumObservationsPerTrack property

Since:

200.1.0

See Also:

• setMaximumObservationsPerTrack(int)
• maximumObservationsPerTrackProperty()

setMaximumObservationsPerTrack

public void setMaximumObservationsPerTrack(int maximumObservationsPerTrack)

Sets the value of the maximumObservationsPerTrack property.

Property description:

The maximum number of observations per track.

Use this property to limit the number of observations cached in the local data cache per unique track ID.

The default value is 0 which means the maximum observations per track purge option is disabled.

Parameters:

maximumObservationsPerTrack - the value for the maximumObservationsPerTrack property

Since:

200.1.0

See Also:

• getMaximumObservationsPerTrack()
• maximumObservationsPerTrackProperty()