com.healthmarketscience.jackcess.util
Class TableIterableBuilder

java.lang.Object
  com.healthmarketscience.jackcess.util.TableIterableBuilder

All Implemented Interfaces:

Iterable<Table>

public class TableIterableBuilder
extends Object
implements Iterable<Table>

Builder style class for constructing a Database Iterable/Iterator for Tables. By default, normal (non-system, non-linked tables) and linked tables are included and system tables are not.

Author:

James Ahlborn

Usage:

General: This class is general use.

Constructor Summary

TableIterableBuilder(Database db)

Method Summary

boolean	isIncludeLinkedTables()
boolean	isIncludeNormalTables()
boolean	isIncludeSystemTables()
Iterator<Table>	iterator()
TableIterableBuilder	setIncludeLinkedTables(boolean includeLinkedTables)
TableIterableBuilder	setIncludeNormalTables(boolean includeNormalTables)
TableIterableBuilder	setIncludeSystemTables(boolean includeSystemTables)
TableIterableBuilder	withLocalUserTablesOnly() Convenience method to set the flags to include only non-linked (local) user tables.
TableIterableBuilder	withSystemTablesOnly() Convenience method to set the flags to include only system tables.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableIterableBuilder

public TableIterableBuilder(Database db)

Method Detail

isIncludeNormalTables

public boolean isIncludeNormalTables()

isIncludeSystemTables

public boolean isIncludeSystemTables()

isIncludeLinkedTables

public boolean isIncludeLinkedTables()

setIncludeNormalTables

public TableIterableBuilder setIncludeNormalTables(boolean includeNormalTables)

setIncludeSystemTables

public TableIterableBuilder setIncludeSystemTables(boolean includeSystemTables)

setIncludeLinkedTables

public TableIterableBuilder setIncludeLinkedTables(boolean includeLinkedTables)

withLocalUserTablesOnly

public TableIterableBuilder withLocalUserTablesOnly()

Convenience method to set the flags to include only non-linked (local) user tables.

withSystemTablesOnly

public TableIterableBuilder withSystemTablesOnly()

Convenience method to set the flags to include only system tables.

iterator

public Iterator<Table> iterator()

Specified by:

iterator in interface Iterable<Table>