All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.util.servlet.ListMetaData

java.lang.Object
   |
   +----com.ibm.as400.util.servlet.ListMetaData

public class ListMetaData
extends Object
implements RowMetaData, Serializable
A ListMetaData object can be used to find out information about the columns of a ListRowData object.

ListMetaData objects generate the following events:


Constructor Index

 o ListMetaData()
Constructs a default ListMetaData object.
 o ListMetaData(int)
Constructs a ListMetaData object with the specified number of columns.

Method Index

 o addPropertyChangeListener(PropertyChangeListener)
Adds a PropertyChangeListener.
 o addVetoableChangeListener(VetoableChangeListener)
Adds the VetoableChangeListener.
 o getColumnCount()
Returns the number of columns.
 o getColumnDisplaySize(int)
Returns the display size in characters of the column specified by columnIndex.
 o getColumnLabel(int)
Returns the label of the column specified by columnIndex.
 o getColumnName(int)
Returns the name of the column specified by columnIndex.
 o getColumnType(int)
Returns the data type of the column specified by columnIndex.
 o getColumnTypeName(int)
Returns the data type name of the column specified by columnIndex.
 o getPrecision(int)
Returns the precision of the column specified by columnIndex.
 o getScale(int)
Returns the scale of the column specified by columnIndex.
 o isNumericData(int)
Indicates if the data type is numeric data.
 o isTextData(int)
Indicates if the data type is text data.
 o removePropertyChangeListener(PropertyChangeListener)
Removes the PropertyChangeListener from the internal list.
 o removeVetoableChangeListener(VetoableChangeListener)
Removes the VetoableChangeListener from the internal list.
 o setColumnDisplaySize(int, int)
Sets the specified displaySize for the column specified by columnIndex.
 o setColumnLabel(int, String)
Sets the specified label for the column specified by columnIndex.
 o setColumnName(int, String)
Sets the specified name for the column specified by columnIndex.
 o setColumns(int)
Sets the number of columns.
 o setColumnType(int, int)
Sets the specified data type for the column specified by columnIndex.

Constructors

 o ListMetaData
 public ListMetaData()
Constructs a default ListMetaData object.

 o ListMetaData
 public ListMetaData(int columns)
Constructs a ListMetaData object with the specified number of columns.

Parameters:
columns - The number of columns.

Methods

 o addPropertyChangeListener
 public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a PropertyChangeListener. The specified PropertyChangeListener's propertyChange method is called each time the value of any bound property is changed.

Parameters:
listener - The PropertyChangeListener.
See Also:
removePropertyChangeListener
 o addVetoableChangeListener
 public void addVetoableChangeListener(VetoableChangeListener listener)
Adds the VetoableChangeListener. The specified VetoableChangeListener's vetoableChange method is called each time the value of any constrained property is changed.

Parameters:
listener - The VetoableChangeListener.
See Also:
removeVetoableChangeListener
 o getColumnCount
 public int getColumnCount()
Returns the number of columns.

Returns:
The column count.
 o getColumnDisplaySize
 public int getColumnDisplaySize(int columnIndex)
Returns the display size in characters of the column specified by columnIndex.

Parameters:
columnIndex - The column index (0-based).
Returns:
The column display size in characters.
 o getColumnLabel
 public String getColumnLabel(int columnIndex)
Returns the label of the column specified by columnIndex.

Parameters:
columnIndex - The column index (0-based).
Returns:
The column label.
 o getColumnName
 public String getColumnName(int columnIndex)
Returns the name of the column specified by columnIndex.

Parameters:
columnIndex - The column index (0-based).
Returns:
The column name.
 o getColumnType
 public int getColumnType(int columnIndex)
Returns the data type of the column specified by columnIndex.

Parameters:
columnIndex - The column index (0-based).
Returns:
The column RowMetaDataType.
See Also:
RowMetaDataType
 o getColumnTypeName
 public String getColumnTypeName(int columnIndex)
Returns the data type name of the column specified by columnIndex.

Parameters:
columnIndex - The column index (0-based).
Returns:
The column data type name.
 o getPrecision
 public int getPrecision(int columnIndex)
Returns the precision of the column specified by columnIndex. This value is not used. It will always return zero.

Parameters:
columnIndex - The column index (0-based).
Returns:
The column precision (number of decimal digits).
 o getScale
 public int getScale(int columnIndex)
Returns the scale of the column specified by columnIndex. This value is not used. It will always return zero.

Parameters:
columnIndex - The column index (0-based).
Returns:
The column scale (number of digits to the right of the decimal point).
 o isNumericData
 public boolean isNumericData(int columnIndex)
Indicates if the data type is numeric data.

Parameters:
columnIndex - The column index (0-based).
Returns:
true if numeric data; false otherwise.
 o isTextData
 public boolean isTextData(int columnIndex)
Indicates if the data type is text data.

Parameters:
columnIndex - The column index (0-based).
Returns:
true if text data; false otherwise.
 o removePropertyChangeListener
 public void removePropertyChangeListener(PropertyChangeListener listener)
Removes the PropertyChangeListener from the internal list. If the PropertyChangeListener is not on the list, nothing is done.

Parameters:
listener - The PropertyChangeListener.
See Also:
addPropertyChangeListener
 o removeVetoableChangeListener
 public void removeVetoableChangeListener(VetoableChangeListener listener)
Removes the VetoableChangeListener from the internal list. If the VetoableChangeListener is not on the list, nothing is done.

Parameters:
listener - The VetoableChangeListener.
See Also:
addVetoableChangeListener
 o setColumnDisplaySize
 public void setColumnDisplaySize(int columnIndex,
                                  int displaySize)
Sets the specified displaySize for the column specified by columnIndex.

Parameters:
columnIndex - The column index (0-based).
displaySize - The column display size in characters.
 o setColumnLabel
 public void setColumnLabel(int columnIndex,
                            String label)
Sets the specified label for the column specified by columnIndex.

Parameters:
columnIndex - The column index (0-based).
label - The column label.
 o setColumnName
 public void setColumnName(int columnIndex,
                           String name)
Sets the specified name for the column specified by columnIndex.

Parameters:
columnIndex - The column index (0-based).
name - The column name.
 o setColumns
 public void setColumns(int columns) throws PropertyVetoException
Sets the number of columns. Any previous column information is cleared.

Parameters:
columns - The number of columns.
Throws: PropertyVetoException
If a change is vetoed.
 o setColumnType
 public void setColumnType(int columnIndex,
                           int type)
Sets the specified data type for the column specified by columnIndex.

Parameters:
columnIndex - The column index (0-based).
type - The RowMetaDataType type.
See Also:
RowMetaDataType

All Packages  Class Hierarchy  This Package  Previous  Next  Index