    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.

##

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

##

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

##

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

  Verify that this node is correct (ie.

##

IndexColumnName

     protected String IndexColumnName

  The name of this index column.

RegisteredName

     public static final String RegisteredName

  The element type name normally used in XML for this sort of element.

NameAttName

     public static final String NameAttName

  The name of the attribute which holds the name of this column.

SortSequenceAttName

     public static final String SortSequenceAttName

  The name of the attribute which holds the sort sequence of this column.

##

da_IndexColumnElement

     public da_IndexColumnElement()

  Construct an index column element with no name.

da_IndexColumnElement

     public da_IndexColumnElement(String InputNodeName)

  Construct an index column element with a name.

  Parameters:
    InputNodeName - The name of the element

##

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

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

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