|
IBM DB2 Information Integrator Java API Reference for Developing Wrappers |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.db2.wrapper.CatalogInfo
com.ibm.db2.wrapper.IndexInfo
public final class IndexInfo
Constructor Summary | |
---|---|
IndexInfo()
Class constructor. |
Method Summary | |
---|---|
void |
addColumn(java.lang.String colName,
int colDir)
Add a column specification to the index specification |
void |
addOption(java.lang.String optionName,
java.lang.String optionValue,
int action)
Add an option to the options chain. |
short |
getClusterRatio()
Retrieve the cluster ratio. |
int |
getColCount()
Retrieve the number of columns in the index. |
int |
getColDir(int colIndex)
Retrieve the sort direction of an indexed column. |
java.lang.String |
getColName(int colIndex)
Retrieve the name of an indexed column. |
java.util.ArrayList |
getColNames()
Retrieve the names of the indexed columns. |
long |
getFirstKeycard()
Retrieve the first key cardinality. |
long |
getFullKeycard()
Retrieve the full key cardinality. |
java.lang.String |
getIndexName()
Retrieve the name of the index. |
IndexInfo |
getNextIndex()
Retrieve the next index in the chain. |
int |
getNLeaf()
Set the number of leafs. |
short |
getNLevels()
Retrieve the number of levels. |
IndexInfo |
getPrevIndex()
Retrieve the previous index in the chain. |
short |
getUniqueColCount()
Retrieve the number of unique columns in the index. |
byte |
getUniqueRule()
Retrieve the flag to indicate whether or not the index has a unique rule. |
boolean |
isClusterRatioValid()
Check to see if the cluster ratio is specified. |
boolean |
isFirstKeycardValid()
Check to see if the first key cardinality is specified. |
boolean |
isFullKeycardValid()
Check to see if the full key cardinality is specified. |
boolean |
isIndexNameValid()
Check to see if an index name is specified. |
boolean |
isNLeafValid()
Check to see if the number of leafs is specified. |
boolean |
isNLevelsValid()
Check to see if the number of levels is specified. |
boolean |
isUniqueColCountValid()
Check to see if the number of unique columns is specified. |
boolean |
isUniqueRuleValid()
Check to see if the unique rule flag is specified. |
void |
setClusterRatio(short clusterRatio)
Set the cluster ratio. |
void |
setColNames(java.util.ArrayList colNames)
Set the names of the indexed columns. |
void |
setFirstKeycard(long firstKeycard)
Set the first key cardinality. |
void |
setFullKeycard(long fullKeycard)
Set the full key cardinality. |
void |
setIndexName(java.lang.String indexName)
Set the name of the index. |
void |
setNextIndex(IndexInfo nextIndex)
Set the next index in the chain. |
void |
setNLeaf(int nLeaf)
Set the number of leafs. |
void |
setNLevels(short nLevels)
Set the number of levels. |
void |
setPrevIndex(IndexInfo indexInfo)
Set the previous index in the chain. |
void |
setUniqueColCount(short uniqueColCount)
Set the number of unique columns in the index. |
void |
setUniqueRule(byte uniqueRule)
Set the flag to indicate whether or not the index has a unique rule. |
Methods inherited from class com.ibm.db2.wrapper.CatalogInfo |
---|
addOption, dropOption, getFirstOption, getNextOption, getOption |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IndexInfo()
Method Detail |
---|
public void addColumn(java.lang.String colName, int colDir)
colName
- The name of the columncolDir
- The sort direction for the columnpublic void addOption(java.lang.String optionName, java.lang.String optionValue, int action) throws WrapperException
optionName
- The name of the option.optionValue
- The value of the option.action
- The action flag for the option.
Valid actions for the options are specified in CatalogOption
class.
WrapperException
- if the option already exists in the chain or if the action is invalid.public short getClusterRatio()
public int getColCount()
public int getColDir(int colIndex)
colIndex
- The index of the column
public java.lang.String getColName(int colIndex)
colIndex
- The index of the column
public java.util.ArrayList getColNames()
public long getFirstKeycard()
public long getFullKeycard()
fullKeycard
- The full key cardinality.public java.lang.String getIndexName()
public IndexInfo getNextIndex()
public int getNLeaf()
public short getNLevels()
public IndexInfo getPrevIndex()
public short getUniqueColCount()
public byte getUniqueRule()
public boolean isClusterRatioValid()
public boolean isFirstKeycardValid()
public boolean isFullKeycardValid()
public boolean isIndexNameValid()
public boolean isNLeafValid()
public boolean isNLevelsValid()
public boolean isUniqueColCountValid()
public boolean isUniqueRuleValid()
public void setClusterRatio(short clusterRatio)
clusterRatio
- The cluster ratio value.public void setColNames(java.util.ArrayList colNames)
colNames
- The name of the columns.public void setFirstKeycard(long firstKeycard)
firstKeycard
- The first key cardinality value.public void setFullKeycard(long fullKeycard)
fullKeycard
- The full key cardinality value.public void setIndexName(java.lang.String indexName)
indexName
- The name.public void setNextIndex(IndexInfo nextIndex)
nextIndex
- The next index in the chain.public void setNLeaf(int nLeaf)
nLeaf
- The number of leafs.public void setNLevels(short nLevels)
nLevels
- The number of levels.public void setPrevIndex(IndexInfo indexInfo)
prevIndex
- The previous index in the chain.public void setUniqueColCount(short uniqueColCount)
colCount
- The number of unique columns.public void setUniqueRule(byte uniqueRule)
uniqueRule
- The flag that indicates a unique rule.
|
IBM DB2 Information Integrator Java API Reference for Developing Wrappers |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
(C)Copyright IBM Corp. 2002. All rights reserved.
Links on this page are made available for your convenience and may take you to non-IBM sites. IBM does not warrant any sample code provided on these sites.