com.businessobjects.customds.common
Class ColumnsInfo

java.lang.Object
  com.businessobjects.customds.common.ColumnsInfo

public class ColumnsInfo
extends java.lang.Object

The ColumnsInfo class contains all the ColumnSpec that form the objects (columns) of the data provider.

This class allows you to add ColumnSpec with the same column name.

Since:

12.2

Constructor Summary

ColumnsInfo()
Class Constructor

Method Summary

void	addColumn(ColumnSpec columnSpec) Adds the ColumnSpec to the ColumnsInfo object.
void	addColumns(java.util.Collection columnSpecs) Adds the collection of ColumnSpec(s) to the ColumnsInfo object.
void	clear() Clears all the ColumnSpec(s) from the ColumnsInfo object.
java.util.Collection	getColumnsInfo() Internal Use Only
ColumnSpec	getColumnSpec(int index) Returns the ColumnSpec object at the specified index in the ColumnsInfo object.
ColumnSpec[]	getColumnSpec(java.lang.String columnName) Returns an array of ColumnSpec objects with the specified name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnsInfo

public ColumnsInfo()

Class Constructor

Method Detail

addColumn

public void addColumn(ColumnSpec columnSpec)
               throws DataSourceException

Adds the ColumnSpec to the ColumnsInfo object.

The plug-in calls this method while building objects that form a part of the data provider; that is, during CustomDataSource.getColumnsInfo(java.util.Map) method call.

Parameters:

columnSpec - Contains the details of object (column) to be included in the data provider.

Throws:

DataSourceException - if the ColumnSpec object is null.

See Also:

ColumnSpec, DataSourceException

addColumns

public void addColumns(java.util.Collection columnSpecs)
                throws DataSourceException

Adds the collection of ColumnSpec(s) to the ColumnsInfo object.

The plug-in calls this method while building objects that form part of the data provider; that is, during CustomDataSource.getColumnsInfo(java.util.Map) method call.

Parameters:

columnSpecs - Contains the collection of ColumnSpec objects.

Throws:

DataSourceException - if the Collection object is null, if the collection contains object other than ColumnSpec, or if the ColumnSpec object in the collection is null.

See Also:

ColumnSpec, DataSourceException

clear

public void clear()

Clears all the ColumnSpec(s) from the ColumnsInfo object.

getColumnSpec

public ColumnSpec getColumnSpec(int index)

Returns the ColumnSpec object at the specified index in the ColumnsInfo object.

Parameters:

index - The index of the element to return.

Returns:

The ColumnSpec object.

Throws:

ArrayIndexOutOfBoundsException - if the index is more than or equal to the size of the collection, or less than 0.

getColumnSpec

public ColumnSpec[] getColumnSpec(java.lang.String columnName)

Returns an array of ColumnSpec objects with the specified name.

The comparison between ColumnSpec column name and the specified column name is case sensitive.

Parameters:

columnName - The column name

Returns:

An array of ColumnSpec objects.

getColumnsInfo

public java.util.Collection getColumnsInfo()

Internal Use Only