DODS 7.6 API

org.enhydra.dods.trans
Class Index

java.lang.Object
  extended by org.enhydra.dods.trans.Index

public class Index
extends java.lang.Object

This class represents index object.


Field Summary
protected  boolean clustered
          This variable contains information weather index is clustered.
protected  java.lang.String id
          id of index
protected  java.util.ArrayList incIndexColumn
          list of included indexed columns
protected  java.util.ArrayList indColumn
          list of indexed columns
protected  boolean unique
          This variable contains information weather index is unique.
 
Constructor Summary
Index()
          default constructor
Index(java.lang.String id, boolean unique)
          Constructor (String, boolean)
 
Method Summary
 void addIncludeIndexColumn(java.lang.String id)
          Add indexed column that extends index.
 void addIndexColumn(java.lang.String id)
          Add indexed column.
 java.lang.String id()
          Get index id
 void id(java.lang.String id)
          Set index id.
 int incColumnsSize()
          Get number of included indexed columns.
 java.lang.String includedColumn(int index)
          Get included indexed column with appropriate index.
 java.util.ArrayList includeIndexColumns()
          Get indexed columns that extends index.
 java.lang.String indexColumn(int index)
          Get indexed column with appropriate index.
 java.util.ArrayList indexColumns()
          Get indexed columns.
 boolean isClustered()
          Get information whether column is clustered.
 void isClustered(boolean clustered)
          Set index to/not to be clustered.
 boolean isUnique()
          Get information whether column is unique.
 void isUnique(boolean unique)
          Set index to/not to be unique.
static void main(java.lang.String[] args)
           
 int size()
          Get number of indexed columns.
 java.lang.String toString()
          Get String representation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

indColumn

protected java.util.ArrayList indColumn
list of indexed columns


incIndexColumn

protected java.util.ArrayList incIndexColumn
list of included indexed columns


id

protected java.lang.String id
id of index


unique

protected boolean unique
This variable contains information weather index is unique. True - is unique. False - is not unique.


clustered

protected boolean clustered
This variable contains information weather index is clustered. True - is clustered. False - is not clustered.

Constructor Detail

Index

public Index()
default constructor


Index

public Index(java.lang.String id,
             boolean unique)
Constructor (String, boolean)

Parameters:
id - Index id.
unique - True if index is unique, otherwise false.
Method Detail

id

public void id(java.lang.String id)
Set index id.

Parameters:
id - Index id.

isUnique

public void isUnique(boolean unique)
Set index to/not to be unique.

Parameters:
unique - True if index is unique, otherwise false.

isClustered

public void isClustered(boolean clustered)
Set index to/not to be clustered.

Parameters:
clustered - True if index is clustered, otherwise false.

addIndexColumn

public void addIndexColumn(java.lang.String id)
Add indexed column.

Parameters:
id - Indexed column's id.

addIncludeIndexColumn

public void addIncludeIndexColumn(java.lang.String id)
Add indexed column that extends index.

Parameters:
id - Indexed column's id.

size

public int size()
Get number of indexed columns.

Returns:
Number of indexed columns.

incColumnsSize

public int incColumnsSize()
Get number of included indexed columns.

Returns:
Number of included indexed columns.

id

public java.lang.String id()
Get index id

Returns:
Index id.

isUnique

public boolean isUnique()
Get information whether column is unique.

Returns:
True if column is unique, otherwise false.

isClustered

public boolean isClustered()
Get information whether column is clustered.

Returns:
True if column is clustered, otherwise false.

indexColumns

public java.util.ArrayList indexColumns()
Get indexed columns.

Returns:
Indexed columns.

includeIndexColumns

public java.util.ArrayList includeIndexColumns()
Get indexed columns that extends index.

Returns:
Included indexed columns.

indexColumn

public java.lang.String indexColumn(int index)
Get indexed column with appropriate index.

Parameters:
index - Index of indexed column.
Returns:
Id of indexed column.

includedColumn

public java.lang.String includedColumn(int index)
Get included indexed column with appropriate index.

Parameters:
index - Index of included indexed column.
Returns:
Id of included indexed column.

toString

public java.lang.String toString()
Get String representation.

Overrides:
toString in class java.lang.Object
Returns:
String representation.

main

public static void main(java.lang.String[] args)

DODS 7.6 API