com.incorta.connector.model

Class ColumnDetails

java.lang.Object

com.incorta.connector.model.ColumnDetails

public final class ColumnDetails
extends java.lang.Object

An immutable representation of a table column in the target data source.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ColumnDetails.Builder Used for constructing a TableDetails object.

Constructor Summary

Constructors

Constructor and Description
ColumnDetails(TableDetails table, com.incorta.io.Record.ColumnDef columnDef, java.lang.String originalType, java.util.Collection<ColumnDetails> refersTo) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
static ColumnDetails.Builder	builder() Creates a new builder object.
com.incorta.io.Record.ColumnDef	getColumnDef() Returns the underlying column definition.
java.lang.String	getLabel() Returns the column label.
java.lang.String	getName() Returns the column name.
java.lang.String	getOriginalType() Returns the column type as defined in the data source.
java.util.List<ColumnDetails>	getRefersTo() Returns the list of columns that this column refers to.
TableDetails	getTable() Returns the table details of the table that this column is part of.
com.incorta.io.Record.Type	getType() Returns the column type.
boolean	isForeignKey() Returns a boolean flag indicating whether this column is a foreign key (i.e.
boolean	isKey() Returns a boolean flag indicating whether this is a key column.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ColumnDetails

public ColumnDetails(TableDetails table,
                     com.incorta.io.Record.ColumnDef columnDef,
                     java.lang.String originalType,
                     java.util.Collection<ColumnDetails> refersTo)

Creates a new instance.

Parameters:

table - Table details

columnDef - Underlying column definition (including name, label and type)

originalType - The column type as defined in the original data source

refersTo - List of columns that this column refers to (used for joins)

Since:

1.0

Method Detail

getColumnDef

public com.incorta.io.Record.ColumnDef getColumnDef()

Returns the underlying column definition.

Returns:

Record.ColumnDef object

Since:

1.0

getName

public final java.lang.String getName()

Returns the column name.

Returns:

Column name

Since:

1.0

getLabel

public java.lang.String getLabel()

Returns the column label.

Returns:

Column label

Since:

1.0

getType

public final com.incorta.io.Record.Type getType()

Returns the column type.

Returns:

Column type

Since:

1.0

isKey

public final boolean isKey()

Returns a boolean flag indicating whether this is a key column.

Returns:

true if this is a key column, false otherwise

Since:

1.0

getTable

public TableDetails getTable()

Returns the table details of the table that this column is part of.

Returns:

TableDetails object

Since:

1.0

getOriginalType

public java.lang.String getOriginalType()

Returns the column type as defined in the data source.

Returns:

Original column type

Since:

1.0

getRefersTo

public java.util.List<ColumnDetails> getRefersTo()

Returns the list of columns that this column refers to. This is used for join discovery.

Returns:

List of ColumnDetails objects representing target columns

Since:

1.0

isForeignKey

public boolean isForeignKey()

Returns a boolean flag indicating whether this column is a foreign key (i.e. refers to other columns).

Returns:

true if this column is a foreign key, false otherwise.

Since:

1.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static ColumnDetails.Builder builder()

Creates a new builder object.

Returns:

A new ColumnDetails.Builder instance

Since:

1.0