com.simba.dsi.dataengine.interfaces
Interface IColumn

All Known Implementing Classes:
AEAdd, AEAggrFunction, AEBinaryValueExpr, AEColumn, AECountStarAggrFunction, AEDivide, AEIntervalLiteral, AELiteral, AEMultiply, AENegate, AENull, AEParameter, AEProxyColumn, AERename, AEScalarFn, AESimpleCase, AESubtract, AEValueExpr, AEValueSubQuery, ColumnMetadata, MetadataColumn, NativeColumnWrapper

public interface IColumn

Provides access to metadata about a column, or an expression that acts like a column.

If the "column" is actually an expression, it should return reasonable "dummy" values for metadata that doesn't really apply.


Method Summary
 java.lang.String getCatalogName()
          Gets the Catalog name.
 long getColumnLength()
          Returns the size for the column for character or binary data.
 long getDisplaySize()
          Returns the display size for the column
 java.lang.String getLabel()
          Gets the column label or title.
 java.lang.String getName()
          Gets the column alias.
 Nullable getNullable()
          Indicates whether the column may hold null data.
 java.lang.String getSchemaName()
          Gets the Schema name.
 Searchable getSearchable()
          Indicates how the column can be used in a WHERE clause.
 java.lang.String getTableName()
          Gets the name of the table.
 TypeMetadata getTypeMetadata()
          Gets a TypeMetadata describing the column.
 Updatable getUpdatable()
          Describes whether the column is updatable in the result set.
 boolean isAutoUnique()
          Indicates whether the column is auto-incrementing or not.
 boolean isCaseSensitive()
          Indicates whether the column is case sensitive.
 boolean isDefinitelyWritable()
          Indicates whether the column is definitely writable.
 boolean isUnnamed()
          Indicates whether the column contains a column alias or name.
 

Method Detail

getCatalogName

java.lang.String getCatalogName()
Gets the Catalog name.

Returns:
The catalog name. Can be an empty string.

getColumnLength

long getColumnLength()
Returns the size for the column for character or binary data.

For character data, this size should be in terms of the number of characters, not the number of bytes. For example, VARCHAR(10) and NVARCHAR(10) would both correspond to size of 10, even if NVARCHAR used 2 bytes per character.

This method is not used for non-character/binary data types.

Returns:
Size for the column for character or binary data.

getDisplaySize

long getDisplaySize()
                    throws com.simba.support.exceptions.ErrorException
Returns the display size for the column

Returns:
the display size.
Throws:
com.simba.support.exceptions.ErrorException - If the type of this column is not supported.

getLabel

java.lang.String getLabel()
Gets the column label or title.

Returns:
The column label or title. Can be an empty string.

getName

java.lang.String getName()
Gets the column alias.

If there is no alias, returns the column name. May return an empty string.

Returns:
The column alias. Can be an empty string.

getNullable

Nullable getNullable()
Indicates whether the column may hold null data.

Returns:
An enum that specifies if the column can contain NULLs.
See Also:
Nullable

getSchemaName

java.lang.String getSchemaName()
Gets the Schema name.

Returns:
The schema name. Can be an empty string.

getSearchable

Searchable getSearchable()
Indicates how the column can be used in a WHERE clause.

Returns:
An enum that shows the behaviors of the column in a WHERE clause.
See Also:
Searchable

getTableName

java.lang.String getTableName()
Gets the name of the table.

Returns:
The table name.

getTypeMetadata

TypeMetadata getTypeMetadata()
Gets a TypeMetadata describing the column.

Returns:
TypeMetadata describing the column.
See Also:
TypeMetadata

getUpdatable

Updatable getUpdatable()
Describes whether the column is updatable in the result set.

Returns:
An enum that specifies the updatability of the column in the result set.
See Also:
Updatable

isAutoUnique

boolean isAutoUnique()
Indicates whether the column is auto-incrementing or not.

Returns:
true if the column is auto-incrementing; false otherwise.

isCaseSensitive

boolean isCaseSensitive()
Indicates whether the column is case sensitive.

Returns:
true if the column is case-sensitive; false otherwise.

isDefinitelyWritable

boolean isDefinitelyWritable()
Indicates whether the column is definitely writable.

Returns:
true if the column is definitely writable; false otherwise.

isUnnamed

boolean isUnnamed()
Indicates whether the column contains a column alias or name.

Returns:
true if the column contains a column alias or name; false otherwise.


Copyright © 2006-2014 Simba Technologies Incorporated. All Rights Reserved.