com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class CreateRelationshipClass

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

public class CreateRelationshipClass
extends AbstractGPTool

Creates a relationship class to store an association between fields or features in the origin table and the destination table. The Create Relationship Class tool is contained in the Data Management Tools tool box.

Software restrictions: ArcInfo and ArcEditor only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateRelationshipClass()
          Creates the Create Relationship Class tool with defaults.
CreateRelationshipClass(Object originTable, Object destinationTable, Object outRelationshipClass, String relationshipType, String forwardLabel, String backwardLabel, String messageDirection, String cardinality, String attributed, String originPrimaryKey, String originForeignKey)
          Creates the Create Relationship Class tool with the required parameters.
 
Method Summary
 String getAttributed()
          Returns the Relationship class is attributed parameter of this tool .
 String getBackwardLabel()
          Returns the Backward Path label parameter of this tool .
 String getCardinality()
          Returns the Cardinality parameter of this tool .
 String getDestinationForeignKey()
          Returns the Destination Foreign Key parameter of this tool .
 String getDestinationPrimaryKey()
          Returns the Destination Primary Key parameter of this tool .
 Object getDestinationTable()
          Returns the Destination Table parameter of this tool .
 String getForwardLabel()
          Returns the Forward Path Label parameter of this tool .
 String getMessageDirection()
          Returns the Message Direction parameter of this tool .
 String getOriginForeignKey()
          Returns the Origin Foreign Key parameter of this tool .
 String getOriginPrimaryKey()
          Returns the Origin Primary Key parameter of this tool .
 Object getOriginTable()
          Returns the Origin Table parameter of this tool .
 Object getOutRelationshipClass()
          Returns the Output Relationship Class parameter of this tool .
 String getRelationshipType()
          Returns the Relationship Type 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 setAttributed(String attributed)
          Sets the Relationship class is attributed parameter of this tool .
 void setBackwardLabel(String backwardLabel)
          Sets the Backward Path label parameter of this tool .
 void setCardinality(String cardinality)
          Sets the Cardinality parameter of this tool .
 void setDestinationForeignKey(String destinationForeignKey)
          Sets the Destination Foreign Key parameter of this tool .
 void setDestinationPrimaryKey(String destinationPrimaryKey)
          Sets the Destination Primary Key parameter of this tool .
 void setDestinationTable(Object destinationTable)
          Sets the Destination Table parameter of this tool .
 void setForwardLabel(String forwardLabel)
          Sets the Forward Path Label parameter of this tool .
 void setMessageDirection(String messageDirection)
          Sets the Message Direction parameter of this tool .
 void setOriginForeignKey(String originForeignKey)
          Sets the Origin Foreign Key parameter of this tool .
 void setOriginPrimaryKey(String originPrimaryKey)
          Sets the Origin Primary Key parameter of this tool .
 void setOriginTable(Object originTable)
          Sets the Origin Table parameter of this tool .
 void setOutRelationshipClass(Object outRelationshipClass)
          Sets the Output Relationship Class parameter of this tool .
 void setRelationshipType(String relationshipType)
          Sets the Relationship Type 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

CreateRelationshipClass

public CreateRelationshipClass()
Creates the Create Relationship Class tool with defaults.

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


CreateRelationshipClass

public CreateRelationshipClass(Object originTable,
                               Object destinationTable,
                               Object outRelationshipClass,
                               String relationshipType,
                               String forwardLabel,
                               String backwardLabel,
                               String messageDirection,
                               String cardinality,
                               String attributed,
                               String originPrimaryKey,
                               String originForeignKey)
Creates the Create Relationship Class 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:
originTable - Table View, the table or feature class that will be associated to the destination table.
destinationTable - Table View, the table that will be associated to the origin table.
outRelationshipClass - Relationship Class, the relationship class that will be created.
relationshipType - String, the type of relationship to create between the origin and destination tables.
forwardLabel - String, a name to uniquely identify the relationship when navigating from the origin table to the destination table.
backwardLabel - String, a name to uniquely identify the relationship when navigating from the destination table to the origin table.
messageDirection - String, the direction in which messages will be passed between the origin and destination tables. For example, in a relationship between poles and transformers, when the pole is deleted, it sends a message to its related transformer objects informing them it was deleted.
cardinality - String, determines how many relationships exist between rows or features in the origin and rows or features in the destination table.
attributed - String, specifies if the relationship will have attributes.
originPrimaryKey - String, the field in the origin table, typically the OID field, that links it to the Origin Foreign Key field in the relationship class table.
originForeignKey - String, the field in the relationship class table that links it to the Origin Primary Key in the origin table.
Method Detail

