|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.AbstractGPTool com.esri.arcgis.geoprocessing.tools.datamanagementtools.AddJoin
public class AddJoin
Joins a table view to a layer (or a table view to a table view) based on a common field. The Add Join tool is contained in the Data Management Tools tool box.
Field Summary |
---|
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
vals |
Constructor Summary | |
---|---|
AddJoin()
Creates the Add Join tool with defaults. |
|
AddJoin(Object inLayerOrView,
Object inField,
Object joinTable,
Object joinField)
Creates the Add Join tool with the required parameters. |
Method Summary | |
---|---|
Object |
getInField()
Returns the Input Join Field parameter of this tool . |
Object |
getInLayerOrView()
Returns the Layer Name or Table View parameter of this tool . |
Object |
getJoinField()
Returns the Output Join Field parameter of this tool . |
Object |
getJoinTable()
Returns the Join Table parameter of this tool . |
String |
getJoinType()
Returns the Keep All parameter of this tool . |
Object |
getOutLayerOrView()
Returns the Output Layer Name parameter of this tool (Read only). |
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 |
setInField(Object inField)
Sets the Input Join Field parameter of this tool . |
void |
setInLayerOrView(Object inLayerOrView)
Sets the Layer Name or Table View parameter of this tool . |
void |
setJoinField(Object joinField)
Sets the Output Join Field parameter of this tool . |
void |
setJoinTable(Object joinTable)
Sets the Join Table parameter of this tool . |
void |
setJoinType(String joinType)
Sets the Keep All 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 |
---|
public AddJoin()
Initializes the array of tool parameters with the default values specified when the tool was created.
public AddJoin(Object inLayerOrView, Object inField, Object joinTable, Object joinField)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
inLayerOrView
- the layer or table view to which the join table will be joined.inField
- the field in the input layer or table view on which the join will be based.joinTable
- the table or table view to be joined to the input layer or table view.joinField
- the field in the join table that contains the values on which the join will be based.Method Detail |
---|
public Object getInLayerOrView()
public void setInLayerOrView(Object inLayerOrView)
inLayerOrView
- the layer or table view to which the join table will be joined.public Object getInField()
public void setInField(Object inField)
inField
- the field in the input layer or table view on which the join will be based.public Object getJoinTable()
public void setJoinTable(Object joinTable)
joinTable
- the table or table view to be joined to the input layer or table view.public Object getJoinField()
public void setJoinField(Object joinField)
joinField
- the field in the join table that contains the values on which the join will be based.public String getJoinType()
public void setJoinType(String joinType)
joinType
- specifies what will be done with records in the input that match a record in the join table.public Object getOutLayerOrView()
public String getToolName()
public String getToolboxName()
public String getToolboxAlias()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |