com.sptci.rwt
Class IndexMetaData

java.lang.Object
  com.sptci.rwt.MetaData
      com.sptci.rwt.KeyMetaData
          com.sptci.rwt.IndexMetaData

All Implemented Interfaces:

Serializable

public class IndexMetaData
extends KeyMetaData

A metadata object that represents table indices.

© Copyright 2007 Sans Pareil Technologies, Inc.

Version:

$Id: IndexMetaData.java 4123 2008-05-25 21:49:01Z rakesh $

Author:

Rakesh Vidyadharan 2007-09-26

See Also:

Serialized Form

Nested Class Summary

static class	IndexMetaData.SortSequence An enumerationg for the sort sequence of indices.
static class	IndexMetaData.Type An enumeration for the index types.

Field Summary

private int	cardinality The cardinality for the index.
private int	pages The number of pages used for the index.
private IndexMetaData.SortSequence	sortSequence A field indicating the sort order used by the index.
private IndexMetaData.Type	type A field indicating the type of the index.
private boolean	unique A flag indicating whether this index represents unique values or not.

Constructor Summary

IndexMetaData()

Method Summary

int	getCardinality() Returns cardinality.
int	getPages() Returns pages.
String	getSortSequence() Returns sortSequence.
String	getType() Returns type.
boolean	getUnique() Returns unique.
boolean	isUnique() Returns unique.
protected void	setCardinality(int cardinality) Set cardinality.
protected void	setPages(int pages) Set pages.
protected void	setSortSequence(IndexMetaData.SortSequence sortSequence) Set sortSequence.
protected void	setType(IndexMetaData.Type type) Set type.
protected void	setUnique(boolean unique) Set unique.

Methods inherited from class com.sptci.rwt.KeyMetaData

addColumn, getColumns, getKeySequence, getTable, setColumns, setKeySequence, setTable

Methods inherited from class com.sptci.rwt.MetaData

equals, getName, hashCode, setName, toString

Methods inherited from class java.lang.Object

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

Field Detail

unique

private boolean unique

A flag indicating whether this index represents unique values or not.

type

private IndexMetaData.Type type

A field indicating the type of the index.

sortSequence

private IndexMetaData.SortSequence sortSequence

A field indicating the sort order used by the index.

cardinality

private int cardinality

The cardinality for the index. When type is IndexMetaData.Type.Statistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.

pages

private int pages

The number of pages used for the index. When type is IndexMetaData.Type.Statistic, then this is the number of pages used for the table; otherwise, it is the number of pages used for the index.

Constructor Detail

IndexMetaData

public IndexMetaData()

Method Detail

isUnique

public boolean isUnique()

Returns unique.

Returns:

The value/reference of/to unique.

getUnique

public boolean getUnique()

Returns unique.

Returns:

The value/reference of/to unique.

setUnique

protected void setUnique(boolean unique)

Set unique.

Parameters:

unique - The value to set.

getType

public String getType()

Returns type.

Returns:

The value/reference of/to type.

setType

protected void setType(IndexMetaData.Type type)

Set type.

Parameters:

type - The value to set.

getSortSequence

public String getSortSequence()

Returns sortSequence.

Returns:

The value/reference of/to sortSequence.

setSortSequence

protected void setSortSequence(IndexMetaData.SortSequence sortSequence)

Set sortSequence.

Parameters:

sortSequence - The value to set.

getCardinality

public int getCardinality()

Returns cardinality.

Returns:

The value/reference of/to cardinality.

setCardinality

protected void setCardinality(int cardinality)

Set cardinality.

Parameters:

cardinality - The value to set.

getPages

public int getPages()

Returns pages.

Returns:

The value/reference of/to pages.

setPages

protected void setPages(int pages)

Set pages.

Parameters:

pages - The value to set.