src/main/java/com/healthmarketscience/jackcess/util/TableIterableBuilder.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

/*
Copyright (c) 2015 James Ahlborn

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
USA
*/

package com.healthmarketscience.jackcess.util;

import java.util.Iterator;

import com.healthmarketscience.jackcess.Database;
import com.healthmarketscience.jackcess.Table;
import com.healthmarketscience.jackcess.impl.DatabaseImpl;

/**
 * Builder style class for constructing a {@link Database} Iterable/Iterator
 * for {@link Table}s.  By default, normal (non-system, non-linked tables) and
 * linked tables are included and system tables are not.
 *
 * @author James Ahlborn
 * @usage _general_class_
 */
public class TableIterableBuilder implements Iterable<Table>
{
  private final Database _db;
  private boolean _includeNormalTables = true;
  private boolean _includeSystemTables;
  private boolean _includeLinkedTables = true;
  
  public TableIterableBuilder(Database db) {
    _db = db;
  }

  public boolean isIncludeNormalTables() {
    return _includeNormalTables;
  }
  
  public boolean isIncludeSystemTables() {
    return _includeSystemTables;
  }
  
  public boolean isIncludeLinkedTables() {
    return _includeLinkedTables;
  }
  
  public TableIterableBuilder setIncludeNormalTables(boolean includeNormalTables) {
    _includeNormalTables = includeNormalTables;
    return this;
  }
  
  public TableIterableBuilder setIncludeSystemTables(boolean includeSystemTables) {
    _includeSystemTables = includeSystemTables;
    return this;
  }

  public TableIterableBuilder setIncludeLinkedTables(boolean includeLinkedTables) {
    _includeLinkedTables = includeLinkedTables;
    return this;
  }

  /**
   * Convenience method to set the flags to include only non-linked (local)
   * user tables.
   */
  public TableIterableBuilder withLocalUserTablesOnly() {
    setIncludeNormalTables(true);
    setIncludeSystemTables(false);
    return setIncludeLinkedTables(false);
  }
  
  /**
   * Convenience method to set the flags to include only system tables.
   */
  public TableIterableBuilder withSystemTablesOnly() {
    setIncludeNormalTables(false);
    setIncludeSystemTables(true);
    return setIncludeLinkedTables(false);
  }
  
  public Iterator<Table> iterator() {
    return ((DatabaseImpl)_db).iterator(this);
  }
}