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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.TableToRelationshipClass

All Implemented Interfaces:

GPTool

public class TableToRelationshipClass
extends AbstractGPTool

Creates an attributed relationship class from the origin, destination, and relationship tables. The Table To Relationship Class tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool creates a table in the database containing the selected attribute fields of the relationship table. These fields are used to store attributes of the relationship itself that are not attributed to either the origin or destination class. For example, in a parcel database, you may have a relationship class between parcels and owners in which owners "own" parcels and parcels are "owned by" owners. An attribute of that relationship may be percentage ownership.
• Simple or peer-to-peer relationships are relationships between two or more objects in the database that exist independently of each other. For example, in a railroad network, you may have railroad crossings that have one or more related signal lamps. However, a railroad crossing can exist without a signal lamp, and signal lamps exist on the railroad network where there are no railroad crossings. Simple relationships can have one-to-one, one-to-many, or many-to-many cardinality.
• A composite relationship is a relationship in which the lifetime of one object controls the lifetime of its related objects. For example, power poles support transformers and transformers are mounted on poles. Once a pole is deleted, a delete message is propagated to its related transformers, which are deleted from the transformers' feature class. Composite relationships are always one-to-many.
• Forward and backward path labels describe the relationship when navigating from one object to another. The forward path label describes the relationship navigated from the origin class to the destination class. In the pole-transformer example, a forward path label might be: Poles support transformers. The backward path label describes the relationship navigated from the destination to the origin class. In the pole-transformer example, a backward path label might be: Transformers are mounted on poles.
• Relationship classes can also be created in ArcCatalog. Select the menu item New Relationship Class from the context menu of a geodatabase.
• The Attribute Fields parameter's Add Field button is used only in ModelBuilder. In ModelBuilder, where the preceding tool has not been run, or its derived data does not exist, the Attribute Fields parameter may not be populated with field names. The Add Field button allows you to add expected field(s) so you can complete the Table To Relationship Class dialog box and continue to build your model.

Field Summary

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

vals

Constructor Summary

TableToRelationshipClass()
Creates the Table To Relationship Class tool with defaults.

TableToRelationshipClass(Object originTable, Object destinationTable, Object outRelationshipClass, String relationshipType, String forwardLabel, String backwardLabel, String messageDirection, String cardinality, Object relationshipTable, Object attributeFields, String originPrimaryKey, String originForeignKey, String destinationPrimaryKey, String destinationForeignKey)
Creates the Table To Relationship Class tool with the required parameters.

Method Summary

Object	getAttributeFields() Returns the Attribute Fields 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 .
Object	getRelationshipTable() Returns the Relationship Table 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	setAttributeFields(Object attributeFields) Sets the Attribute Fields 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	setRelationshipTable(Object relationshipTable) Sets the Relationship Table 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

TableToRelationshipClass

public TableToRelationshipClass()

Creates the Table To Relationship Class tool with defaults.

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

TableToRelationshipClass

public TableToRelationshipClass(Object originTable,
                                Object destinationTable,
                                Object outRelationshipClass,
                                String relationshipType,
                                String forwardLabel,
                                String backwardLabel,
                                String messageDirection,
                                String cardinality,
                                Object relationshipTable,
                                Object attributeFields,
                                String originPrimaryKey,
                                String originForeignKey,
                                String destinationPrimaryKey,
                                String destinationForeignKey)

Creates the Table To 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 - the table or feature class that will be associated to the destination table.

destinationTable - the table or feature class that will be associated to the origin table.

outRelationshipClass - the relationship class that will be created.

relationshipType - the type of association to create between the origin and destination tables.

forwardLabel - a label describing the relationship as it is traversed from the origin table/feature class to the destination table/feature class.

backwardLabel - a label describing the relationship as it is traversed from the destination table/feature class to the origin table/feature class.

messageDirection - the direction messages will be propagated between the objects in the relationship. 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 - the cardinality of the relationship between the origin and destination.

relationshipTable - the table containing attributes that will be added to the relationship class.

attributeFields - the fields containing attribute values that will be added to the relationship class.

originPrimaryKey - the field in the origin table that will be used to create the relationship. Generally, this is the object identifier field.

originForeignKey - the name of the Foreign Key field in the relationship table that refers to the Primary Key field in the origin table/feature class.

destinationPrimaryKey - the field in the destination table that will be used to create the relationship. Generally, this is the object identifier field.

destinationForeignKey - the field in the relationship table that refers to the Primary Key field in the destination table.

Method Detail

getOriginTable

public Object getOriginTable()

Returns the Origin Table parameter of this tool . This parameter is 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 the table or feature class that will be associated to the destination table. This is a required parameter.

Parameters:

originTable - 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 the table or feature class 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 the table or feature class that will be associated to the origin table. This is a required parameter.

Parameters:

destinationTable - the table or feature class that will be associated to the origin table.

getOutRelationshipClass

public Object getOutRelationshipClass()

Returns the Output Relationship Class parameter of this tool . This parameter is 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 the relationship class that will be created. This is a required parameter.

