com.esri.arcgis.geoprocessing.tools.cartographytools
Class IntersectingLayersMasks

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.cartographytools.IntersectingLayersMasks
All Implemented Interfaces:
GPTool

public class IntersectingLayersMasks
extends AbstractGPTool

Creates masking polygons at a specified shape and size at the intersections of symbolized input layers. This tool accepts point, line, and polygon feature layers as well as geodatabase annotation layers as input. The Intersecting Layers Masks tool is contained in the Cartography Tools tool box.

Software restrictions: ArcInfo only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
IntersectingLayersMasks()
          Creates the Intersecting Layers Masks tool with defaults.
IntersectingLayersMasks(Object maskingLayer, Object maskedLayer, Object outputFc, double referenceScale, Object spatialReference, Object margin, String method, String maskForNonPlacedAnno)
          Creates the Intersecting Layers Masks tool with the required parameters.
 
Method Summary
 String getAttributes()
          Returns the Transfer Attributes parameter of this tool .
 Object getMargin()
          Returns the Margin parameter of this tool .
 Object getMaskedLayer()
          Returns the Masked Layer parameter of this tool .
 String getMaskForNonPlacedAnno()
          Returns the Create masks for unplaced annotation.
 Object getMaskingLayer()
          Returns the Masking Layer parameter of this tool .
 String getMethod()
          Returns the Mask Kind parameter of this tool .
 Object getOutputFc()
          Returns the Output Feature Class parameter of this tool .
 double getReferenceScale()
          Returns the Reference Scale parameter of this tool .
 Object getSpatialReference()
          Returns the Calculation coordinate system 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 setAttributes(String attributes)
          Sets the Transfer Attributes parameter of this tool .
 void setMargin(Object margin)
          Sets the Margin parameter of this tool .
 void setMaskedLayer(Object maskedLayer)
          Sets the Masked Layer parameter of this tool .
 void setMaskForNonPlacedAnno(String maskForNonPlacedAnno)
          Sets the Create masks for unplaced annotation.
 void setMaskingLayer(Object maskingLayer)
          Sets the Masking Layer parameter of this tool .
 void setMethod(String method)
          Sets the Mask Kind parameter of this tool .
 void setOutputFc(Object outputFc)
          Sets the Output Feature Class parameter of this tool .
 void setReferenceScale(double referenceScale)
          Sets the Reference Scale parameter of this tool .
 void setSpatialReference(Object spatialReference)
          Sets the Calculation coordinate system 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

IntersectingLayersMasks

public IntersectingLayersMasks()
Creates the Intersecting Layers Masks tool with defaults.

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


IntersectingLayersMasks

public IntersectingLayersMasks(Object maskingLayer,
                               Object maskedLayer,
                               Object outputFc,
                               double referenceScale,
                               Object spatialReference,
                               Object margin,
                               String method,
                               String maskForNonPlacedAnno)
Creates the Intersecting Layers Masks 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:
maskingLayer - Layer, the symbolized input layer, which will be intersected with the masked layer to create masking polygons. This is the layer that will be more prominently displayed when masking is applied to the masked layer.
maskedLayer - Layer, the symbolized input layer to be masked. This is the layer that will be obscured by the masking polygons.
outputFc - Feature Class, the feature class that will contain the mask features.
referenceScale - Double, the reference scale used for calculating the masking geometry when masks are specified in page units. This is typically the reference scale of the map.
spatialReference - Spatial Reference, the spatial reference for which the masking polygons will be created. This is not the spatial reference that will be assigned to the output feature class. It is the spatial reference of the map in which the masking polygons will be used since the position of symbology may change when features are projected.
margin - Linear unit, if you choose any other units for your margin, then masks are created using the margin distance as calculated in map space (you can think of the margin as a real world distance measure on the earth). Also, in this case, the reference scale parameter value is not used as part of the calculation.
method - String, the type of masking geometry created. There are four types:
maskForNonPlacedAnno - String, specifies whether to create masks for unplaced annotation. This option is only used when masking geodatabase annotation layers.
Method Detail

getMaskingLayer

public Object getMaskingLayer()
Returns the Masking Layer parameter of this tool . This parameter is Layer, the symbolized input layer, which will be intersected with the masked layer to create masking polygons. This is the layer that will be more prominently displayed when masking is applied to the masked layer. This is a required parameter.

Returns:
the Masking Layer

setMaskingLayer

public void setMaskingLayer(Object maskingLayer)
Sets the Masking Layer parameter of this tool . This parameter is Layer, the symbolized input layer, which will be intersected with the masked layer to create masking polygons. This is the layer that will be more prominently displayed when masking is applied to the masked layer. This is a required parameter.

Parameters:
maskingLayer - Layer, the symbolized input layer, which will be intersected with the masked layer to create masking polygons. This is the layer that will be more prominently displayed when masking is applied to the masked layer.

getMaskedLayer

public Object getMaskedLayer()
Returns the Masked Layer parameter of this tool . This parameter is Layer, the symbolized input layer to be masked. This is the layer that will be obscured by the masking polygons. This is a required parameter.

