Package com.healthmarketscience.jackcess

Interface Column

  • All Known Implementing Classes:
    ColumnImpl
    public interface Column
    Access database column definition. A Table has a list of Column instances describing the table schema.

    A Column instance is not thread-safe (see Database for more thread-safety details).

    Author:
    James Ahlborn
    Usage:
    General: This class is general use.

    • Field Detail

      • AUTO_NUMBER

        static final Object AUTO_NUMBER
        Meaningless placeholder object for inserting values in an autonumber column. it is not required that this value be used (any passed in value is ignored), but using this placeholder may make code more obvious.
        Usage:
        General: This field is general use.

      • KEEP_VALUE

        static final Object KEEP_VALUE
        Meaningless placeholder object for updating rows which indicates that a given column should keep its existing value.
        Usage:
        General: This field is general use.

    • Method Detail

      • getTable

        Table getTable()
        Usage:
        General: This method is general use.

      • getDatabase

        Database getDatabase()
        Usage:
        General: This method is general use.

      • getName

        String getName()
        Usage:
        General: This method is general use.

      • isVariableLength

        boolean isVariableLength()
        Usage:
        Advanced: This method is for advanced/internal use.

      • isAutoNumber

        boolean isAutoNumber()
        Usage:
        General: This method is general use.

      • getColumnIndex

        int getColumnIndex()
        Usage:
        Advanced: This method is for advanced/internal use.

      • getType

        DataType getType()
        Usage:
        General: This method is general use.

      • getSQLType

        int getSQLType()
        throws IOException
        Throws:
        IOException
        Usage:
        General: This method is general use.

      • isCompressedUnicode

        boolean isCompressedUnicode()
        Usage:
        General: This method is general use.

      • getPrecision

        byte getPrecision()
        Usage:
        General: This method is general use.

      • getScale

        byte getScale()
        Usage:
        General: This method is general use.

      • getLength

        short getLength()
        Usage:
        General: This method is general use.

      • getLengthInUnits

        short getLengthInUnits()
        Usage:
        General: This method is general use.

      • isAppendOnly

        boolean isAppendOnly()
        Whether or not this column is "append only" (its history is tracked by a separate version history column).
        Usage:
        General: This method is general use.

      • isHyperlink

        boolean isHyperlink()
        Returns whether or not this is a hyperlink column (only possible for columns of type MEMO).
        Usage:
        General: This method is general use.

      • isCalculated

        boolean isCalculated()
        Returns whether or not this is a calculated column. Note that jackess won't interpret the calculation expression (but the field can be written directly).
        Usage:
        General: This method is general use.

      • getComplexInfo

        ComplexColumnInfo<? extends ComplexValue> getComplexInfo()
        Returns extended functionality for "complex" columns.
        Usage:
        General: This method is general use.

      • getProperties

        PropertyMap getProperties()
                   throws IOException
        Returns:
        the properties for this column
        Throws:
        IOException
        Usage:
        General: This method is general use.

      • getVersionHistoryColumn

        Column getVersionHistoryColumn()
        Returns the column which tracks the version history for an "append only" column.
        Usage:
        Intermediate: This method requires moderate API knowledge.

      • getColumnValidator

        ColumnValidator getColumnValidator()
        Gets currently configured ColumnValidator (always non-null).
        Usage:
        Intermediate: This method requires moderate API knowledge.

      • setColumnValidator

        void setColumnValidator​(ColumnValidator newValidator)
        Sets a new ColumnValidator. If null, resets to the value returned from the Database's ColumnValidatorFactory (if the factory returns null, then the default is used). Autonumber columns cannot have a validator instance other than the default.
        Throws:
        IllegalArgumentException - if an attempt is made to set a non-null ColumnValidator instance on an autonumber column
        Usage:
        Intermediate: This method requires moderate API knowledge.