com.healthmarketscience.jackcess

Class TableBuilder

java.lang.Object

com.healthmarketscience.jackcess.TableBuilder

public class TableBuilder
extends java.lang.Object

Builder style class for constructing a Table.

Example:

   Table table = new TableBuilder("Test")
     .addColumn(new ColumnBuilder("ID", DataType.LONG)
                .setAutoNumber(true))
     .addColumn(new ColumnBuilder("Name", DataType.TEXT))
     .addIndex(new IndexBuilder(IndexBuilder.PRIMARY_KEY_NAME)
               .addColumns("ID").setPrimaryKey())
     .toTable(db);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	TableBuilder.ReservedWords

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<ColumnBuilder>	_columns columns for the new table
private boolean	_escapeIdentifiers whether or not table/column/index names are automatically escaped
private java.util.List<IndexBuilder>	_indexes indexes for the new table
private java.lang.String	_name name of the new table
private java.util.Map<java.lang.String,PropertyMap.Property>	_props table properties (if any)
private static java.lang.String	ESCAPE_PREFIX Prefix for column or table names that are reserved words

Constructor Summary

Constructors

Constructor and Description
TableBuilder(java.lang.String name)
TableBuilder(java.lang.String name, boolean escapeIdentifiers)

Method Summary

Modifier and Type	Method and Description
TableBuilder	addColumn(ColumnBuilder column) Adds a Column to the new table.
TableBuilder	addColumns(java.util.Collection<? extends ColumnBuilder> columns) Adds the Columns to the new table.
TableBuilder	addIndex(IndexBuilder index) Adds an IndexBuilder to the new table.
static java.lang.String	escapeIdentifier(java.lang.String s)
TableBuilder	escapeName() Escapes the new table's name using escapeIdentifier(java.lang.String).
static boolean	isReservedWord(java.lang.String s)
TableBuilder	putProperty(java.lang.String name, DataType type, java.lang.Object value) Sets the table property with the given name and type to the given value.
TableBuilder	putProperty(java.lang.String name, java.lang.Object value) Sets the table property with the given name to the given value.
TableBuilder	setEscapeIdentifiers(boolean escapeIdentifiers) Sets whether or not subsequently added columns will have their names automatically escaped
TableBuilder	setPrimaryKey(java.lang.String... colNames) Sets the names of the primary key columns for this table.
Table	toTable(Database db) Creates a new Table in the given Database with the currently configured attributes.

Methods inherited from class java.lang.Object

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

Field Detail

ESCAPE_PREFIX

private static final java.lang.String ESCAPE_PREFIX

Prefix for column or table names that are reserved words

See Also:

Constant Field Values

_name

private java.lang.String _name

name of the new table

_columns

private java.util.List<ColumnBuilder> _columns

columns for the new table

_indexes

private java.util.List<IndexBuilder> _indexes

indexes for the new table

_escapeIdentifiers

private boolean _escapeIdentifiers

whether or not table/column/index names are automatically escaped

_props

private java.util.Map<java.lang.String,PropertyMap.Property> _props

table properties (if any)

Constructor Detail

TableBuilder

public TableBuilder(java.lang.String name)

TableBuilder

public TableBuilder(java.lang.String name,
                    boolean escapeIdentifiers)

Method Detail

addColumn

public TableBuilder addColumn(ColumnBuilder column)

Adds a Column to the new table.

addColumns

public TableBuilder addColumns(java.util.Collection<? extends ColumnBuilder> columns)

Adds the Columns to the new table.

addIndex

public TableBuilder addIndex(IndexBuilder index)

Adds an IndexBuilder to the new table.

setEscapeIdentifiers

public TableBuilder setEscapeIdentifiers(boolean escapeIdentifiers)

Sets whether or not subsequently added columns will have their names automatically escaped

setPrimaryKey

public TableBuilder setPrimaryKey(java.lang.String... colNames)

Sets the names of the primary key columns for this table. Convenience method for creating a primary key index on a table.

escapeName

public TableBuilder escapeName()

Escapes the new table's name using escapeIdentifier(java.lang.String).

putProperty

public TableBuilder putProperty(java.lang.String name,
                                java.lang.Object value)

Sets the table property with the given name to the given value. Attempts to determine the type of the property (see PropertyMap.put(String,Object) for details on determining the property type).

putProperty

public TableBuilder putProperty(java.lang.String name,
                                DataType type,
                                java.lang.Object value)

Sets the table property with the given name and type to the given value.

toTable

public Table toTable(Database db)
              throws java.io.IOException

Creates a new Table in the given Database with the currently configured attributes.

Throws:

java.io.IOException

escapeIdentifier

public static java.lang.String escapeIdentifier(java.lang.String s)

Returns:

A table or column name escaped for Access

isReservedWord

public static boolean isReservedWord(java.lang.String s)

Returns:

true if the given string is a reserved word, false otherwise