com.healthmarketscience.jackcess

Class IndexBuilder

java.lang.Object

com.healthmarketscience.jackcess.IndexBuilder

public class IndexBuilder
extends java.lang.Object

Builder style class for constructing an Index. See TableBuilder for example usage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexBuilder.Column Information about a column in this index (name and ordering).

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<IndexBuilder.Column>	_columns the names and orderings of the indexed columns
private byte	_flags additional index flags (UNKNOWN_INDEX_FLAG always seems to be set in access 2000+)
private java.lang.String	_name name of the new index
private byte	_type the type of the index
static java.lang.String	PRIMARY_KEY_NAME name typically used by MS Access for the primary key index

Constructor Summary

Constructors

Constructor and Description
IndexBuilder(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
IndexBuilder	addColumns(boolean ascending, java.lang.String... names) Adds the columns with the given ordering to the index.
IndexBuilder	addColumns(java.lang.String... names) Adds the columns with ASCENDING ordering to the index.
java.util.List<IndexBuilder.Column>	getColumns()
byte	getFlags()
java.lang.String	getName()
byte	getType()
boolean	isIgnoreNulls()
boolean	isPrimaryKey()
boolean	isUnique()
IndexBuilder	setIgnoreNulls() Sets this index to ignore null values.
IndexBuilder	setName(java.lang.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).
IndexBuilder	setUnique() Sets this index to enforce uniqueness.
void	validate(java.util.Set<java.lang.String> tableColNames, JetFormat format)
private java.lang.String	withErrorContext(java.lang.String msg)

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 java.lang.String PRIMARY_KEY_NAME

name typically used by MS Access for the primary key index

See Also:

Constant Field Values

_name

private java.lang.String _name

name of the new index

_type

private byte _type

the type of the index

_flags

private byte _flags

additional index flags (UNKNOWN_INDEX_FLAG always seems to be set in access 2000+)

_columns

private final java.util.List<IndexBuilder.Column> _columns

the names and orderings of the indexed columns

Constructor Detail

IndexBuilder

public IndexBuilder(java.lang.String name)

Method Detail

getName

public java.lang.String getName()

getType

public byte getType()

getFlags

public byte getFlags()

isPrimaryKey

public boolean isPrimaryKey()

isUnique

public boolean isUnique()

isIgnoreNulls

public boolean isIgnoreNulls()

getColumns

public java.util.List<IndexBuilder.Column> getColumns()

setName

public IndexBuilder setName(java.lang.String name)

Sets the name of the index.

addColumns

public IndexBuilder addColumns(java.lang.String... names)

Adds the columns with ASCENDING ordering to the index.

addColumns

public IndexBuilder addColumns(boolean ascending,
                               java.lang.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).

setUnique

public IndexBuilder setUnique()

Sets this index to enforce uniqueness.

setIgnoreNulls

public IndexBuilder setIgnoreNulls()

Sets this index to ignore null values.

validate

public void validate(java.util.Set<java.lang.String> tableColNames,
                     JetFormat format)

withErrorContext

private java.lang.String withErrorContext(java.lang.String msg)