com.aspose.words.net.System.Data

Class DataRelation

java.lang.Object

com.aspose.words.net.System.Data.DataRelation

public class DataRelation
extends java.lang.Object

Represents a parent/child relationship between two DataTable objects.

Constructor Summary

Constructors

Constructor and Description
DataRelation(java.lang.String relationName, DataColumn[] parentColumns, DataColumn[] childColumns, boolean createConstraints) Initializes a new instance of the DataRelation class using the specified name, matched arrays of parent and child DataColumn objects, and value that indicates whether to create constraints.
DataRelation(java.lang.String relationName, DataColumn parentColumn, DataColumn childColumn) Initializes a new instance of the DataRelation class using the specified DataRelation name, and parent and child DataColumn objects.
DataRelation(java.lang.String relationName, DataColumn parentColumn, DataColumn childColumn, boolean createConstraints) Initializes a new instance of the DataRelation class using the specified name, parent and child DataColumn objects, and a value that indicates whether to create constraints.
DataRelation(java.lang.String relationName, DataTable parentTable, DataTable childTable, java.lang.String[] parentColumnNames, java.lang.String[] childColumnNames) Initializes a new instance of the DataRelation class using the specified name, parent and child tables, matched arrays of parent and child columns.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String[]	getChildColumnNames()
DataColumn[]	getChildColumns() Gets the child DataColumn objects of this relation.
DataKey	getChildKey()
ForeignKeyConstraint	getChildKeyConstraint() Gets the ForeignKeyConstraint for the relation.
DataTable	getChildTable() Gets the child table of this relation.
java.lang.String	getChildTableName()
DataSet	getDataSet() Gets the DataSet to which the DataRelation belongs.
java.lang.String[]	getParentColumnNames()
DataColumn[]	getParentColumns() Gets an array of DataColumn objects that are the parent columns of this DataRelation.
DataKey	getParentKey()
UniqueConstraint	getParentKeyConstraint() Gets the UniqueConstraint that guarantees that values in the parent column of a DataRelation are unique.
DataTable	getParentTable() Gets the parent DataTable of this DataRelation.
java.lang.String	getParentTableName()
java.lang.String	getRelationName() Gets the name used to retrieve a DataRelation from the DataRelationCollection.
int	hashCode()
void	setChildKeyConstraint(ForeignKeyConstraint childKeyConstraint)
void	setNested(boolean value) Sets a value that indicates whether DataRelation objects are nested.
void	setParentKeyConstraint(UniqueConstraint parentKeyConstraint)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataRelation

public DataRelation(java.lang.String relationName,
                    DataTable parentTable,
                    DataTable childTable,
                    java.lang.String[] parentColumnNames,
                    java.lang.String[] childColumnNames)

Initializes a new instance of the DataRelation class using the specified name, parent and child tables, matched arrays of parent and child columns.

Parameters:

relationName - The name of the DataRelation. If null or an empty string (""), a default name will be given when the created object is added to the DataRelationCollection.

parentTable - The parent table in the relationship.

childTable - The child table in the relationship.

parentColumnNames - The parent DataColumn's name in the relationship.

childColumnNames - The child DataColumn;s in the relationship.

DataRelation

public DataRelation(java.lang.String relationName,
                    DataColumn[] parentColumns,
                    DataColumn[] childColumns,
                    boolean createConstraints)

Initializes a new instance of the DataRelation class using the specified name, matched arrays of parent and child DataColumn objects, and value that indicates whether to create constraints.

Parameters:

relationName - The name of the relation. If null or an empty string (""), a default name will be given when the created object is added to the DataRelationCollection.

parentColumns - An array of parent DataColumn objects.

childColumns - An array of child DataColumn objects.

createConstraints - A value that indicates whether to create constraints. true, if constraints are created. Otherwise, false.

DataRelation

public DataRelation(java.lang.String relationName,
                    DataColumn parentColumn,
                    DataColumn childColumn,
                    boolean createConstraints)

Initializes a new instance of the DataRelation class using the specified name, parent and child DataColumn objects, and a value that indicates whether to create constraints.

Parameters:

relationName - The name of the relation. If null or an empty string (""), a default name will be given when the created object is added to the DataRelationCollection.

parentColumn - The parent DataColumn in the relation.

childColumn - The child DataColumn in the relation.

createConstraints - A value that indicates whether constraints are created. true, if constraints are created. Otherwise, false.

DataRelation

public DataRelation(java.lang.String relationName,
                    DataColumn parentColumn,
                    DataColumn childColumn)

Initializes a new instance of the DataRelation class using the specified DataRelation name, and parent and child DataColumn objects.

Parameters:

relationName - The name of the DataRelation. If null or an empty string (""), a default name will be given when the created object is added to the DataRelationCollection.

parentColumn - The parent DataColumn in the relationship.

childColumn - The child DataColumn in the relationship.

Method Detail

getRelationName

public java.lang.String getRelationName()

Gets the name used to retrieve a DataRelation from the DataRelationCollection.

Returns:

The name of the a DataRelation.

getParentTableName

public java.lang.String getParentTableName()

Returns:

the parent DataTable's name of this DataRelation.

getChildTableName

public java.lang.String getChildTableName()

Returns:

the child DataTable's name of this DataRelation.

getParentTable

public DataTable getParentTable()

Gets the parent DataTable of this DataRelation.

Returns:

A DataTable that is the parent table of this relation.

getChildTable

public DataTable getChildTable()

Gets the child table of this relation.

Returns:

A DataTable that is the child table of the relation.

getParentColumnNames

public java.lang.String[] getParentColumnNames()

Returns:

the parent DataColumn names of this relation.

getChildColumnNames

public java.lang.String[] getChildColumnNames()

Returns:

the child DataColumn names of this relation.

getParentColumns

public DataColumn[] getParentColumns()

Gets an array of DataColumn objects that are the parent columns of this DataRelation.

Returns:

An array of DataColumn objects that are the parent columns of this DataRelation.

getChildColumns

public DataColumn[] getChildColumns()

Gets the child DataColumn objects of this relation.

Returns:

An array of DataColumn objects.

setNested

public void setNested(boolean value)

Sets a value that indicates whether DataRelation objects are nested.

Parameters:

value - true, if DataRelation objects are nested; otherwise, false.

getParentKeyConstraint

public UniqueConstraint getParentKeyConstraint()

Gets the UniqueConstraint that guarantees that values in the parent column of a DataRelation are unique.

Returns:

A UniqueConstraint that makes sure that values in a parent column are unique.

setParentKeyConstraint

public void setParentKeyConstraint(UniqueConstraint parentKeyConstraint)

getChildKeyConstraint

public ForeignKeyConstraint getChildKeyConstraint()

Gets the ForeignKeyConstraint for the relation.

Returns:

A ForeignKeyConstraint.

setChildKeyConstraint

public void setChildKeyConstraint(ForeignKeyConstraint childKeyConstraint)

getChildKey

public DataKey getChildKey()

getParentKey

public DataKey getParentKey()

getDataSet

public DataSet getDataSet()

Gets the DataSet to which the DataRelation belongs.

Returns:

A DataSet to which the DataRelation belongs.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object