Returns:
the Masked Layer

setMaskedLayer

public void setMaskedLayer(Object maskedLayer)
Sets the Masked Layer parameter of this tool . This parameter is Layer, the symbolized input layer to be masked. This is the layer that will be obscured by the masking polygons. This is a required parameter.

Parameters:
maskedLayer - Layer, the symbolized input layer to be masked. This is the layer that will be obscured by the masking polygons.

getOutputFc

public Object getOutputFc()
Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the feature class that will contain the mask features. This is a required parameter.

Returns:
the Output Feature Class

setOutputFc

public void setOutputFc(Object outputFc)
Sets the Output Feature Class parameter of this tool . This parameter is Feature Class, the feature class that will contain the mask features. This is a required parameter.

Parameters:
outputFc - Feature Class, the feature class that will contain the mask features.

getReferenceScale

public double getReferenceScale()
Returns the Reference Scale parameter of this tool . This parameter is Double, the reference scale used for calculating the masking geometry when masks are specified in page units. This is typically the reference scale of the map. This is a required parameter.

Returns:
the Reference Scale

setReferenceScale

public void setReferenceScale(double referenceScale)
Sets the Reference Scale parameter of this tool . This parameter is Double, the reference scale used for calculating the masking geometry when masks are specified in page units. This is typically the reference scale of the map. This is a required parameter.

Parameters:
referenceScale - Double, the reference scale used for calculating the masking geometry when masks are specified in page units. This is typically the reference scale of the map.

getSpatialReference

public Object getSpatialReference()
Returns the Calculation coordinate system parameter of this tool . This parameter is Spatial Reference, the spatial reference for which the masking polygons will be created. This is not the spatial reference that will be assigned to the output feature class. It is the spatial reference of the map in which the masking polygons will be used since the position of symbology may change when features are projected. This is a required parameter.

Returns:
the Calculation coordinate system

setSpatialReference

public void setSpatialReference(Object spatialReference)
Sets the Calculation coordinate system parameter of this tool . This parameter is Spatial Reference, the spatial reference for which the masking polygons will be created. This is not the spatial reference that will be assigned to the output feature class. It is the spatial reference of the map in which the masking polygons will be used since the position of symbology may change when features are projected. This is a required parameter.

Parameters:
spatialReference - Spatial Reference, the spatial reference for which the masking polygons will be created. This is not the spatial reference that will be assigned to the output feature class. It is the spatial reference of the map in which the masking polygons will be used since the position of symbology may change when features are projected.

getMargin

public Object getMargin()
Returns the Margin parameter of this tool . This parameter is Linear unit, if you choose any other units for your margin, then masks are created using the margin distance as calculated in map space (you can think of the margin as a real world distance measure on the earth). Also, in this case, the reference scale parameter value is not used as part of the calculation. This is a required parameter.

Returns:
the Margin

setMargin

public void setMargin(Object margin)
Sets the Margin parameter of this tool . This parameter is Linear unit, if you choose any other units for your margin, then masks are created using the margin distance as calculated in map space (you can think of the margin as a real world distance measure on the earth). Also, in this case, the reference scale parameter value is not used as part of the calculation. This is a required parameter.

Parameters:
margin - Linear unit, if you choose any other units for your margin, then masks are created using the margin distance as calculated in map space (you can think of the margin as a real world distance measure on the earth). Also, in this case, the reference scale parameter value is not used as part of the calculation.

getMethod

public String getMethod()
Returns the Mask Kind parameter of this tool . This parameter is String, the type of masking geometry created. There are four types: This is a required parameter.

Returns:
the Mask Kind

setMethod

public void setMethod(String method)
Sets the Mask Kind parameter of this tool . This parameter is String, the type of masking geometry created. There are four types: This is a required parameter.

Parameters:
method - String, the type of masking geometry created. There are four types:

getMaskForNonPlacedAnno

public String getMaskForNonPlacedAnno()
Returns the Create masks for unplaced annotation. parameter of this tool . This parameter is String, specifies whether to create masks for unplaced annotation. This option is only used when masking geodatabase annotation layers. This is a required parameter.

Returns:
the Create masks for unplaced annotation.

setMaskForNonPlacedAnno

public void setMaskForNonPlacedAnno(String maskForNonPlacedAnno)
Sets the Create masks for unplaced annotation. parameter of this tool . This parameter is String, specifies whether to create masks for unplaced annotation. This option is only used when masking geodatabase annotation layers. This is a required parameter.

Parameters:
maskForNonPlacedAnno - String, specifies whether to create masks for unplaced annotation. This option is only used when masking geodatabase annotation layers.

getAttributes

public String getAttributes()
Returns the Transfer Attributes parameter of this tool . This parameter is String, determines which attributes will be transferred from the input features to the output features. This is an optional parameter.

Returns:
the Transfer Attributes

setAttributes

public void setAttributes(String attributes)
Sets the Transfer Attributes parameter of this tool . This parameter is String, determines which attributes will be transferred from the input features to the output features. This is an optional parameter.

Parameters:
attributes - String, determines which attributes will be transferred from the input features to the output features.

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