com.sptci.echo.table

Class ColumnMetaData

java.lang.Object

com.sptci.echo.table.ColumnMetaData

All Implemented Interfaces:

Serializable

public class ColumnMetaData
extends Object
implements Serializable

A data object used to hold the name and class of a column displayed in the Table.

© Copyright 2007 Sans Pareil Technologies, Inc.

Version:

$Id: ColumnMetaData.java 4553 2008-12-24 10:34:16Z rakesh $

Author:

Rakesh Vidyadharan 2007-09-19

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	displayAll A flag used to indicate that all the values in a collection are to be displayed.
protected String	fieldName An optional name that represents a field in type whose value will be displayed.
protected String	name The name of the column.
protected Class	type The class of the object displayed in the column.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ColumnMetaData()
	ColumnMetaData(String name, Class type) Create a new instance using the specified mandatory fields.
	ColumnMetaData(String name, Class type, String fieldName) Create a new instance using the specified fields.
	ColumnMetaData(String name, Class type, String fieldName, boolean displayAll) Create a new instance using the specified fields.

Method Summary

Modifier and Type	Method and Description
String	getFieldName() Return the value of fieldName.
String	getName() Return the value of name.
Class	getType() Return the value of type.
boolean	isDisplayAll() Return the status indicator for dealing with collection data.
void	setDisplayAll(boolean displayAll) Set the status indicator for displaying values in a collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected String name

The name of the column. This is used to display in table header.

type

protected Class type

The class of the object displayed in the column.

fieldName

protected String fieldName

An optional name that represents a field in type whose value will be displayed. Specify this if type represents a complex (user defined, collection, etc.) object that will normally be ignored by automatic binding processes.

displayAll

protected boolean displayAll

A flag used to indicate that all the values in a collection are to be displayed. The default is to display only the first value.

Constructor Detail

ColumnMetaData

protected ColumnMetaData()

ColumnMetaData

public ColumnMetaData(String name,
                      Class type)

Create a new instance using the specified mandatory fields.

Parameters:

name - The name value to use.

type - The type value to use.

ColumnMetaData

public ColumnMetaData(String name,
                      Class type,
                      String fieldName)

Create a new instance using the specified fields.

Parameters:

name - The name value to use.

type - The type value to use.

fieldName - The fieldName value to use.

ColumnMetaData

public ColumnMetaData(String name,
                      Class type,
                      String fieldName,
                      boolean displayAll)

Create a new instance using the specified fields. This is the designated constructor.

Parameters:

name - The name value to use.

type - The type value to use.

fieldName - The fieldName value to use.

displayAll - The displayAll to use.

Method Detail

getName

public String getName()

Return the value of name.

Returns:

The reference to name.

getType

public Class getType()

Return the value of type.

Returns:

The reference to type.

getFieldName

public String getFieldName()

Return the value of fieldName.

Returns:

The reference to fieldName.

isDisplayAll

public boolean isDisplayAll()

Return the status indicator for dealing with collection data.

Returns:

The value of displayAll

setDisplayAll

public void setDisplayAll(boolean displayAll)

Set the status indicator for displaying values in a collection.

Parameters:

displayAll - The value for the status indicator.