org.apache.ddlutils.model
Class IndexColumn

java.lang.Object
  org.apache.ddlutils.model.IndexColumn

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class IndexColumn
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Represents a column of an index in the database model.

Version:

$Revision: 504014 $

See Also:

Serialized Form

Field Summary

protected java.lang.String	_name The name of the column.
protected java.lang.String	_size The size of the column in the index.

Constructor Summary

IndexColumn()
Creates a new index column object.

IndexColumn(Column column)
Creates a new index column object.

IndexColumn(java.lang.String columnName)
Creates a new index column object.

Method Summary

java.lang.Object	clone()
boolean	equals(java.lang.Object obj)
boolean	equalsIgnoreCase(IndexColumn other) Compares this index column to the given one while ignoring the case of identifiers.
Column	getColumn() Returns the indexed column.
java.lang.String	getName() Returns the name of the column.
int	getOrdinalPosition() Returns the position within the owning index.
java.lang.String	getSize() Returns the size of the column in the index.
int	hashCode()
void	setColumn(Column column) Sets the indexed column.
void	setName(java.lang.String name) Sets the name of the column.
void	setOrdinalPosition(int position) Sets the position within the owning index.
void	setSize(java.lang.String size) Sets the size of the column in the index.
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_name

protected java.lang.String _name

The name of the column.

_size

protected java.lang.String _size

The size of the column in the index.

Constructor Detail

IndexColumn

public IndexColumn()

Creates a new index column object.

IndexColumn

public IndexColumn(Column column)

Creates a new index column object.

Parameters:

column - The indexed column

IndexColumn

public IndexColumn(java.lang.String columnName)

Creates a new index column object.

Parameters:

columnName - The name of the corresponding table column

Method Detail

getOrdinalPosition

public int getOrdinalPosition()

Returns the position within the owning index.

Returns:

The position

setOrdinalPosition

public void setOrdinalPosition(int position)

Sets the position within the owning index. Please note that you should not change the value once the column has been added to a index.

Parameters:

position - The position

getName

public java.lang.String getName()

Returns the name of the column.

Returns:

The name

setName

public void setName(java.lang.String name)

Sets the name of the column.

Parameters:

name - The name

getColumn

public Column getColumn()

Returns the indexed column.

Returns:

The column

setColumn

public void setColumn(Column column)

Sets the indexed column.

Parameters:

column - The column

getSize

public java.lang.String getSize()

Returns the size of the column in the index.

Returns:

The size

setSize

public void setSize(java.lang.String size)

Sets the size of the column in the index.

Parameters:

size - The size

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equalsIgnoreCase

public boolean equalsIgnoreCase(IndexColumn other)

Compares this index column to the given one while ignoring the case of identifiers.

Parameters:

other - The other index column

Returns:

true if this index column is equal (ignoring case) to the given one

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object