Column Info
Overview
The ColumnInfo class holds information about a column in a data source, such as a database table, and extends basic database metadata with Servoy-specific details. It provides methods to manage various aspects of the column, including its ID, persistence, and flags. For columns with auto-enter properties, it supports types like system values, sequences, and custom values, with configurable subtypes for each.
The class allows for the configuration of column properties such as default values, lookup values, titles, descriptions, and formatting. For sequences, it manages sequence names, step sizes, and the next value, while also supporting foreign keys with the foreignType property.
Additionally, the class offers tools for managing column types, including getConfiguredColumnType() for retrieving the developer-configured column type, and getCompatibleColumnTypes() for checking column type compatibility. Flags can be set and checked to track column attributes, and detailed property information can be retrieved or converted to HTML format.
Properties Summarized
The subtype of autoenter configured for the column.
The type of autoenter configured for the column.
The name of the converter used for this column.
The properties of the converter used for this column.
The database default value that is used when autoenter is set to database default.
The database sequence name that is used when autoenter is set to sequence and autoenter subtype is set to database sequence.
The default format of the column.
The value that is used when autoenter is set to custom value.
The description of the column.
The foreign type of the column.
The lookup value that is used when autotype is set to lookup.
The title of the column.
The name of the validator used for the column.
The properties of the validator used for the column.
Properties Detailed
autoEnterSubType
The subtype of autoenter configured for the column. The available options depend on the type of autoenter.
If autoenter is set to system value, then the subtype can be one of: none, creation datetime, creation username, modification datetime, modification username, database managed, creation user uid, modification user uid, creation server datetime or modification server datetime.
If autoenter is set to sequence, then the subtype can be one of: none, Servoy sequence, database sequence, database identity or universally unique identifier.
autoEnterType
The type of autoenter configured for the column. Can be one of: none, system value, sequence, custom value or lookup value.
converterName
The name of the converter used for this column.
converterProperties
The properties of the converter used for this column.
databaseDefaultValue
The database default value that is used when autoenter is set to database default.
databaseSequenceName
The database sequence name that is used when autoenter is set to sequence and autoenter subtype is set to database sequence.
defaultFormat
The default format of the column. Currently only strings or numbers are supported.
defaultValue
The value that is used when autoenter is set to custom value.
description
The description of the column.
foreignType
The foreign type of the column. It is used for foreign key columns, to hold the foreign table they point to.
lookupValue
The lookup value that is used when autotype is set to lookup.
titleText
The title of the column.
validatorName
The name of the validator used for the column.
validatorProperties
The properties of the validator used for the column.
Last updated
Was this helpful?