All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class da.da_IndexColumnElement

java.lang.Object
   |
   +----com.sun.java.swing.tree.DefaultMutableTreeNode
           |
           +----xg.xg_Node
                   |
                   +----xg.xg_Element
                           |
                           +----da.da_IndexColumnElement

public class da_IndexColumnElement
extends xg_Element
An XML element to represent the structure of one column in the index of a database table.


Variable Index

 o IndexColumnName
The name of this index column.
 o NameAttName
The name of the attribute which holds the name of this column.
 o RegisteredName
The element type name normally used in XML for this sort of element.
 o SortSequenceAttName
The name of the attribute which holds the sort sequence of this column.

Constructor Index

 o da_IndexColumnElement()
Construct an index column element with no name.
 o da_IndexColumnElement(String)
Construct an index column element with a name.

Method Index

 o analyseIndexColumn(ResultSet)
Set up this index column, based on the InputIndexesResultSet.
 o toString()
Get a summary descriptive string suitable for display in the tree view or elsewhere.
 o verify()

Verify that this node is correct (ie.

Variables

 o IndexColumnName
 protected String IndexColumnName
The name of this index column.

 o RegisteredName
 public static final String RegisteredName
The element type name normally used in XML for this sort of element.

 o NameAttName
 public static final String NameAttName
The name of the attribute which holds the name of this column.

 o SortSequenceAttName
 public static final String SortSequenceAttName
The name of the attribute which holds the sort sequence of this column.

Constructors

 o da_IndexColumnElement
 public da_IndexColumnElement()
Construct an index column element with no name.

 o da_IndexColumnElement
 public da_IndexColumnElement(String InputNodeName)
Construct an index column element with a name.

Parameters:
InputNodeName - The name of the element

Methods

 o verify
 public void verify() throws xg_VerificationException

Verify that this node is correct (ie. internally correct and/or consistent with other nodes - such as its parent). The node is OK if it possesses a 'Name' attribute.

Throws: xg_VerificationException
Description of verification problem
Overrides:
verify in class xg_Node
 o analyseIndexColumn
 public void analyseIndexColumn(ResultSet InputIndexesResultSet)
Set up this index column, based on the InputIndexesResultSet.

Parameters:
InputIndexesResultSet - the result set from which to obtain details about the index column we represent
 o toString
 public String toString()
Get a summary descriptive string suitable for display in the tree view or elsewhere.

Returns:
A description suitable for display in the tree view
Overrides:
toString in class xg_Element

All Packages  Class Hierarchy  This Package  Previous  Next  Index