com.esri.arcgis.geoprocessing.tools.coveragetools
Class PointNode

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.PointNode

All Implemented Interfaces:

GPTool

public class PointNode
extends AbstractGPTool

Performs a spatial JOINITEM on the point coverage and the node coverage. It transfers the attributes from a point feature class to a node feature class. Each point feature in the point coverage is matched to the corresponding node feature in the node coverage. If any point is within the search radius of a node, the attributes are copied. The Point Node tool is contained in the Coverage Tools tool box.

Usage tips:

• If any point is within the search radius of a node, the attributes of that point are copied. If more than one point matches a node, then the nearest point is selected. If two or more points are the same distance from the node, then one is selected randomly. If two or more nodes are within the search radius of a single node, then the node nearest the point is matched.
• The coverage-ID number for each matching point is stored as the node-ID number in the NAT. If there are no matches to a node, then the node-ID is equal to the internal node number.
• If the node coverage does not have an NAT, then the NAT is first built with the command using the NODE feature type.
• Additional items from the PAT file are added to the NAT file. If an existing NAT file has additional attributes, items from the PAT will be appended after them. Item values with no matching points will be blank for character items and zero for numeric. Existing items and item values in the NAT file will be maintained.
• The point cover must have a point attribute table for this command to work.
• The node cover can be the same as the point cover, in which case, the attributes of the PAT are transferred to the NAT within the point coverage.
• If an item in the PAT exists in the NAT, the item values in the NAT are updated with values from the PAT.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

PointNode()
Creates the Point Node tool with defaults.

PointNode(Object pointCover, Object nodeCover)
Creates the Point Node tool with the required parameters.

Method Summary

Object	getNodeCover() Returns the Node Coverage parameter of this tool .
Object	getOutCover() Returns the Output Coverage parameter of this tool (Read only).
Object	getPointCover() Returns the Point Coverage parameter of this tool .
double	getSearchRadius() Returns the Search Radius parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setNodeCover(Object nodeCover) Sets the Node Coverage parameter of this tool .
void	setPointCover(Object pointCover) Sets the Point Coverage parameter of this tool .
void	setSearchRadius(double searchRadius) Sets the Search Radius parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PointNode

public PointNode()

Creates the Point Node tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

PointNode

public PointNode(Object pointCover,
                 Object nodeCover)

Creates the Point Node tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

pointCover - the coverage containing point features to be transferred.

nodeCover - an existing cover whose node attribute values will be updated or created if the NAT does not exist.

Method Detail

getPointCover

public Object getPointCover()

Returns the Point Coverage parameter of this tool . This parameter is the coverage containing point features to be transferred. This is a required parameter.

Returns:

the Point Coverage

setPointCover

public void setPointCover(Object pointCover)

Sets the Point Coverage parameter of this tool . This parameter is the coverage containing point features to be transferred. This is a required parameter.

Parameters:

pointCover - the coverage containing point features to be transferred.

getNodeCover

public Object getNodeCover()

Returns the Node Coverage parameter of this tool . This parameter is an existing cover whose node attribute values will be updated or created if the NAT does not exist. This is a required parameter.

Returns:

the Node Coverage

setNodeCover

public void setNodeCover(Object nodeCover)

Sets the Node Coverage parameter of this tool . This parameter is an existing cover whose node attribute values will be updated or created if the NAT does not exist. This is a required parameter.

Parameters:

nodeCover - an existing cover whose node attribute values will be updated or created if the NAT does not exist.

getSearchRadius

public double getSearchRadius()

Returns the Search Radius parameter of this tool . This parameter is the maximum distance apart that points and nodes can be for the attributes of the point class to be transferred and recorded to the node coverage as a node class. The radius is given in coverage units. The default search radius is the width or height of the node coverage's BND divided by 100, whichever is larger. This is an optional parameter.

Returns:

the Search Radius

setSearchRadius

public void setSearchRadius(double searchRadius)

Sets the Search Radius parameter of this tool . This parameter is the maximum distance apart that points and nodes can be for the attributes of the point class to be transferred and recorded to the node coverage as a node class. The radius is given in coverage units. The default search radius is the width or height of the node coverage's BND divided by 100, whichever is larger. This is an optional parameter.

Parameters:

searchRadius - the maximum distance apart that points and nodes can be for the attributes of the point class to be transferred and recorded to the node coverage as a node class. The radius is given in coverage units. The default search radius is the width or height of the node coverage's BND divided by 100, whichever is larger.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Coverage

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias