TableColumn (General SQL Parser Java Library Core 4.2.19 API)

Object
- gudusoft.gsqlparser.dlineage.dataflow.model.Column
- - gudusoft.gsqlparser.dlineage.dataflow.model.TableColumn

Direct Known Subclasses:

FileUri, JsonTableColumn, StageLocation, VariableProperty
```
public class TableColumn
extends Column
```

Field Summary

Fields
Modifier and Type Field and Description

protected Pair3<Long,Long,String> endPosition

protected String name

protected Pair3<Long,Long,String> startPosition

Fields
Modifier and Type	Field and Description
`protected Pair3<Long,Long,String>`	`endPosition`
`protected String`	`name`
`protected Pair3<Long,Long,String>`	`startPosition`

Constructor Summary

Constructors
Constructor and Description
`TableColumn(Table table, String columnName)` Constructor for MDX and other non-SQL columns where only a name is available.
`TableColumn(Table table, TConstant columnObject)`
`TableColumn(Table table, TConstant columnObject, int columnIndex)`
`TableColumn(Table table, TExpression columnObject, int columnIndex)`
`TableColumn(Table table, TFunctionCall columnObject)`
`TableColumn(Table table, TObjectName columnObject)`
`TableColumn(Table view, TObjectName columnObject, int index)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`bindStarLinkColumns(Map<String,Set<TObjectName>> starLinkColumns)` Deprecated. use `Column.shareStarLinksFrom(Column)`
`List<Object>`	`getCandidateParents()`
`Integer`	`getColumnIndex()`
`protected String`	`getColumnName(TExpression expr)`
`TObjectName`	`getColumnObject()`
`String`	`getDataType()`
`TableColumn`	`getDeclaredColumn()` The declared column a field path node belongs to, the column itself for a column.
`TableColumn`	`getDeclaredElement()` The node of the element of this column or field when a declared ARRAY type made one, `items[*]`; else null.
`List<TableColumn>`	`getDeclaredFields()` The fields of this column or field as its declared STRUCT type lists them, each a field path node, in order; empty when no declared type lists them, so the fields are not known.
`DeclaredTypeNode.Kind`	`getDeclaredKind()` The kind of type the DDL declares this column or field with; null when no DDL declares it.
`String`	`getDisplayName()`
`Pair3<Long,Long,String>`	`getEndPosition()`
`StructuredColumnPath`	`getFieldPath()` For a field path node, its path under the declared column; null for a column.
`Boolean`	`getForeignKey()`
`long`	`getId()`
`CanonKey`	`getIdentifierKey()` Null for expressions, wildcards and other non-identifier model names.
`Boolean`	`getIndexKey()`
`String`	`getName()` The column's name as the model publishes it (a display string, not an identity).
`TableColumn`	`getParentColumn()` For a field path node, the node it is a field or an array element of; null for a column.
`Boolean`	`getPrimaryKey()`
`TableColumn`	`getSourceColumn()`
`Pair3<Long,Long,String>`	`getStartPosition()`
`Table`	`getTable()`
`List<Transform>`	`getTransforms()`
`Boolean`	`getUnqiueKey()`
`Table`	`getView()`
`boolean`	`isDeclaredField()` Whether the declaration in force made this field path node, rather than a read.
`boolean`	`isExpandStar()`
`boolean`	`isFieldPathNode()` Whether this is a field path node (a field or an array element of a column), not a column of its own.
`boolean`	`isFieldsDeclared()` Whether the STRUCT type this column or field is declared with lists its fields, each a field path node, under the declaration in force at the statement being analyzed (`Table.getActiveFieldDeclaration()`).
`boolean`	`isNotBindStarLinkColumn()`
`boolean`	`isPseduo()`
`boolean`	`isShowStar()`
`boolean`	`isStruct()`
`boolean`	`isVariant()`
`void`	`notBindStarLinkColumn(boolean notBindStarColumn)`
`void`	`setCandidateParents(List<Object> candidateParents)`
`void`	`setColumnIndex(int columnIndex)`
`void`	`setDataType(String dataType)`
`void`	`setDeclaredField(boolean declaredField)` Records, in the declaration being made, that a declared type made this field path node.
`void`	`setDeclaredKind(DeclaredTypeNode.Kind declaredKind)`
`void`	`setDisplayName(String displayName)`
`void`	`setEndPosition(Pair3<Long,Long,String> endPosition)`
`void`	`setExpandStar(boolean expandStar)`
`void`	`setFieldsDeclared(boolean fieldsDeclared)` Records, in the declaration being made, that this column's or field's declared STRUCT type lists its fields.
`void`	`setForeignKey(Boolean foreignKey)`
`void`	`setIndexKey(Boolean indexKey)`
`void`	`setPrimaryKey(Boolean primaryKey)`
`void`	`setPseduo(boolean isPseduo)`
`void`	`setShowStar(boolean showStar)`
`void`	`setSourceColumn(TableColumn sourceColumn)`
`void`	`setStartPosition(Pair3<Long,Long,String> startPosition)`
`void`	`setStruct(boolean isStruct)`
`void`	`setTransform(Transform transform)`
`void`	`setUnqiueKey(Boolean unqiueKey)`
`void`	`setVariant(boolean isVariant)`
`protected boolean`	`supportProperty()` Deprecated. read `NestedAccessProfile.publishesPropertyNames()` of the analysis's vendor.
`String`	`toString()`

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name
```
protected String name
```

startPosition

protected Pair3<Long,Long,String> startPosition

endPosition

protected Pair3<Long,Long,String> endPosition

Constructor Detail

TableColumn

public TableColumn(Table view,
                   TObjectName columnObject,
                   int index)

TableColumn

public TableColumn(Table table,
                   TObjectName columnObject)

TableColumn

public TableColumn(Table table,
                   String columnName)

Constructor for MDX and other non-SQL columns where only a name is available.

TableColumn

public TableColumn(Table table,
                   TConstant columnObject,
                   int columnIndex)

TableColumn

public TableColumn(Table table,
                   TConstant columnObject)

TableColumn

public TableColumn(Table table,
                   TFunctionCall columnObject)

TableColumn

public TableColumn(Table table,
                   TExpression columnObject,
                   int columnIndex)

Method Detail
- getIdentifierKey
```
public CanonKey getIdentifierKey()
```
  Description copied from class: Column
  
  Null for expressions, wildcards and other non-identifier model names.
  
  Overrides:
  
  getIdentifierKey in class Column
- supportProperty
```
@Deprecated
protected boolean supportProperty()
```
  Deprecated. read NestedAccessProfile.publishesPropertyNames() of the analysis's vendor.
- getColumnName
```
protected String getColumnName(TExpression expr)
```
- getTable
```
public Table getTable()
```
- getId
```
public long getId()
```
- getName
```
public String getName()
```
  Description copied from class: Column
  
  The column's name as the model publishes it (a display string, not an identity).
  
  Specified by:
  
  getName in class Column
- getStartPosition
```
public Pair3<Long,Long,String> getStartPosition()
```
- getEndPosition
```
public Pair3<Long,Long,String> getEndPosition()
```
- setStartPosition
```
public void setStartPosition(Pair3<Long,Long,String> startPosition)
```
- setEndPosition
```
public void setEndPosition(Pair3<Long,Long,String> endPosition)
```
- getColumnObject
```
public TObjectName getColumnObject()
```
- bindStarLinkColumns
```
@Deprecated
public void bindStarLinkColumns(Map<String,Set<TObjectName>> starLinkColumns)
```
  Deprecated. use Column.shareStarLinksFrom(Column)
  
  Adds the given star links as a map's putAll does: a link of a published name this column already has is replaced, a new one is appended. The map of another column (Column.getStarLinkColumns()) shares that column's links, as Column.shareStarLinksFrom(Column) does.
- isShowStar
```
public boolean isShowStar()
```
- setShowStar
```
public void setShowStar(boolean showStar)
```
- getView
```
public Table getView()
```
- getColumnIndex
```
public Integer getColumnIndex()
```
- isVariant
```
public boolean isVariant()
```
- setVariant
```
public void setVariant(boolean isVariant)
```
- getDisplayName
```
public String getDisplayName()
```
- setDisplayName
```
public void setDisplayName(String displayName)
```
- setExpandStar
```
public void setExpandStar(boolean expandStar)
```
- isExpandStar
```
public boolean isExpandStar()
```
- isPseduo
```
public boolean isPseduo()
```
- setPseduo
```
public void setPseduo(boolean isPseduo)
```
- notBindStarLinkColumn
```
public void notBindStarLinkColumn(boolean notBindStarColumn)
```
- isNotBindStarLinkColumn
```
public boolean isNotBindStarLinkColumn()
```
- getPrimaryKey
```
public Boolean getPrimaryKey()
```
- setPrimaryKey
```
public void setPrimaryKey(Boolean primaryKey)
```
- getUnqiueKey
```
public Boolean getUnqiueKey()
```
- setUnqiueKey
```
public void setUnqiueKey(Boolean unqiueKey)
```
- getIndexKey
```
public Boolean getIndexKey()
```
- setIndexKey
```
public void setIndexKey(Boolean indexKey)
```
- getForeignKey
```
public Boolean getForeignKey()
```
- setForeignKey
```
public void setForeignKey(Boolean foreignKey)
```
- getDataType
```
public String getDataType()
```
- setDataType
```
public void setDataType(String dataType)
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- setColumnIndex
```
public void setColumnIndex(int columnIndex)
```
- isStruct
```
public boolean isStruct()
```
- setStruct
```
public void setStruct(boolean isStruct)
```
- getTransforms
```
public List<Transform> getTransforms()
```
- setTransform
```
public void setTransform(Transform transform)
```
- getCandidateParents
```
public List<Object> getCandidateParents()
```
- setCandidateParents
```
public void setCandidateParents(List<Object> candidateParents)
```
- getSourceColumn
```
public TableColumn getSourceColumn()
```
- isFieldPathNode
```
public boolean isFieldPathNode()
```
  Whether this is a field path node (a field or an array element of a column), not a column of its own.