Parameters:

outRelationshipClass - the relationship class that will be created.

getRelationshipType

public String getRelationshipType()

Returns the Relationship Type parameter of this tool . This parameter is the type of association 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 the type of association to create between the origin and destination tables. This is a required parameter.

Parameters:

relationshipType - the type of association to create between the origin and destination tables.

getForwardLabel

public String getForwardLabel()

Returns the Forward Path Label parameter of this tool . This parameter is a label describing the relationship as it is traversed from the origin table/feature class to the destination table/feature class. 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 a label describing the relationship as it is traversed from the origin table/feature class to the destination table/feature class. This is a required parameter.

Parameters:

forwardLabel - a label describing the relationship as it is traversed from the origin table/feature class to the destination table/feature class.

getBackwardLabel

public String getBackwardLabel()

Returns the Backward Path Label parameter of this tool . This parameter is a label describing the relationship as it is traversed from the destination table/feature class to the origin table/feature class. 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 a label describing the relationship as it is traversed from the destination table/feature class to the origin table/feature class. This is a required parameter.

Parameters:

backwardLabel - a label describing the relationship as it is traversed from the destination table/feature class to the origin table/feature class.

getMessageDirection

public String getMessageDirection()

Returns the Message Direction parameter of this tool . This parameter is the direction messages will be propagated between the objects in the relationship. 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 the direction messages will be propagated between the objects in the relationship. 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 - the direction messages will be propagated between the objects in the relationship. 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 the cardinality of the relationship between the origin and destination. This is a required parameter.

Returns:

the Cardinality

setCardinality

public void setCardinality(String cardinality)

Sets the Cardinality parameter of this tool . This parameter is the cardinality of the relationship between the origin and destination. This is a required parameter.

Parameters:

cardinality - the cardinality of the relationship between the origin and destination.

getRelationshipTable

public Object getRelationshipTable()

Returns the Relationship Table parameter of this tool . This parameter is the table containing attributes that will be added to the relationship class. This is a required parameter.

Returns:

the Relationship Table

setRelationshipTable

public void setRelationshipTable(Object relationshipTable)

Sets the Relationship Table parameter of this tool . This parameter is the table containing attributes that will be added to the relationship class. This is a required parameter.

Parameters:

relationshipTable - the table containing attributes that will be added to the relationship class.

getAttributeFields

public Object getAttributeFields()

Returns the Attribute Fields parameter of this tool . This parameter is the fields containing attribute values that will be added to the relationship class. This is a required parameter.

Returns:

the Attribute Fields

setAttributeFields

public void setAttributeFields(Object attributeFields)

Sets the Attribute Fields parameter of this tool . This parameter is the fields containing attribute values that will be added to the relationship class. This is a required parameter.

Parameters:

attributeFields - the fields containing attribute values that will be added to the relationship class.

getOriginPrimaryKey

public String getOriginPrimaryKey()

Returns the Origin Primary Key parameter of this tool . This parameter is the field in the origin table that will be used to create the relationship. Generally, this is the object identifier field. 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 the field in the origin table that will be used to create the relationship. Generally, this is the object identifier field. This is a required parameter.

Parameters:

originPrimaryKey - the field in the origin table that will be used to create the relationship. Generally, this is the object identifier field.

getOriginForeignKey

public String getOriginForeignKey()

Returns the Origin Foreign Key parameter of this tool . This parameter is the name of the Foreign Key field in the relationship table that refers to the Primary Key field in the origin table/feature class. 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 the name of the Foreign Key field in the relationship table that refers to the Primary Key field in the origin table/feature class. This is a required parameter.

Parameters:

originForeignKey - the name of the Foreign Key field in the relationship table that refers to the Primary Key field in the origin table/feature class.

getDestinationPrimaryKey

public String getDestinationPrimaryKey()

Returns the Destination Primary Key parameter of this tool . This parameter is the field in the destination table that will be used to create the relationship. Generally, this is the object identifier field. This is a required parameter.

Returns:

the Destination Primary Key

setDestinationPrimaryKey

public void setDestinationPrimaryKey(String destinationPrimaryKey)

Sets the Destination Primary Key parameter of this tool . This parameter is the field in the destination table that will be used to create the relationship. Generally, this is the object identifier field. This is a required parameter.

Parameters:

destinationPrimaryKey - the field in the destination table that will be used to create the relationship. Generally, this is the object identifier field.

getDestinationForeignKey

public String getDestinationForeignKey()

Returns the Destination Foreign Key parameter of this tool . This parameter is the field in the relationship table that refers to the Primary Key field in the destination table. This is a required parameter.

Returns:

the Destination Foreign Key

setDestinationForeignKey

public void setDestinationForeignKey(String destinationForeignKey)

Sets the Destination Foreign Key parameter of this tool . This parameter is the field in the relationship table that refers to the Primary Key field in the destination table. This is a required parameter.

Parameters:

destinationForeignKey - the field in the relationship table that refers to the Primary Key field 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