getOriginTable

public Object getOriginTable()
Returns the Origin Table parameter of this tool . This parameter is Table View, the table or feature class that will be associated to the destination table. This is a required parameter.

Returns:
the Origin Table

setOriginTable

public void setOriginTable(Object originTable)
Sets the Origin Table parameter of this tool . This parameter is Table View, the table or feature class that will be associated to the destination table. This is a required parameter.

Parameters:
originTable - Table View, the table or feature class that will be associated to the destination table.

getDestinationTable

public Object getDestinationTable()
Returns the Destination Table parameter of this tool . This parameter is Table View, the table that will be associated to the origin table. This is a required parameter.

Returns:
the Destination Table

setDestinationTable

public void setDestinationTable(Object destinationTable)
Sets the Destination Table parameter of this tool . This parameter is Table View, the table that will be associated to the origin table. This is a required parameter.

Parameters:
destinationTable - Table View, the table that will be associated to the origin table.

getOutRelationshipClass

public Object getOutRelationshipClass()
Returns the Output Relationship Class parameter of this tool . This parameter is Relationship Class, the relationship class that will be created. This is a required parameter.

Returns:
the Output Relationship Class

setOutRelationshipClass

public void setOutRelationshipClass(Object outRelationshipClass)
Sets the Output Relationship Class parameter of this tool . This parameter is Relationship Class, the relationship class that will be created. This is a required parameter.

Parameters:
outRelationshipClass - Relationship Class, the relationship class that will be created.

getRelationshipType

public String getRelationshipType()
Returns the Relationship Type parameter of this tool . This parameter is String, the type of relationship to create between the origin and destination tables. This is a required parameter.

Returns:
the Relationship Type

setRelationshipType

public void setRelationshipType(String relationshipType)
Sets the Relationship Type parameter of this tool . This parameter is String, the type of relationship to create between the origin and destination tables. This is a required parameter.

Parameters:
relationshipType - String, the type of relationship to create between the origin and destination tables.

getForwardLabel

public String getForwardLabel()
Returns the Forward Path Label parameter of this tool . This parameter is String, a name to uniquely identify the relationship when navigating from the origin table to the destination table. This is a required parameter.

Returns:
the Forward Path Label

setForwardLabel

public void setForwardLabel(String forwardLabel)
Sets the Forward Path Label parameter of this tool . This parameter is String, a name to uniquely identify the relationship when navigating from the origin table to the destination table. This is a required parameter.

Parameters:
forwardLabel - String, a name to uniquely identify the relationship when navigating from the origin table to the destination table.

getBackwardLabel

public String getBackwardLabel()
Returns the Backward Path label parameter of this tool . This parameter is String, a name to uniquely identify the relationship when navigating from the destination table to the origin table. This is a required parameter.

Returns:
the Backward Path label

setBackwardLabel

public void setBackwardLabel(String backwardLabel)
Sets the Backward Path label parameter of this tool . This parameter is String, a name to uniquely identify the relationship when navigating from the destination table to the origin table. This is a required parameter.

Parameters:
backwardLabel - String, a name to uniquely identify the relationship when navigating from the destination table to the origin table.

getMessageDirection

public String getMessageDirection()
Returns the Message Direction parameter of this tool . This parameter is String, the direction in which messages will be passed between the origin and destination tables. For example, in a relationship between poles and transformers, when the pole is deleted, it sends a message to its related transformer objects informing them it was deleted. This is a required parameter.

Returns:
the Message Direction

setMessageDirection

