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

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

All Implemented Interfaces:

GPTool

public class CreateRelationshipClass
extends AbstractGPTool

This tool 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.

Usage tips:

• Relationships can exist between spatial objects (features in feature classes), nonspatial objects (rows in a table), or spatial and nonspatial objects.
• Once created, a relationship class cannot be modified; you can only add, delete, or refine its . Relationship classes can be deleted and renamed using ArcCatalog in the same manner as any other object in the database.
• For many-to-many relationship classes, a new table is created in the database to store the foreign keys used to link the origin and destination classes. This table can also have other fields 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 might have a relationship class between parcels and owners in which owners "own" parcels and parcels are "owned by" owners. An attribute of that relationship could be percentage ownership. One-to-one and one-to-many relationship classes can also have attributes; in this case, a table is created to store the relationships.
• Simple or peer-to-peer relationships involve two or more objects in the database that exist independently of each other. For example, in a railroad network, you might 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 one 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 command New Relationship Class from the context menu of a geodatabase.

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 - the table or feature class that is associated to the destination table.

destinationTable - the table that is associated to the origin table.

outRelationshipClass - the relationship class that is created.

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

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

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

messageDirection - the direction in which messages are 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 - determines how many relationships exist between rows or features in the origin and rows or features in the destination table.

attributed - specifies if the relationship will have attributes.

originPrimaryKey - 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 - the field in the relationship class table that links it to the Origin Primary Key field in the origin table.

Method Detail

getOriginTable

public Object getOriginTable()

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

Parameters:

originTable - the table or feature class that is associated to the destination table.

getDestinationTable

public Object getDestinationTable()

Returns the Destination Table parameter of this tool . This parameter is the table that is 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 that is associated to the origin table. This is a required parameter.

Parameters:

destinationTable - the table that is 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 is 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 is created. This is a required parameter.

Parameters:

outRelationshipClass - the relationship class that is created.

getRelationshipType

public String getRelationshipType()

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

Parameters:

relationshipType - 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 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 a name to uniquely identify the relationship when navigating from the origin table to the destination table. This is a required parameter.

Parameters:

forwardLabel - 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 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 a name to uniquely identify the relationship when navigating from the destination table to the origin table. This is a required parameter.

Parameters:

backwardLabel - 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 the direction in which messages are 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 the direction in which messages are 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 - the direction in which messages are 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 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 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 - 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 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 specifies if the relationship will have attributes. This is a required parameter.

Parameters:

attributed - specifies if the relationship will have attributes.

getOriginPrimaryKey

public String getOriginPrimaryKey()

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

Parameters:

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

getDestinationPrimaryKey

public String getDestinationPrimaryKey()

Returns the Destination Primary Key parameter of this tool . This parameter is 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 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 - 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 the field in the relationship class table that links it to the Destination Primary Key field 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 the field in the relationship class table that links it to the Destination Primary Key field in the destination table. This is an optional parameter.

Parameters:

destinationForeignKey - the field in the relationship class table that links it to the Destination 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