com.businessobjects.customds.common
Class ColumnSpec

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

public class ColumnSpec
extends java.lang.Object

The ColumnSpec class is used to identify details such as name and data type of the data provider object (column) used in the data provider.

Since:

12.2

Constructor Summary

ColumnSpec()
Class Constructor - When using this constructor, by default, the column name will be an empty string and type ObjectTypes.STRING.

ColumnSpec(java.lang.String columnName)
Class Constructor - Defaults object (column) data type to ObjectTypes.STRING.

ColumnSpec(java.lang.String columnName, int columnType)
Class Constructor

Method Summary

boolean	equals(java.lang.Object obj) Internal Use Only
java.lang.String	getColumnName() Returns the name of the object (column).
int	getColumnType() Returns the data type of the object (column).
int	hashCode() Internal Use Only
void	setColumnName(java.lang.String columnName) Sets the name of the object (column).
void	setColumnType(int columnType) Sets the data type of the object (column).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ColumnSpec

public ColumnSpec()

Class Constructor -

When using this constructor, by default, the column name will be an empty string and type ObjectTypes.STRING. Use setter methods to set the column names and object types explicitly.

ColumnSpec

public ColumnSpec(java.lang.String columnName)
           throws DataSourceException

Class Constructor - Defaults object (column) data type to ObjectTypes.STRING.

Parameters:

columnName - Name of the object (column).

Throws:

DataSourceException - if columnName is null.

See Also:

ObjectTypes

ColumnSpec

public ColumnSpec(java.lang.String columnName,
                  int columnType)
           throws DataSourceException

Class Constructor

Parameters:

columnName - Name of the object (column)

columnType - Data type of the object (column)

Throws:

DataSourceException - if columnName is null or if columnType is not one of the data types defined in ObjectTypes.

See Also:

ObjectTypes

Method Detail

getColumnName

public java.lang.String getColumnName()

Returns the name of the object (column).

Returns:

the name of the object (column).

setColumnName

public void setColumnName(java.lang.String columnName)
                   throws DataSourceException

Sets the name of the object (column).

Parameters:

columnName - The name of the object (column).

Throws:

DataSourceException - if columnName is null.

getColumnType

public int getColumnType()

Returns the data type of the object (column).

Returns:

The int value corresponding to the data type of the object (column).

setColumnType

public void setColumnType(int columnType)
                   throws DataSourceException

Sets the data type of the object (column).

Parameters:

columnType - The int value corresponding to the column type.

Throws:

DataSourceException - if columnType is not one of the data types defined in ObjectTypes.

See Also:

ObjectTypes

hashCode

public int hashCode()

Internal Use Only

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Internal Use Only

Overrides:

equals in class java.lang.Object