com.simba.dsi.ext.aetree
Class NativeColumnWrapper

java.lang.Object
  extended by com.simba.dsi.CppClassWrapper
      extended by com.simba.dsi.ext.aetree.NativeColumnWrapper
All Implemented Interfaces:
IColumn

public final class NativeColumnWrapper
extends CppClassWrapper
implements IColumn

This class wraps any C++ IColumn derived class.


Constructor Summary
NativeColumnWrapper(long objRef)
          Constructor.
 
Method Summary
 java.lang.String getCatalogName()
          Retrieves the catalog name of the value expression.
 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()
          Retrieves the label of the value expression.
 java.lang.String getName()
          Retrieve the name of the value expression.
 Nullable getNullable()
          Tells whether the expression is updatable.
 java.lang.String getSchemaName()
          Retrieve the schema name of the value expression.
 Searchable getSearchable()
          Tells whether the expression is updatable.
 java.lang.String getTableName()
          Retrieve the table name of the value expression.
 TypeMetadata getTypeMetadata()
          Retrieves the type metadata.
 Updatable getUpdatable()
          Tell whether updatability of the expression as a column.
 boolean isAutoUnique()
          Tell whether the expression is auto unique.
 boolean isCaseSensitive()
          Tell whether the expression is case-sensitive.
 boolean isDefinitelyWritable()
          Indicates whether the expression is definitely writable.
 boolean isUnnamed()
          Indicates whether the expression contains a column alias or name.
 
Methods inherited from class com.simba.dsi.CppClassWrapper
getObjRef
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NativeColumnWrapper

public NativeColumnWrapper(long objRef)
Constructor.

Parameters:
objRef - The corresponding C++ object reference.
Method Detail

getDisplaySize

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

Specified by:
getDisplaySize in interface IColumn
Returns:
the display size.
Throws:
com.simba.support.exceptions.ErrorException - If the type of this column is not supported.

getCatalogName

public java.lang.String getCatalogName()
Retrieves the catalog name of the value expression.

Specified by:
getCatalogName in interface IColumn
Returns:
The catalog name of the value expression.

getColumnLength

public 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.

Specified by:
getColumnLength in interface IColumn
Returns:
Size for the column for character or binary data.

getLabel

public java.lang.String getLabel()
Retrieves the label of the value expression.

Specified by:
getLabel in interface IColumn
Returns:
The label of the value expression.

getName

public java.lang.String getName()
Retrieve the name of the value expression.

Specified by:
getName in interface IColumn
Returns:
The name of the value expression.

getNullable

public Nullable getNullable()
Tells whether the expression is updatable.

Specified by:
getNullable in interface IColumn
Returns:
Whether the expression is updatable.
See Also:
Nullable

getSchemaName

public java.lang.String getSchemaName()
Retrieve the schema name of the value expression.

Specified by:
getSchemaName in interface IColumn
Returns:
The schema name of the value expression.

getSearchable

public Searchable getSearchable()
Tells whether the expression is updatable.

Specified by:
getSearchable in interface IColumn
Returns:
Whether the expression is updatable.
See Also:
Searchable

getTableName

public java.lang.String getTableName()
Retrieve the table name of the value expression.

Specified by:
getTableName in interface IColumn
Returns:
The table name of the value expression.

getTypeMetadata

public TypeMetadata getTypeMetadata()
Retrieves the type metadata.

Specified by:
getTypeMetadata in interface IColumn
Returns:
The type metadata.
See Also:
TypeMetadata

getUpdatable

public Updatable getUpdatable()
Tell whether updatability of the expression as a column.

Specified by:
getUpdatable in interface IColumn
Returns:
The updatability of the expression as a column.
See Also:
Updatable

isAutoUnique

public boolean isAutoUnique()
Tell whether the expression is auto unique.

Specified by:
isAutoUnique in interface IColumn
Returns:
True if the expression is auto unique, false otherwise.

isCaseSensitive

public boolean isCaseSensitive()
Tell whether the expression is case-sensitive. This only applies to character data.

Specified by:
isCaseSensitive in interface IColumn
Returns:
True if the expression is case-sensitive, false otherwise.

isDefinitelyWritable

public boolean isDefinitelyWritable()
Indicates whether the expression is definitely writable.

Specified by:
isDefinitelyWritable in interface IColumn
Returns:
True if the expression is definitely writable, false otherwise.

isUnnamed

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

Specified by:
isUnnamed in interface IColumn
Returns:
True if the column contains a column alias or name, false otherwise.


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