    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class da.da_IndexElement

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

public class da_IndexElement
extends xg_Element

An XML element to represent the structure of one index of a database table.

##

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

##

da_IndexElement()
  Construct a database table indexes element with no name.
da_IndexElement(String)
  Construct a database table indexes element with a name.

##

addIndexColumn(ResultSet)
  Add an column to this index, based on the InputIndexesResultSet.
setIndexName(String)
  Set the name of this index.
toString()
  Get a summary descriptive string suitable for display in the tree view or elsewhere.
verify()

  Verify that this node is correct (ie.

##

IndexName

     protected String IndexName

  The name of this index.

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

##

da_IndexElement

     public da_IndexElement()

  Construct a database table indexes element with no name.

da_IndexElement

     public da_IndexElement(String InputNodeName)

  Construct a database table indexes 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

setIndexName

     public void setIndexName(String InputIndexName)

  Set the name of this index.

  Parameters:
    InputIndexName - the name of this index (which we assume has already been read from InputIndexesResultSet)

addIndexColumn

     public void addIndexColumn(ResultSet InputIndexesResultSet)

  Add an column to this index, based on the InputIndexesResultSet.

  Parameters:
    InputIndexesResultSet - the result set from which to obtain details about the index 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