JdbcTableColumn (Data Pipeline JavaDoc)

java.lang.Object
- com.northconcepts.datapipeline.foundations.core.Bean
- - com.northconcepts.datapipeline.foundations.jdbc.JdbcTableColumn

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, Serializable
```
public class JdbcTableColumn
extends Bean
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Comparator<JdbcTableColumn> NAME_COMPARATOR
- Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
  SERIALIZED_CLASS_NAME, TYPE
- Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
  XML_SERIALIZED_CLASS_NAME

Fields
Modifier and Type	Field and Description
`static Comparator<JdbcTableColumn>`	`NAME_COMPARATOR`

Constructor Summary

Constructors
Constructor and Description

JdbcTableColumn()

Constructors
Constructor and Description
`JdbcTableColumn()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JdbcTableColumn`	`fromRecord(Record source)` Loads this instance's state from a record and returns `this` (for fluid API call chaining).
`int`	`getByteCount()`
`String`	`getClassName()`
`String`	`getDatabaseTypeName()`
`int`	`getDecimals()`
`String`	`getDefaultValue()`
`String`	`getDefaultValueAsJavaString()` Converts the default value to a Java string literal suitable for code generation.
`FieldType`	`getFieldType()` Returns the `FieldType` corresponding to this column's Java type.
`String`	`getGetterMethod()`
`int`	`getIndex()` Index of column in table (starting at 1).
`Class<?>`	`getJavaType()`
`String`	`getMethodSuffix()`
`String`	`getName()`
`String`	`getNameAsJavaClassName()`
`String`	`getNameAsJavaIdentifier()`
`Integer`	`getPrimaryKeySequence()` Starting at 1.
`int`	`getRadix()`
`String`	`getRemarks()`
`Integer`	`getRowIdentifierSequence()`
`String`	`getSetterMethod()`
`int`	`getSize()`
`int`	`getSqlTypeIndex()` SQL type from `Types`
`JdbcTable`	`getTable()`
`boolean`	`isApproximateNumber()` Returns `true` if values of this type are numbers that do not contain exact quantities (DOUBLE, FLOAT, or REAL).
`boolean`	`isAutoIncrement()`
`boolean`	`isBinarySqlType()`
`boolean`	`isBooleanSqlType()`
`boolean`	`isEmptyDefaultValue()` Returns `true` if the default value is an empty string or the string "''".
`boolean`	`isExactNumber()` Returns `true` if values of this type are numbers that contain exact quantities (BIGINT, DECIMAL, INTEGER, NUMERIC, SMALLINT, TINYINT, SMALLINT).
`boolean`	`isGenerated()`
`boolean`	`isIntegerNumber()` Returns `true` if columns of this type are numbers that cannot contain fractions (byte, short, int, etc.).
`boolean`	`isNullable()`
`boolean`	`isNullDefaultValue()` Returns `true` if the default value is `null` or the string "NULL".
`boolean`	`isNumericSqlType()`
`boolean`	`isPrimaryKey()`
`boolean`	`isPseudo()`
`boolean`	`isRealNumber()` Returns `true` if columns of this type are numbers that can contain fractions.
`boolean`	`isRowIdentifier()`
`boolean`	`isSigned()`
`boolean`	`isTemporalSqlType()`
`boolean`	`isTextSqlType()`
`JdbcTableColumn`	`setAutoIncrement(boolean autoIncrement)`
`JdbcTableColumn`	`setByteCount(int byteCount)`
`JdbcTableColumn`	`setClassName(String className)`
`JdbcTableColumn`	`setDatabaseTypeName(String databaseTypeName)`
`JdbcTableColumn`	`setDecimals(int decimals)`
`JdbcTableColumn`	`setDefaultValue(String defaultValue)`
`JdbcTableColumn`	`setGenerated(boolean generated)`
`JdbcTableColumn`	`setIndex(int index)` Index of column in table (starting at 1).
`JdbcTableColumn`	`setJavaType(Class<?> javaType)`
`JdbcTableColumn`	`setName(String name)`
`JdbcTableColumn`	`setNullable(boolean nullable)`
`JdbcTableColumn`	`setPrimaryKeySequence(Integer primaryKeySequence)`
`JdbcTableColumn`	`setPseudo(boolean pseudo)`
`JdbcTableColumn`	`setRadix(int radix)`
`JdbcTableColumn`	`setRemarks(String remarks)`
`JdbcTableColumn`	`setRowIdentifierSequence(Integer rowIdentifierSequence)`
`JdbcTableColumn`	`setSigned(boolean signed)`
`JdbcTableColumn`	`setSize(int size)`
`JdbcTableColumn`	`setSqlTypeIndex(int sqlTypeIndex)` SQL type from `Types`
`protected JdbcTableColumn`	`setTable(JdbcTable table)`
`Record`	`toRecord()`

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean
addExceptionProperties, toString

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

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
fromArrayValue, fromArrayValue, fromArrayValue, fromJson, fromJson, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toJson, toJson, toJson, toRecord

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable
newInstanceFromJson

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
forEachGrandChildElement, fromXml, fromXml, fromXmlElement, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, toXmlElement, writeXml, writeXml

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor
addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties, exception, exception, exception

Field Detail

NAME_COMPARATOR

public static final Comparator<JdbcTableColumn> NAME_COMPARATOR

Constructor Detail
- JdbcTableColumn
```
public JdbcTableColumn()
```

Method Detail
- getTable
```
public JdbcTable getTable()
```
- setTable
```
protected JdbcTableColumn setTable(JdbcTable table)
```
- getName
```
public String getName()
```
- setName
```
public JdbcTableColumn setName(String name)
```
- getNameAsJavaClassName
```
public String getNameAsJavaClassName()
```
- getNameAsJavaIdentifier
```
public String getNameAsJavaIdentifier()
```
- getSqlTypeIndex
```
public int getSqlTypeIndex()
```
  SQL type from Types
- setSqlTypeIndex
```
public JdbcTableColumn setSqlTypeIndex(int sqlTypeIndex)
```
  SQL type from Types
- isBinarySqlType
```
public boolean isBinarySqlType()
```
- isTextSqlType
```
public boolean isTextSqlType()
```
- isNumericSqlType
```
public boolean isNumericSqlType()
```
- isBooleanSqlType
```
public boolean isBooleanSqlType()
```
- isTemporalSqlType
```
public boolean isTemporalSqlType()
```
- isRealNumber
```
public boolean isRealNumber()
```
  Returns true if columns of this type are numbers that can contain fractions.
- isIntegerNumber
```
public boolean isIntegerNumber()
```
  Returns true if columns of this type are numbers that cannot contain fractions (byte, short, int, etc.).
- isExactNumber
```
public boolean isExactNumber()
```
  Returns true if values of this type are numbers that contain exact quantities (BIGINT, DECIMAL, INTEGER, NUMERIC, SMALLINT, TINYINT, SMALLINT).
- isApproximateNumber
```
public boolean isApproximateNumber()
```
  Returns true if values of this type are numbers that do not contain exact quantities (DOUBLE, FLOAT, or REAL).
- getDatabaseTypeName
```
public String getDatabaseTypeName()
```
- setDatabaseTypeName
```
public JdbcTableColumn setDatabaseTypeName(String databaseTypeName)
```
- getSize
```
public int getSize()
```
- setSize
```
public JdbcTableColumn setSize(int size)
```
- getDecimals
```
public int getDecimals()
```
- setDecimals
```
public JdbcTableColumn setDecimals(int decimals)
```
- getRadix
```
public int getRadix()
```
- setRadix
```
public JdbcTableColumn setRadix(int radix)
```
- isNullable
```
public boolean isNullable()
```
- setNullable
```
public JdbcTableColumn setNullable(boolean nullable)
```
- getRemarks
```
public String getRemarks()
```
- setRemarks
```
public JdbcTableColumn setRemarks(String remarks)
```
- getDefaultValue
```
public String getDefaultValue()
```
- setDefaultValue
```
public JdbcTableColumn setDefaultValue(String defaultValue)
```
- isNullDefaultValue
```
public boolean isNullDefaultValue()
```
  Returns true if the default value is null or the string "NULL".
  
  Returns:
  
  true if the default value is null or "NULL", false otherwise
- isEmptyDefaultValue
```
public boolean isEmptyDefaultValue()
```
  Returns true if the default value is an empty string or the string "''".
  
  Returns:
  
  true if the default value is empty or "''", false otherwise
- getDefaultValueAsJavaString
```
public String getDefaultValueAsJavaString()
```
  Converts the default value to a Java string literal suitable for code generation.
  Returns null if the default value is null or "NULL", returns "" for empty strings, properly escapes text SQL types, and returns the default value as-is for primitive types. For non-primitive and non-string types, returns null.
  
  Returns:
  
  the default value as a Java string literal, or null if not convertible
- getByteCount
```
public int getByteCount()
```
- setByteCount
```
public JdbcTableColumn setByteCount(int byteCount)
```
- getIndex
```
public int getIndex()
```
  Index of column in table (starting at 1).
- setIndex
```
public JdbcTableColumn setIndex(int index)
```
  Index of column in table (starting at 1).
- isAutoIncrement
```
public boolean isAutoIncrement()
```
- setAutoIncrement
```
public JdbcTableColumn setAutoIncrement(boolean autoIncrement)
```
- isGenerated
```
public boolean isGenerated()
```
- setGenerated
```
public JdbcTableColumn setGenerated(boolean generated)
```
- isPseudo
```
public boolean isPseudo()
```
- setPseudo
```
public JdbcTableColumn setPseudo(boolean pseudo)
```
- getJavaType
```
public Class<?> getJavaType()
```
- setJavaType
```
public JdbcTableColumn setJavaType(Class<?> javaType)
```
- getFieldType
```
public FieldType getFieldType()
```
  Returns the FieldType corresponding to this column's Java type.
  If the Java type cannot be mapped to a FieldType, returns FieldType.UNDEFINED.
  
  Returns:
  
  the field type for this column, or FieldType.UNDEFINED if not mappable
- getMethodSuffix
```
public String getMethodSuffix()
```
- getGetterMethod
```
public String getGetterMethod()
```
- getSetterMethod
```
public String getSetterMethod()
```
- getPrimaryKeySequence
```
public Integer getPrimaryKeySequence()
```
  Starting at 1.
- setPrimaryKeySequence
```
public JdbcTableColumn setPrimaryKeySequence(Integer primaryKeySequence)
```
- isPrimaryKey
```
public boolean isPrimaryKey()
```
- getRowIdentifierSequence
```
public Integer getRowIdentifierSequence()
```
- setRowIdentifierSequence
```
public JdbcTableColumn setRowIdentifierSequence(Integer rowIdentifierSequence)
```
- isRowIdentifier
```
public boolean isRowIdentifier()
```
- getClassName
```
public String getClassName()
```
- setClassName
```
public JdbcTableColumn setClassName(String className)
```
- isSigned
```
public boolean isSigned()
```
- setSigned
```
public JdbcTableColumn setSigned(boolean signed)
```
- toRecord
```
public Record toRecord()
```
  Specified by:
  
  toRecord in interface RecordSerializable
  
  Overrides:
  
  toRecord in class Bean
- fromRecord
```
public JdbcTableColumn fromRecord(Record source)
```
  Description copied from interface: RecordSerializable
  
  Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.
  
  Specified by:
  
  fromRecord in interface RecordSerializable
  
  Overrides:
  
  fromRecord in class Bean
  
  Returns:
  
  this instance.

Class JdbcTableColumn

Field Summary

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

Constructor Summary

Method Summary

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean

Methods inherited from class java.lang.Object

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor

Field Detail

NAME_COMPARATOR

Constructor Detail

JdbcTableColumn

Method Detail

getTable

setTable

getName

setName

getNameAsJavaClassName

getNameAsJavaIdentifier

getSqlTypeIndex

setSqlTypeIndex

isBinarySqlType

isTextSqlType

isNumericSqlType

isBooleanSqlType

isTemporalSqlType

isRealNumber

isIntegerNumber

isExactNumber

isApproximateNumber

getDatabaseTypeName

setDatabaseTypeName

getSize

setSize

getDecimals

setDecimals

getRadix

setRadix

isNullable

setNullable

getRemarks

setRemarks

getDefaultValue

setDefaultValue

isNullDefaultValue

isEmptyDefaultValue

getDefaultValueAsJavaString

getByteCount

setByteCount

getIndex

setIndex

isAutoIncrement

setAutoIncrement

isGenerated

setGenerated

isPseudo

setPseudo

getJavaType

setJavaType

getFieldType

getMethodSuffix

getGetterMethod

getSetterMethod

getPrimaryKeySequence

setPrimaryKeySequence

isPrimaryKey

getRowIdentifierSequence

setRowIdentifierSequence

isRowIdentifier

getClassName

setClassName

isSigned

setSigned

toRecord

fromRecord