com.groupdocs.assembly

Class DocumentTableRelationCollection

java.lang.Object

com.groupdocs.assembly.DocumentTableRelationCollection

All Implemented Interfaces:

java.lang.Iterable

public class DocumentTableRelationCollection
extends java.lang.Object
implements java.lang.Iterable

Represents the collection of DocumentTableRelation objects of a single DocumentTableSet instance.

Method Summary

Modifier and Type	Method and Description
DocumentTableRelation	add(DocumentTableColumn parentColumn, DocumentTableColumn childColumn) Creates a DocumentTableRelation object for the specified parent and child columns, and adds it to the collection.
void	clear() Clears the collection of any relations.
boolean	contains(DocumentTableRelation relation) Returns a value indicating whether this collection contains the specified relation.
DocumentTableRelation	get(int index) Gets a DocumentTableRelation instance from the collection at the specified index.
int	getCount() Gets the total number of DocumentTableRelation objects in the collection.
int	indexOf(DocumentTableRelation relation) Returns the index of the specified relation within this collection.
java.util.Iterator	iterator() Returns an enumerator to iterate DocumentTableRelation objects of this collection.
void	remove(DocumentTableRelation relation) Removes the specified relation from the collection.
void	removeAt(int index) Removes the relation at the specified index from the collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

add

public DocumentTableRelation add(DocumentTableColumn parentColumn,
                                 DocumentTableColumn childColumn)

Creates a DocumentTableRelation object for the specified parent and child columns, and adds it to the collection.

Parameters:

parentColumn - The parent column of the relation.

childColumn - The child column of the relation.

Returns:

The created relation.

remove

public void remove(DocumentTableRelation relation)

Removes the specified relation from the collection.

Parameters:

relation - The relation to remove.

removeAt

public void removeAt(int index)

Removes the relation at the specified index from the collection.

Parameters:

index - The index of the relation to remove.

clear

public void clear()

Clears the collection of any relations.

iterator

public java.util.Iterator iterator()

Returns an enumerator to iterate DocumentTableRelation objects of this collection.

Specified by:

iterator in interface java.lang.Iterable

Returns:

An enumerator to iterate DocumentTableRelation objects of this collection.

contains

public boolean contains(DocumentTableRelation relation)

Returns a value indicating whether this collection contains the specified relation.

Parameters:

relation - A relation to look for.

Returns:

A value indicating whether this collection contains the specified relation.

indexOf

public int indexOf(DocumentTableRelation relation)

Returns the index of the specified relation within this collection.

Parameters:

relation - A relation to find.

Returns:

The zero-based index of the specified relation, or -1 if the relation does not exist in this collection.

get

public DocumentTableRelation get(int index)

Gets a DocumentTableRelation instance from the collection at the specified index.

Parameters:

index - The zero-based index of the relation to return.

Returns:

A DocumentTableRelation instance from the collection at the specified index.

getCount

public int getCount()

Gets the total number of DocumentTableRelation objects in the collection.

Returns:

The total number of DocumentTableRelation objects in the collection.