public void setMessageDirection(String messageDirection)
Sets the Message Direction parameter of this tool . This parameter is String, the direction in which messages will be passed between the origin and destination tables. For example, in a relationship between poles and transformers, when the pole is deleted, it sends a message to its related transformer objects informing them it was deleted. This is a required parameter.

Parameters:
messageDirection - String, the direction in which messages will be passed between the origin and destination tables. For example, in a relationship between poles and transformers, when the pole is deleted, it sends a message to its related transformer objects informing them it was deleted.

getCardinality

public String getCardinality()
Returns the Cardinality parameter of this tool . This parameter is String, determines how many relationships exist between rows or features in the origin and rows or features in the destination table. This is a required parameter.

Returns:
the Cardinality

setCardinality

public void setCardinality(String cardinality)
Sets the Cardinality parameter of this tool . This parameter is String, determines how many relationships exist between rows or features in the origin and rows or features in the destination table. This is a required parameter.

Parameters:
cardinality - String, determines how many relationships exist between rows or features in the origin and rows or features in the destination table.

getAttributed

public String getAttributed()
Returns the Relationship class is attributed parameter of this tool . This parameter is String, specifies if the relationship will have attributes. This is a required parameter.

Returns:
the Relationship class is attributed

setAttributed

public void setAttributed(String attributed)
Sets the Relationship class is attributed parameter of this tool . This parameter is String, specifies if the relationship will have attributes. This is a required parameter.

Parameters:
attributed - String, specifies if the relationship will have attributes.

getOriginPrimaryKey

public String getOriginPrimaryKey()
Returns the Origin Primary Key parameter of this tool . This parameter is String, the field in the origin table, typically the OID field, that links it to the Origin Foreign Key field in the relationship class table. This is a required parameter.

Returns:
the Origin Primary Key

setOriginPrimaryKey

public void setOriginPrimaryKey(String originPrimaryKey)
Sets the Origin Primary Key parameter of this tool . This parameter is String, the field in the origin table, typically the OID field, that links it to the Origin Foreign Key field in the relationship class table. This is a required parameter.

Parameters:
originPrimaryKey - String, the field in the origin table, typically the OID field, that links it to the Origin Foreign Key field in the relationship class table.

getOriginForeignKey

public String getOriginForeignKey()
Returns the Origin Foreign Key parameter of this tool . This parameter is String, the field in the relationship class table that links it to the Origin Primary Key in the origin table. This is a required parameter.

Returns:
the Origin Foreign Key

setOriginForeignKey

public void setOriginForeignKey(String originForeignKey)
Sets the Origin Foreign Key parameter of this tool . This parameter is String, the field in the relationship class table that links it to the Origin Primary Key in the origin table. This is a required parameter.

Parameters:
originForeignKey - String, the field in the relationship class table that links it to the Origin Primary Key in the origin table.

getDestinationPrimaryKey

public String getDestinationPrimaryKey()
Returns the Destination Primary Key parameter of this tool . This parameter is String, the field in the destination table, typically the OID field, that links it to the Destination Foreign Key field in the relationship class table. This is an optional parameter.

Returns:
the Destination Primary Key

setDestinationPrimaryKey

public void setDestinationPrimaryKey(String destinationPrimaryKey)
Sets the Destination Primary Key parameter of this tool . This parameter is String, the field in the destination table, typically the OID field, that links it to the Destination Foreign Key field in the relationship class table. This is an optional parameter.

Parameters:
destinationPrimaryKey - String, the field in the destination table, typically the OID field, that links it to the Destination Foreign Key field in the relationship class table.

getDestinationForeignKey

public String getDestinationForeignKey()
Returns the Destination Foreign Key parameter of this tool . This parameter is String, the field in the relationship class table that links it to the Destination Primary Key in the destination table. This is an optional parameter.

Returns:
the Destination Foreign Key

setDestinationForeignKey

public void setDestinationForeignKey(String destinationForeignKey)
Sets the Destination Foreign Key parameter of this tool . This parameter is String, the field in the relationship class table that links it to the Destination Primary Key in the destination table. This is an optional parameter.

Parameters:
destinationForeignKey - String, the field in the relationship class table that links it to the Destination Primary Key in the destination table.

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