IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

com.ibm.db2.wrapper
Class IndexInfo

java.lang.Object
  extended by com.ibm.db2.wrapper.CatalogInfo
      extended by com.ibm.db2.wrapper.IndexInfo

public final class IndexInfo
extends CatalogInfo


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

IndexInfo

public IndexInfo()
Class constructor.

Since:
IBM DB2 Information Integrator Version 8.2
Method Detail

addColumn

public void addColumn(java.lang.String colName,
                      int colDir)
Add a column specification to the index specification

Parameters:
colName - The name of the column
colDir - The sort direction for the column
Since:
IBM WebSphere Federation Server Version 9.5fp2

addOption

public void addOption(java.lang.String optionName,
                      java.lang.String optionValue,
                      int action)
               throws WrapperException
Add an option to the options chain.

Parameters:
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.
Throws:
WrapperException - if the option already exists in the chain or if the action is invalid.
Since:
IBM DB2 Information Integrator Version 8.2

getClusterRatio

public short getClusterRatio()
Retrieve the cluster ratio.

Returns:
The cluster ratio value.
Since:
IBM DB2 Information Integrator Version 8.2

getColCount

public int getColCount()
Retrieve the number of columns in the index.

Returns:
The number of columns.
Since:
IBM DB2 Information Integrator Version 8.2

getColDir

public int getColDir(int colIndex)
Retrieve the sort direction of an indexed column.

Parameters:
colIndex - The index of the column
Returns:
The sort direction of the column.
Since:
IBM WebSphere Federation Server Python

getColName

public java.lang.String getColName(int colIndex)
Retrieve the name of an indexed column.

Parameters:
colIndex - The index of the column
Returns:
The name of the column.
Since:
IBM WebSphere Federation Server Version 9.5fp2

getColNames

public java.util.ArrayList getColNames()
Retrieve the names of the indexed columns.

Returns:
The name of the columns.
Since:
IBM DB2 Information Integrator Version 8.2

getFirstKeycard

public long getFirstKeycard()
Retrieve the first key cardinality.

Returns:
The first key cardinality value.
Since:
IBM DB2 Information Integrator Version 8.2

getFullKeycard

public long getFullKeycard()
Retrieve the full key cardinality.

Parameters:
fullKeycard - The full key cardinality.
Since:
IBM DB2 Information Integrator Version 8.2

getIndexName

public java.lang.String getIndexName()
Retrieve the name of the index.

Returns:
The index name.
Since:
IBM DB2 Information Integrator Version 8.2

getNextIndex

public IndexInfo getNextIndex()
Retrieve the next index in the chain.

Returns:
The next index in the chain.
Since:
IBM DB2 Information Integrator Version 8.2

getNLeaf

public int getNLeaf()
Set the number of leafs.

Returns:
The number of leafs.
Since:
IBM DB2 Information Integrator Version 8.2

getNLevels

public short getNLevels()
Retrieve the number of levels.

Returns:
The number of levels.
Since:
IBM DB2 Information Integrator Version 8.2

getPrevIndex

public IndexInfo getPrevIndex()
Retrieve the previous index in the chain.

Returns:
The previous index in the chain.
Since:
IBM DB2 Information Integrator Version 8.2

getUniqueColCount

public short getUniqueColCount()
Retrieve the number of unique columns in the index.

Returns:
The number of unique columns.
Since:
IBM DB2 Information Integrator Version 8.2

getUniqueRule

public byte getUniqueRule()
Retrieve the flag to indicate whether or not the index has a unique rule.

Returns:
The flag that indicates if the index has a unique rule.
Since:
IBM DB2 Information Integrator Version 8.2

isClusterRatioValid

public boolean isClusterRatioValid()
Check to see if the cluster ratio is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isFirstKeycardValid

public boolean isFirstKeycardValid()
Check to see if the first key cardinality is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isFullKeycardValid

public boolean isFullKeycardValid()
Check to see if the full key cardinality is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isIndexNameValid

public boolean isIndexNameValid()
Check to see if an index name is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isNLeafValid

public boolean isNLeafValid()
Check to see if the number of leafs is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isNLevelsValid

public boolean isNLevelsValid()
Check to see if the number of levels is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isUniqueColCountValid

public boolean isUniqueColCountValid()
Check to see if the number of unique columns is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isUniqueRuleValid

public boolean isUniqueRuleValid()
Check to see if the unique rule flag is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

setClusterRatio

public void setClusterRatio(short clusterRatio)
Set the cluster ratio.

Parameters:
clusterRatio - The cluster ratio value.
Since:
IBM DB2 Information Integrator Version 8.2

setColNames

public void setColNames(java.util.ArrayList colNames)
Set the names of the indexed columns.

Parameters:
colNames - The name of the columns.
Since:
IBM DB2 Information Integrator Version 8.2

setFirstKeycard

public void setFirstKeycard(long firstKeycard)
Set the first key cardinality.

Parameters:
firstKeycard - The first key cardinality value.
Since:
IBM DB2 Information Integrator Version 8.2

setFullKeycard

public void setFullKeycard(long fullKeycard)
Set the full key cardinality.

Parameters:
fullKeycard - The full key cardinality value.
Since:
IBM DB2 Information Integrator Version 8.2

setIndexName

public void setIndexName(java.lang.String indexName)
Set the name of the index.

Parameters:
indexName - The name.
Since:
IBM DB2 Information Integrator Version 8.2

setNextIndex

public void setNextIndex(IndexInfo nextIndex)
Set the next index in the chain.

Parameters:
nextIndex - The next index in the chain.
Since:
IBM DB2 Information Integrator Version 8.2

setNLeaf

public void setNLeaf(int nLeaf)
Set the number of leafs.

Parameters:
nLeaf - The number of leafs.
Since:
IBM DB2 Information Integrator Version 8.2

setNLevels

public void setNLevels(short nLevels)
Set the number of levels.

Parameters:
nLevels - The number of levels.
Since:
IBM DB2 Information Integrator Version 8.2

setPrevIndex

public void setPrevIndex(IndexInfo indexInfo)
Set the previous index in the chain.

Parameters:
prevIndex - The previous index in the chain.
Since:
IBM DB2 Information Integrator Version 8.2

setUniqueColCount

public void setUniqueColCount(short uniqueColCount)
Set the number of unique columns in the index.

Parameters:
colCount - The number of unique columns.
Since:
IBM DB2 Information Integrator Version 8.2

setUniqueRule

public void setUniqueRule(byte uniqueRule)
Set the flag to indicate whether or not the index has a unique rule.

Parameters:
uniqueRule - The flag that indicates a unique rule.
Since:
IBM DB2 Information Integrator Version 8.2

IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

(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.