Package org.jumpmind.db.model

Class IndexImpBase

java.lang.Object

org.jumpmind.db.model.IndexImpBase

All Implemented Interfaces:

Serializable, Cloneable, IIndex

Direct Known Subclasses:

NonUniqueIndex, UniqueIndex

public abstract class IndexImpBase
extends Object
implements IIndex

Base class for indices.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayList<IndexColumn>	columns	The columns making up the index.
protected ArrayList<IndexColumn>	includedColumns
protected String	name	The name of the index.
protected Map<String,PlatformIndex>	platformIndexes

Constructor Summary

Constructors

Constructor	Description
IndexImpBase()

Method Summary

Modifier and Type	Method	Description
void	addColumn(IndexColumn column)	Adds a column that makes up this index.
void	addIncludedColumn(IndexColumn column)
void	addPlatformIndex(PlatformIndex platformIndex)
abstract Object	clone()	Clones this index.
protected void	clonePlatformIndexes(IndexImpBase indexImpBase)
PlatformIndex	findPlatformIndex(PlatformIndex platformIndex)
IndexColumn	getColumn(int idx)	Returns the indicated column making up this index.
int	getColumnCount()	Returns the number of columns that make up this index.
IndexColumn[]	getColumns()	Returns the columns that make up this index.
IndexColumn	getIncludedColumn(int idx)
int	getIncludedColumnCount()
IndexColumn[]	getIncludedColumns()
String	getName()	Returns the name of the index.
Map<String,PlatformIndex>	getPlatformIndexes()
boolean	hasAllPrimaryKeys()
boolean	hasColumn(Column column)	Determines whether this index includes the given column.
boolean	hasIncludedColumn(Column column)
void	removeColumn(int idx)	Removes the column at the specified position in this index.
void	removeColumn(IndexColumn column)	Removes the given index column from this index.
void	removePlatformIndex(PlatformIndex platformIndex)
void	setName(String name)	Sets the name of the index.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jumpmind.db.model.IIndex

equalsIgnoreCase, isUnique, toVerboseString

Field Details

name

protected String name

The name of the index.

columns

protected ArrayList<IndexColumn> columns

The columns making up the index.

includedColumns

protected ArrayList<IndexColumn> includedColumns

platformIndexes

protected Map<String,PlatformIndex> platformIndexes

Constructor Details

IndexImpBase

public IndexImpBase()

Method Details

getName

public String getName()

Description copied from interface: IIndex

Returns the name of the index.

Specified by:

getName in interface IIndex

Returns:

The name

setName

public void setName(String name)

Description copied from interface: IIndex

Sets the name of the index.

Specified by:

setName in interface IIndex

Parameters:

name - The name

getColumnCount

public int getColumnCount()

Description copied from interface: IIndex

Returns the number of columns that make up this index.

Specified by:

getColumnCount in interface IIndex

Returns:

The number of index columns

getColumn

public IndexColumn getColumn(int idx)

Description copied from interface: IIndex

Returns the indicated column making up this index.

Specified by:

getColumn in interface IIndex

Parameters:

idx - The index of the column

Returns:

The column

getColumns

public IndexColumn[] getColumns()

Description copied from interface: IIndex

Returns the columns that make up this index.

Specified by:

getColumns in interface IIndex

Returns:

The columns

hasColumn

public boolean hasColumn(Column column)

Description copied from interface: IIndex

Determines whether this index includes the given column.

Specified by:

hasColumn in interface IIndex

Parameters:

column - The column to check for

Returns:

true if the column is included in this index

addColumn

public void addColumn(IndexColumn column)

Description copied from interface: IIndex

Adds a column that makes up this index.

Specified by:

addColumn in interface IIndex

Parameters:

column - The column to add

removeColumn

public void removeColumn(IndexColumn column)

Description copied from interface: IIndex

Removes the given index column from this index.

Specified by:

removeColumn in interface IIndex

Parameters:

column - The column to remove

removeColumn

public void removeColumn(int idx)

Description copied from interface: IIndex

Removes the column at the specified position in this index.

Specified by:

removeColumn in interface IIndex

Parameters:

idx - The position of the index column to remove

getIncludedColumnCount

public int getIncludedColumnCount()

Specified by:

getIncludedColumnCount in interface IIndex

getIncludedColumn

public IndexColumn getIncludedColumn(int idx)

Specified by:

getIncludedColumn in interface IIndex

getIncludedColumns

public IndexColumn[] getIncludedColumns()

Specified by:

getIncludedColumns in interface IIndex

hasIncludedColumn

public boolean hasIncludedColumn(Column column)

Specified by:

hasIncludedColumn in interface IIndex

addIncludedColumn

public void addIncludedColumn(IndexColumn column)

Specified by:

addIncludedColumn in interface IIndex

clone

public abstract Object clone()
                      throws CloneNotSupportedException

Description copied from interface: IIndex

Clones this index.

Specified by:

clone in interface IIndex

Overrides:

clone in class Object

Returns:

The clone

Throws:

CloneNotSupportedException - If the cloning did fail

hasAllPrimaryKeys

public boolean hasAllPrimaryKeys()

Specified by:

hasAllPrimaryKeys in interface IIndex

removePlatformIndex

public void removePlatformIndex(PlatformIndex platformIndex)

Specified by:

removePlatformIndex in interface IIndex

addPlatformIndex

public void addPlatformIndex(PlatformIndex platformIndex)

Specified by:

addPlatformIndex in interface IIndex

getPlatformIndexes

public Map<String,PlatformIndex> getPlatformIndexes()

Specified by:

getPlatformIndexes in interface IIndex

findPlatformIndex

public PlatformIndex findPlatformIndex(PlatformIndex platformIndex)

Specified by:

findPlatformIndex in interface IIndex

clonePlatformIndexes

protected void clonePlatformIndexes(IndexImpBase indexImpBase)
                             throws CloneNotSupportedException

Throws:

CloneNotSupportedException