Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.utilitynetworks

Class UtilityNearestNeighbor

java.lang.Object

com.esri.arcgisruntime.utilitynetworks.UtilityNearestNeighbor

public final class UtilityNearestNeighbor
extends Object

A filter set on UtilityTraceFilter.getNearestNeighbor() to return the next n features from the starting point.

Since:

100.8.0

Method Summary

Modifier and Type	Method	Description
static UtilityNearestNeighbor	createWithAssetTypes(UtilityNetworkAttribute costNetworkAttribute, int count, Iterable<UtilityAssetType> assetTypes)	Creates a filter object to return the next n features from the starting point with asset types.
static UtilityNearestNeighbor	createWithAssetTypesAndCategories(UtilityNetworkAttribute costNetworkAttribute, int count, Iterable<UtilityAssetType> assetTypes, Iterable<UtilityCategory> categories)	Creates a filter object to return the next n features from the starting point with asset types and categories.
static UtilityNearestNeighbor	createWithCategories(UtilityNetworkAttribute costNetworkAttribute, int count, Iterable<UtilityCategory> categories)	Creates a filter object to return the next n features from the starting point with categories.
List<UtilityAssetType>	getAssetTypes()	Gets an unmodifiable list of UtilityAssetType that are used to define features to return.
List<UtilityCategory>	getCategories()	Gets an unmodifiable list of UtilityCategory that are used to define features to return.
UtilityNetworkAttribute	getCostNetworkAttribute()	Gets the UtilityNetworkAttribute used to determine the definition of "nearest".
int	getCount()	Gets the number of nearest features to return.

Methods inherited from class java.lang.Object

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

Method Details

createWithAssetTypes

public static UtilityNearestNeighbor createWithAssetTypes(UtilityNetworkAttribute costNetworkAttribute,
 int count,
 Iterable<UtilityAssetType> assetTypes)

Creates a filter object to return the next n features from the starting point with asset types.

Parameters:

costNetworkAttribute - the UtilityNetworkAttribute used to determine the definition of "nearest"

count - the number of nearest features to return. This must be a positive number.

assetTypes - the collection of UtilityAssetType that define features to return

Returns:

a UtilityNearestNeighbor

Throws:

IllegalArgumentException - if costNetworkAttribute is null

IllegalArgumentException - if count is less than one

IllegalArgumentException - if assetTypes is null or empty

Since:

100.8.0

createWithCategories

public static UtilityNearestNeighbor createWithCategories(UtilityNetworkAttribute costNetworkAttribute,
 int count,
 Iterable<UtilityCategory> categories)

Creates a filter object to return the next n features from the starting point with categories.

Parameters:

costNetworkAttribute - the UtilityNetworkAttribute used to determine the definition of "nearest"

count - the number of nearest features to return. This must be a positive number.

categories - the collection of UtilityCategory that are used to define features to return

Returns:

a UtilityNearestNeighbor

Throws:

IllegalArgumentException - if costNetworkAttribute is null

IllegalArgumentException - if count is less than one

IllegalArgumentException - if categories is null or empty

Since:

100.8.0

createWithAssetTypesAndCategories

public static UtilityNearestNeighbor createWithAssetTypesAndCategories(UtilityNetworkAttribute costNetworkAttribute,
 int count,
 Iterable<UtilityAssetType> assetTypes,
 Iterable<UtilityCategory> categories)

Creates a filter object to return the next n features from the starting point with asset types and categories.

Parameters:

costNetworkAttribute - the UtilityNetworkAttribute used to determine the definition of "nearest"

count - the number of nearest features to return. This must be a positive number.

assetTypes - the collection of UtilityAssetType that are used to define features to return

categories - the collection of UtilityCategory that are used to define features to return

Returns:

a UtilityNearestNeighbor

Throws:

IllegalArgumentException - if costNetworkAttribute is null

IllegalArgumentException - if count is less than one

IllegalArgumentException - if assetTypes is null

IllegalArgumentException - if categories is null

IllegalArgumentException - if both assetTypes and categories are empty

Since:

100.8.0

getCostNetworkAttribute

public UtilityNetworkAttribute getCostNetworkAttribute()

Gets the UtilityNetworkAttribute used to determine the definition of "nearest".

Returns:

the utility network attribute

Since:

100.8.0

getCount

public int getCount()

Gets the number of nearest features to return.

Returns:

the number of nearest features

Since:

100.8.0

getAssetTypes

public List<UtilityAssetType> getAssetTypes()

Gets an unmodifiable list of UtilityAssetType that are used to define features to return. This may be an empty list if created empty with createWithAssetTypesAndCategories(UtilityNetworkAttribute, int, Iterable<UtilityAssetType>, Iterable<UtilityCategory>) or if createWithCategories(UtilityNetworkAttribute, int, Iterable<UtilityCategory>) was used to create an instance of this class.

Returns:

an unmodifiable list of UtilityAssetType that are used to define features

Since:

100.8.0

getCategories

public List<UtilityCategory> getCategories()

Gets an unmodifiable list of UtilityCategory that are used to define features to return. This may be an empty list if created empty with createWithAssetTypesAndCategories(UtilityNetworkAttribute, int, Iterable<UtilityAssetType>, Iterable<UtilityCategory>) or if createWithAssetTypes(UtilityNetworkAttribute, int, Iterable<UtilityAssetType>) was used to create an instance of this class.

Returns:

an unmodifiable list of UtilityCategory that are used to define features

Since:

100.8.0