Module org.tentackle.sql

Package org.tentackle.sql.metadata

Class IndexColumnMetaData

java.lang.Object

org.tentackle.sql.metadata.IndexColumnMetaData

All Implemented Interfaces:

java.lang.Comparable<IndexColumnMetaData>

Direct Known Subclasses:

PostgresIndexColumnMetaData

public class IndexColumnMetaData
extends java.lang.Object
implements java.lang.Comparable<IndexColumnMetaData>

Meta data for a column of an index.

Author:

harald

Constructor Summary

Constructors

Constructor	Description
IndexColumnMetaData(IndexMetaData indexMetaData)	Creates an index column.

Method Summary

Modifier and Type	Method	Description
int	compareTo(IndexColumnMetaData o)
java.lang.String	getColumnName()	Gets the column columnName.
java.lang.String	getFunctionName()	Gets the optional function name.
IndexMetaData	getIndexMetaData()	Gets the index.
int	getPosition()	Gets the ordinal position within the index.
boolean	isDescending()	Returns ascending or descending order.
void	setupIndexColumnFromMetaData(java.sql.ResultSet resultSet)	Sets up the index column from the database meta data result.
java.lang.String	toString()
void	validate()	Validates and postprocesses the index column data.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexColumnMetaData

public IndexColumnMetaData(IndexMetaData indexMetaData)

Creates an index column.

Parameters:

indexMetaData - the index column belongs to

Method Detail

setupIndexColumnFromMetaData

public void setupIndexColumnFromMetaData(java.sql.ResultSet resultSet)
                                  throws java.sql.SQLException

Sets up the index column from the database meta data result.

Parameters:

resultSet - the column result set

Throws:

java.sql.SQLException - the processing the result set failed

getIndexMetaData

public IndexMetaData getIndexMetaData()

Gets the index.

Returns:

index column belongs to

isDescending

public boolean isDescending()

Returns ascending or descending order.

Returns:

true if descending

getColumnName

public java.lang.String getColumnName()

Gets the column columnName.

Returns:

the index column's columnName in lowercase

getFunctionName

public java.lang.String getFunctionName()

Gets the optional function name.

Returns:

the function in uppercase, null if none

getPosition

public int getPosition()

Gets the ordinal position within the index.

Returns:

the position

compareTo

public int compareTo(IndexColumnMetaData o)

Specified by:

compareTo in interface java.lang.Comparable<IndexColumnMetaData>

validate

public void validate()

Validates and postprocesses the index column data.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object