gudusoft.gsqlparser.sqlenv

Class TSQLTable

Object

gudusoft.gsqlparser.sqlenv.TSQLObject

gudusoft.gsqlparser.sqlenv.TSQLSchemaObject

gudusoft.gsqlparser.sqlenv.TSQLTable

public class TSQLTable
extends TSQLSchemaObject

SQL table, includes a list of columns.

Field Summary

Fields inherited from class gudusoft.gsqlparser.sqlenv.TSQLObject

dataObjectType, name, nameKeepCase, sqlEnv

Constructor Summary

Constructors

Constructor and Description
TSQLTable(TSQLSchema sqlSchema, String tableName) create a new table belong to a schema

Method Summary

Modifier and Type	Method and Description
void	addColumn(String columnName) add a new column to the table
void	addColumn(String columnName, TTypeName columnDataType)
void	addUnresolvedStar() Records that the table's width is not fully known: its definition or the lineage that wrote it back read a star (SELECT *) it could not expand.
void	fillColumnDataType(String columnName, TTypeName columnDataType) Gives the column columnName the data type columnDataType when the column has none: another definition of the table that knows the type completes the column, as when metadata from several files is merged.
TSQLColumn	getColumn(String columnName)
List<TSQLColumn>	getColumnList() column list
ArrayList<String>	getColumns(boolean columnNameOnly)
String	getDefinition() This is the script that used to create this view( isView() returns true).
boolean	hasAllColumnsKnown() Whether every column of the table is known: it has columns, and none is a star it could not expand (addUnresolvedStar()).
boolean	isSealed() Check if this table is sealed (Phase 6).
boolean	isView() Used to check whether this is a view.
TSQLTable	newVersion() Replaces this table in its schema with a new table of the same name, columns, kind and definition, and returns the new one.
void	seal() Seal this table to prevent further modifications (Phase 6).
boolean	searchColumn(String columnName)
void	setDefinition(String definition)
void	setView(boolean view)

Methods inherited from class gudusoft.gsqlparser.sqlenv.TSQLSchemaObject

getPriority, getQualifiedName, getSchema, setPriority

Methods inherited from class gudusoft.gsqlparser.sqlenv.TSQLObject

compareTo, compareTo, compareTo, compareTo, getDataObjectType, getName, getNameKeepCase, getSqlEnv, isDelimitedIdentifier, isDelimitedIdentifier, normalizeIdentifier, setDataObjectType

Methods inherited from class Object

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

Constructor Detail

TSQLTable

public TSQLTable(TSQLSchema sqlSchema,
                 String tableName)

create a new table belong to a schema

Parameters:

sqlSchema - schema

tableName - table name

Method Detail

seal

public void seal()

Seal this table to prevent further modifications (Phase 6).

See TSQLEnv#seal() for detailed documentation.

isSealed

public boolean isSealed()

Check if this table is sealed (Phase 6).

Returns:

true if sealed, false otherwise

setView

public void setView(boolean view)

isView

public boolean isView()

Used to check whether this is a view.

Returns:

true if this is a view.

setDefinition

public void setDefinition(String definition)

getDefinition

public String getDefinition()

This is the script that used to create this view( isView() returns true).

Returns:

sql script that used to create this view.

getColumnList

public List<TSQLColumn> getColumnList()

column list

Returns:

a column list

addColumn

public void addColumn(String columnName)

add a new column to the table

Parameters:

columnName - column name

addColumn

public void addColumn(String columnName,
                      TTypeName columnDataType)

addUnresolvedStar

public void addUnresolvedStar()

Records that the table's width is not fully known: its definition or the lineage that wrote it back read a star (SELECT *) it could not expand. The entry is stored as * and marked (TSQLColumn.isUnresolvedStar()); it is not a column of the table, and a column the table already holds under that name (a column NAMED *) is left as it is.

newVersion

public TSQLTable newVersion()

Replaces this table in its schema with a new table of the same name, columns, kind and definition, and returns the new one. A statement that changes the table's columns (ALTER TABLE ... ADD COLUMN) changes the new table, so a statement placed before it keeps the table it found there, with the columns it had then. The new table is complete before the schema holds it.

Returns:

the table the schema now holds under this table's name

searchColumn

public boolean searchColumn(String columnName)

hasAllColumnsKnown

public boolean hasAllColumnsKnown()

Whether every column of the table is known: it has columns, and none is a star it could not expand (addUnresolvedStar()). Only then does searchColumn(java.lang.String) returning false prove the table has no column of that name.

Returns:

true when the column list is complete

getColumn

public TSQLColumn getColumn(String columnName)

fillColumnDataType

public void fillColumnDataType(String columnName,
                               TTypeName columnDataType)

Gives the column columnName the data type columnDataType when the column has none: another definition of the table that knows the type completes the column, as when metadata from several files is merged. A type the column already has is kept, and nothing happens when the table has no such column.

Parameters:

columnName - column name, as for addColumn(String, TTypeName)

columnDataType - the type; nothing happens when it is null

getColumns

public ArrayList<String> getColumns(boolean columnNameOnly)