com.healthmarketscience.jackcess
Class IndexBuilder

java.lang.Object
  com.healthmarketscience.jackcess.IndexBuilder

public class IndexBuilder
extends Object

Builder style class for constructing an Index. See TableBuilder for example usage. Additionally, an Index can be added to an existing Table using the addToTable(Table) method.

Author:

James Ahlborn

See Also:

TableBuilder

Nested Class Summary

static class

IndexBuilder.Column Information about a column in this index (name and ordering).

Field Summary

static String

PRIMARY_KEY_NAME name typically used by MS Access for the primary key index

Constructor Summary

IndexBuilder(String name)

Method Summary

IndexBuilder	addColumns(boolean ascending, String... names) Adds the columns with the given ordering to the index.
IndexBuilder	addColumns(String... names) Adds the columns with ASCENDING ordering to the index.
Index	addToTable(Table table) Adds a new Index to the given Table with the currently configured attributes.
List<IndexBuilder.Column>	getColumns()
byte	getFlags()
int	getIndexNumber()
String	getName()
byte	getType()
boolean	isIgnoreNulls()
boolean	isPrimaryKey()
boolean	isUnique()
IndexBuilder	setIgnoreNulls() Sets this index to ignore null values.
void	setIndexNumber(int newIndexNumber)
IndexBuilder	setName(String name) Sets the name of the index.
IndexBuilder	setPrimaryKey() Sets this index to be a primary key index (additionally sets the index as unique and required).
IndexBuilder	setRequired() Sets this index to encforce required.
IndexBuilder	setType(byte type)
IndexBuilder	setUnique() Sets this index to enforce uniqueness.
void	validate(Set<String> tableColNames, JetFormat format) Checks that this index definition is valid.

Methods inherited from class java.lang.Object

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

Field Detail

PRIMARY_KEY_NAME

public static final String PRIMARY_KEY_NAME

name typically used by MS Access for the primary key index

See Also:

Constant Field Values

Constructor Detail

IndexBuilder

public IndexBuilder(String name)

Method Detail

getName

public String getName()

getType

public byte getType()

getFlags

public byte getFlags()

isPrimaryKey

public boolean isPrimaryKey()

isUnique

public boolean isUnique()

isIgnoreNulls

public boolean isIgnoreNulls()

getColumns

public List<IndexBuilder.Column> getColumns()

setName

public IndexBuilder setName(String name)

Sets the name of the index.

addColumns

public IndexBuilder addColumns(String... names)

Adds the columns with ASCENDING ordering to the index.

addColumns

public IndexBuilder addColumns(boolean ascending,
                               String... names)

Adds the columns with the given ordering to the index.

setPrimaryKey

public IndexBuilder setPrimaryKey()

Sets this index to be a primary key index (additionally sets the index as unique and required).

setType

public IndexBuilder setType(byte type)

setUnique

public IndexBuilder setUnique()

Sets this index to enforce uniqueness.

setRequired

public IndexBuilder setRequired()

Sets this index to encforce required.

setIgnoreNulls

public IndexBuilder setIgnoreNulls()

Sets this index to ignore null values.

getIndexNumber

public int getIndexNumber()

setIndexNumber

public void setIndexNumber(int newIndexNumber)

validate

public void validate(Set<String> tableColNames,
                     JetFormat format)

Checks that this index definition is valid.

Throws:

IllegalArgumentException - if this index definition is invalid.

addToTable

public Index addToTable(Table table)
                 throws IOException

Adds a new Index to the given Table with the currently configured attributes.

Throws:

IOException