DocumentTableCollection

Inheritance: java.lang.Object

All Implemented Interfaces: java.lang.Iterable

public class DocumentTableCollection implements Iterable

Represents a read-only collection of DocumentTable objects of a particular DocumentTableSet instance. The collection is filled automatically while loading the corresponding tables from a document and can not be modified. However, properties of DocumentTable objects contained within the collection can be modified.

Methods

Method	Description
iterator()	Returns an enumerator to iterate DocumentTable objects of this collection.
contains(String name)	Returns a value indicating whether this collection contains a table with the specified name.
contains(DocumentTable table)	Returns a value indicating whether this collection contains the specified table.
indexOf(String name)	Returns the index of a table with the specified name within this collection.
indexOf(DocumentTable table)	Returns the index of the specified table within this collection.
get(int index)	Gets a DocumentTable instance from the collection at the specified index.
get(String name)	Gets a DocumentTable instance with the specified name from the collection.
getCount()	Gets the total number of DocumentTable objects in the collection.

iterator()

public Iterator iterator()

Returns an enumerator to iterate DocumentTable objects of this collection.

Returns: java.util.Iterator - An enumerator to iterate DocumentTable objects of this collection.

contains(String name)

public boolean contains(String name)

Returns a value indicating whether this collection contains a table with the specified name.

Parameters:

Parameter	Type	Description
name	java.lang.String	The case-insensitive name of a table to look for.

Returns: boolean - A value indicating whether this collection contains a table with the specified name.

contains(DocumentTable table)

public boolean contains(DocumentTable table)

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

Parameters:

Parameter	Type	Description
table	DocumentTable	A table to look for.

Returns: boolean - A value indicating whether this collection contains the specified table.

indexOf(String name)

public int indexOf(String name)

Returns the index of a table with the specified name within this collection.

Parameters:

Parameter	Type	Description
name	java.lang.String	The case-insensitive name of a table to find.

Returns: int - The zero-based index of a table with the specified name, or -1 if the table does not exist in this collection.

indexOf(DocumentTable table)

public int indexOf(DocumentTable table)

Returns the index of the specified table within this collection.

Parameters:

Parameter	Type	Description
table	DocumentTable	A table to find.

Returns: int - The zero-based index of the specified table, or -1 if the table does not exist in this collection.

get(int index)

public DocumentTable get(int index)

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

Parameters:

Parameter	Type	Description
index	int	The zero-based index of the table to return.

Returns: DocumentTable - A DocumentTable instance from the collection at the specified index.

get(String name)

public DocumentTable get(String name)

Gets a DocumentTable instance with the specified name from the collection.

Parameters:

Parameter	Type	Description
name	java.lang.String	The case-insensitive name of the table to return.

Returns: DocumentTable - A DocumentTable instance with the specified name from the collection or null if such an instance does not exist.

getCount()

public int getCount()

Gets the total number of DocumentTable objects in the collection.

Returns: int - The total number of DocumentTable objects in the collection.