org.enableit.db.beans
Class Index

java.lang.Object
  |
  +--org.enableit.db.beans.Index

All Implemented Interfaces:

java.io.Serializable

public class Index

extends java.lang.Object

implements java.io.Serializable

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Index()

Method Summary

void	addColName(int index, java.lang.String vColName)
void	addColName(java.lang.String vColName)
java.util.Enumeration	enumerateColName()
java.lang.String[]	getColName()
java.lang.String	getColName(int index)
int	getColNameCount()
java.lang.String	getName() Returns the value of field 'name'.
java.lang.String	getTableName() Returns the value of field 'tableName'.
java.lang.String	getType() Returns the value of field 'type'.
java.lang.String	getUnique() Returns the value of field 'unique'.
boolean	isValid()
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
void	removeAllColName()
java.lang.String	removeColName(int index)
void	setColName(int index, java.lang.String vColName)
void	setColName(java.lang.String[] colNameArray)
void	setName(java.lang.String name) Sets the value of field 'name'.
void	setTableName(java.lang.String tableName) Sets the value of field 'tableName'.
void	setType(java.lang.String type) Sets the value of field 'type'.
void	setUnique(java.lang.String unique) Sets the value of field 'unique'.
static org.enableit.db.beans.Index	unmarshal(java.io.Reader reader)
void	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

addColName

public void addColName(java.lang.String vColName)
                throws java.lang.IndexOutOfBoundsException

Parameters:

vColName -

java.lang.IndexOutOfBoundsException

addColName

public void addColName(int index,
                       java.lang.String vColName)
                throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vColName -

java.lang.IndexOutOfBoundsException

enumerateColName

public java.util.Enumeration enumerateColName()

getColName

public java.lang.String getColName(int index)
                            throws java.lang.IndexOutOfBoundsException

Parameters:

index -

java.lang.IndexOutOfBoundsException

getColName

public java.lang.String[] getColName()

getColNameCount

public int getColNameCount()

getName

public java.lang.String getName()

Returns the value of field 'name'.

Returns:

the value of field 'name'.

getTableName

public java.lang.String getTableName()

Returns the value of field 'tableName'.

Returns:

the value of field 'tableName'.

getType

public java.lang.String getType()

Returns the value of field 'type'.

Returns:

the value of field 'type'.

getUnique

public java.lang.String getUnique()

Returns the value of field 'unique'.

Returns:

the value of field 'unique'.

isValid

public boolean isValid()

marshal

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

Parameters:

out -

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

Parameters:

handler -

java.io.IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

removeAllColName

public void removeAllColName()

removeColName

public java.lang.String removeColName(int index)

Parameters:

index -

setColName

public void setColName(int index,
                       java.lang.String vColName)
                throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vColName -

java.lang.IndexOutOfBoundsException

setColName

public void setColName(java.lang.String[] colNameArray)

Parameters:

colNameArray -

setName

public void setName(java.lang.String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setTableName

public void setTableName(java.lang.String tableName)

Sets the value of field 'tableName'.

Parameters:

tableName - the value of field 'tableName'.

setType

public void setType(java.lang.String type)

Sets the value of field 'type'.

Parameters:

type - the value of field 'type'.

setUnique

public void setUnique(java.lang.String unique)

Sets the value of field 'unique'.

Parameters:

unique - the value of field 'unique'.

unmarshal

public static org.enableit.db.beans.Index unmarshal(java.io.Reader reader)
                                             throws org.exolab.castor.xml.MarshalException,
                                                    org.exolab.castor.xml.ValidationException

Parameters:

reader -

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

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

org.exolab.castor.xml.ValidationException