org.exolab.jms.tools.db
Class Index

java.lang.Object
  |
  +--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 Index	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 -

addColumn

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

Method addColumn

Parameters:

index -

vColumn -

clearColumn

public void clearColumn()

Method clearColumn

deleteUnique

public void deleteUnique()

Method deleteUnique

enumerateColumn

public java.util.Enumeration enumerateColumn()

Method enumerateColumn

getColumn

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

Method getColumn

Parameters:

index -

getColumn

public Column[] getColumn()

Method getColumn

getColumnCount

public int getColumnCount()

Method getColumnCount

getName

public java.lang.String getName()

Returns the value of field 'name'.

Returns:

the value of field 'name'.

getUnique

public boolean getUnique()

Returns the value of field 'unique'.

Returns:

the value of field 'unique'.

hasUnique

public boolean hasUnique()

Method hasUnique

isValid

public boolean isValid()

Method isValid

marshal

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

Method marshal

Parameters:

out -

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 -

removeColumn

public boolean removeColumn(Column vColumn)

Method removeColumn

Parameters:

vColumn -

setColumn

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

Method setColumn

Parameters:

index -

vColumn -

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 Index unmarshal(java.io.Reader reader)
                       throws org.exolab.castor.xml.MarshalException,
                              org.exolab.castor.xml.ValidationException

Method unmarshal

Parameters:

reader -

validate

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

Method validate