org.apache.hawq.pxf.api.utilities

Class ColumnDescriptor

java.lang.Object

org.apache.hawq.pxf.api.utilities.ColumnDescriptor

Direct Known Subclasses:

HBaseColumnDescriptor

public class ColumnDescriptor
extends java.lang.Object

ColumnDescriptor describes one column in hawq database. Currently it means a name, a type id (HAWQ/GPDB OID), a type name and column index.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RECORD_KEY_NAME Reserved word for a table record key.

Constructor Summary

Constructors

Constructor and Description
ColumnDescriptor(ColumnDescriptor copy) Constructs a copy of ColumnDescriptor.
ColumnDescriptor(java.lang.String name, int typecode, int index, java.lang.String typename) Constructs a ColumnDescriptor.

Method Summary

Modifier and Type	Method and Description
int	columnIndex()
java.lang.String	columnName()
int	columnTypeCode()
java.lang.String	columnTypeName()
boolean	isKeyColumn() Returns true if gpdbColumnName is a RECORD_KEY_NAME.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

RECORD_KEY_NAME

public static final java.lang.String RECORD_KEY_NAME

Reserved word for a table record key. A field with this name will be treated as record key.

See Also:

Constant Field Values

Constructor Detail

ColumnDescriptor

public ColumnDescriptor(java.lang.String name,
                        int typecode,
                        int index,
                        java.lang.String typename)

Constructs a ColumnDescriptor.

Parameters:

name - column name

typecode - OID

index - column index

typename - type name

ColumnDescriptor

public ColumnDescriptor(ColumnDescriptor copy)

Constructs a copy of ColumnDescriptor.

Parameters:

copy - the ColumnDescriptor to copy

Method Detail

columnName

public java.lang.String columnName()

columnTypeCode

public int columnTypeCode()

columnIndex

public int columnIndex()

columnTypeName

public java.lang.String columnTypeName()

isKeyColumn

public boolean isKeyColumn()

Returns true if gpdbColumnName is a RECORD_KEY_NAME.

Returns:

whether column is a record key column

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object