DocumentTableRelationCollection Leave feedback
On this page
Inheritance: java.lang.Object
All Implemented Interfaces: java.lang.Iterable
public class DocumentTableRelationCollection implements Iterable
Represents the collection of DocumentTableRelation objects of a single DocumentTableSet instance.
| Method | Description |
|---|---|
| add(DocumentTableColumn parentColumn, DocumentTableColumn childColumn) | Creates a DocumentTableRelation object for the specified parent and child columns, and adds it to the collection. |
| remove(DocumentTableRelation relation) | Removes the specified relation from the collection. |
| removeAt(int index) | Removes the relation at the specified index from the collection. |
| clear() | Clears the collection of any relations. |
| iterator() | Returns an enumerator to iterate DocumentTableRelation objects of this collection. |
| contains(DocumentTableRelation relation) | Returns a value indicating whether this collection contains the specified relation. |
| indexOf(DocumentTableRelation relation) | Returns the index of the specified relation within this collection. |
| get(int index) | Gets a DocumentTableRelation instance from the collection at the specified index. |
| getCount() | Gets the total number of DocumentTableRelation objects in the collection. |
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:
| Parameter | Type | Description |
|---|---|---|
| parentColumn | DocumentTableColumn | The parent column of the relation. |
| childColumn | DocumentTableColumn | The child column of the relation. |
Returns: DocumentTableRelation - The created relation.
public void remove(DocumentTableRelation relation)
Removes the specified relation from the collection.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| relation | DocumentTableRelation | The relation to remove. |
public void removeAt(int index)
Removes the relation at the specified index from the collection.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | int | The index of the relation to remove. |
public void clear()
Clears the collection of any relations.
public Iterator iterator()
Returns an enumerator to iterate DocumentTableRelation objects of this collection.
Returns: java.util.Iterator - An enumerator to iterate DocumentTableRelation objects of this collection.
public boolean contains(DocumentTableRelation relation)
Returns a value indicating whether this collection contains the specified relation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| relation | DocumentTableRelation | A relation to look for. |
Returns: boolean - A value indicating whether this collection contains the specified relation.
public int indexOf(DocumentTableRelation relation)
Returns the index of the specified relation within this collection.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| relation | DocumentTableRelation | A relation to find. |
Returns: int - The zero-based index of the specified relation, or -1 if the relation does not exist in this collection.
public DocumentTableRelation get(int index)
Gets a DocumentTableRelation instance from the collection at the specified index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | int | The zero-based index of the relation to return. |
Returns: DocumentTableRelation - A DocumentTableRelation instance from the collection at the specified index.
public int getCount()
Gets the total number of DocumentTableRelation objects in the collection.
Returns: int - The total number of DocumentTableRelation objects in the collection.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
