org.exolab.jms.tools.db
Class Index

java.lang.Object
  extended by org.exolab.jms.tools.db.Index
All Implemented Interfaces:
java.io.Serializable

public class Index
extends java.lang.Object
implements java.io.Serializable

This element specifies an index on a table

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
Index()
           
 
Method Summary
 void addColumn(Column vColumn)
          Method addColumn
 void addColumn(int index, Column vColumn)
          Method addColumn
 void clearColumn()
          Method clearColumn
 void deleteUnique()
          Method deleteUnique
 java.util.Enumeration enumerateColumn()
          Method enumerateColumn
 Column[] getColumn()
          Method getColumn
 Column getColumn(int index)
          Method getColumn
 int getColumnCount()
          Method getColumnCount
 java.lang.String getName()
          Returns the value of field 'name'.
 boolean getUnique()
          Returns the value of field 'unique'.
 boolean hasUnique()
          Method hasUnique
 boolean isValid()
          Method isValid
 void marshal(org.xml.sax.ContentHandler handler)
          Method marshal
 void marshal(java.io.Writer out)
          Method marshal
 boolean removeColumn(Column vColumn)
          Method removeColumn
 void setColumn(Column[] columnArray)
          Method setColumn
 void setColumn(int index, Column vColumn)
          Method setColumn
 void setName(java.lang.String name)
          Sets the value of field 'name'.
 void setUnique(boolean unique)
          Sets the value of field 'unique'.
static java.lang.Object unmarshal(java.io.Reader reader)
          Method unmarshal
 void validate()
          Method validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Index

public Index()
Method Detail

addColumn

public void addColumn(Column vColumn)
               throws java.lang.IndexOutOfBoundsException
Method addColumn

Parameters:
vColumn -
Throws:
java.lang.IndexOutOfBoundsException

addColumn

public void addColumn(int index,
                      Column vColumn)
               throws java.lang.IndexOutOfBoundsException
Method addColumn

Parameters:
index -
vColumn -
Throws:
java.lang.IndexOutOfBoundsException

clearColumn

public void clearColumn()
Method clearColumn


deleteUnique

public void deleteUnique()
Method deleteUnique


enumerateColumn

public java.util.Enumeration enumerateColumn()
Method enumerateColumn

Returns:
Enumeration

getColumn

public Column getColumn(int index)
                 throws java.lang.IndexOutOfBoundsException
Method getColumn

Parameters:
index -
Returns:
Column
Throws:
java.lang.IndexOutOfBoundsException

getColumn

public Column[] getColumn()
Method getColumn

Returns:
Column

getColumnCount

public int getColumnCount()
Method getColumnCount

Returns:
int

getName

public java.lang.String getName()
Returns the value of field 'name'.

Returns:
String

getUnique

public boolean getUnique()
Returns the value of field 'unique'.

Returns:
boolean

hasUnique

public boolean hasUnique()
Method hasUnique

Returns:
boolean

isValid

public boolean isValid()
Method isValid

Returns:
boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Method marshal

Parameters:
out -
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Method marshal

Parameters:
handler -
Throws:
java.io.IOException
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

removeColumn

public boolean removeColumn(Column vColumn)
Method removeColumn

Parameters:
vColumn -
Returns:
boolean

setColumn

public void setColumn(int index,
                      Column vColumn)
               throws java.lang.IndexOutOfBoundsException
Method setColumn

Parameters:
index -
vColumn -
Throws:
java.lang.IndexOutOfBoundsException

setColumn

public void setColumn(Column[] columnArray)
Method setColumn

Parameters:
columnArray -

setName

public void setName(java.lang.String name)
Sets the value of field 'name'.

Parameters:
name - the value of field 'name'.

setUnique

public void setUnique(boolean unique)
Sets the value of field 'unique'.

Parameters:
unique - the value of field 'unique'.

unmarshal

public static java.lang.Object unmarshal(java.io.Reader reader)
                                  throws org.exolab.castor.xml.MarshalException,
                                         org.exolab.castor.xml.ValidationException
Method unmarshal

Parameters:
reader -
Returns:
Object
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Method validate

Throws:
org.exolab.castor.xml.ValidationException


Copyright © 1999-2005 The OpenJMS Group. All Rights Reserved.