- getParentColumn
```
public TableColumn getParentColumn()
```
  For a field path node, the node it is a field or an array element of; null for a column.
- getFieldPath
```
public StructuredColumnPath getFieldPath()
```
  For a field path node, its path under the declared column; null for a column.
- getDeclaredFields
```
public List<TableColumn> getDeclaredFields()
```
  The fields of this column or field as its declared STRUCT type lists them, each a field path node, in order; empty when no declared type lists them, so the fields are not known.
- getDeclaredElement
```
public TableColumn getDeclaredElement()
```
  The node of the element of this column or field when a declared ARRAY type made one, items[*]; else null.
- isFieldsDeclared
```
public boolean isFieldsDeclared()
```
  Whether the STRUCT type this column or field is declared with lists its fields, each a field path node, under the declaration in force at the statement being analyzed (Table.getActiveFieldDeclaration()).
- setFieldsDeclared
```
public void setFieldsDeclared(boolean fieldsDeclared)
```
  Records, in the declaration being made, that this column's or field's declared STRUCT type lists its fields.
- setDeclaredField
```
public void setDeclaredField(boolean declaredField)
```
  Records, in the declaration being made, that a declared type made this field path node.
- isDeclaredField
```
public boolean isDeclaredField()
```
  Whether the declaration in force made this field path node, rather than a read.
- getDeclaredKind
```
public DeclaredTypeNode.Kind getDeclaredKind()
```
  The kind of type the DDL declares this column or field with; null when no DDL declares it.
- setDeclaredKind
```
public void setDeclaredKind(DeclaredTypeNode.Kind declaredKind)
```
- getDeclaredColumn
```
public TableColumn getDeclaredColumn()
```
  The declared column a field path node belongs to, the column itself for a column.
- setSourceColumn
```
public void setSourceColumn(TableColumn sourceColumn)
```

Class TableColumn

Field Summary

Constructor Summary

Method Summary

Methods inherited from class gudusoft.gsqlparser.dlineage.dataflow.model.Column

Methods inherited from class Object

Field Detail

name

startPosition

endPosition

Constructor Detail

TableColumn

TableColumn

TableColumn

TableColumn

TableColumn

TableColumn

TableColumn

Method Detail

getIdentifierKey

supportProperty

getColumnName

getTable

getId

getName

getStartPosition

getEndPosition

setStartPosition

setEndPosition

getColumnObject

bindStarLinkColumns

isShowStar

setShowStar

getView

getColumnIndex

isVariant

setVariant

getDisplayName

setDisplayName

setExpandStar

isExpandStar

isPseduo

setPseduo

notBindStarLinkColumn

isNotBindStarLinkColumn

getPrimaryKey

setPrimaryKey

getUnqiueKey

setUnqiueKey

getIndexKey

setIndexKey

getForeignKey

setForeignKey

getDataType

setDataType

toString

setColumnIndex

isStruct

setStruct

getTransforms

setTransform

getCandidateParents

setCandidateParents

getSourceColumn

isFieldPathNode

getParentColumn

getFieldPath

getDeclaredFields

getDeclaredElement

isFieldsDeclared

setFieldsDeclared

setDeclaredField

isDeclaredField

getDeclaredKind

setDeclaredKind

getDeclaredColumn

setSourceColumn