Jackcess 5.2.0 · io.github.spannm.jackcess.DataType · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private static final Map<Integer, DataType>	ALT_SQL_TYPES Alternate map of SQL types to Access data types
public static final DataType	BIG_BINARY A fixed length binary column longer than the 255 byte `BINARY`, which the engine calls "BigBinary".
public static final DataType	BIG_INT Corresponds to a java `Long`.
public static final DataType	BINARY Corresponds to a java `byte[]` of max length 255 bytes.
public static final DataType	BOOLEAN Corresponds to a java `Boolean`.
public static final DataType	BYTE Corresponds to a java `Byte`.
public static final DataType	COMPLEX_TYPE Complex type corresponds to a special `LONG` autonumber field which is the key for a secondary table which holds the "real" data.
private static final Map<Byte, DataType>	DATA_TYPES_BY_VALUE
private final int	defaultPrecision the default precision value
private final int	defaultScale the default scale value
private final int	defaultSize default size in bytes for var length columns
public static final DataType	DOUBLE Corresponds to a java `Double`.
public static final DataType	EXT_DATE_TIME Corresponds to a java `LocalDateTime` (with 7 digits of nanosecond precision).
private final Integer	fixedSize Size in bytes of fixed length columns
public static final DataType	FLOAT Corresponds to a java `Float`.
public static final DataType	GUID Corresponds to a java `String` with the pattern `"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"`, also known as a "Replication ID" in Access.
private final boolean	hasScalePrecision does this field have scale/precision
public static final DataType	INT Corresponds to a java `Short`.
public static final DataType	LONG Corresponds to a java `Integer`.
private final boolean	longValue is this a long value field
private final int	maxPrecision max precision value
private final int	maxScale max scale value
private final int	maxSize Max size in bytes for var length columns
public static final DataType	MEMO Corresponds to a java `String` of max length 8388607 chars.
private final int	minPrecision min precision value
private final int	minScale min scale value
private final int	minSize min in bytes size for var length columns
public static final DataType	MONEY Corresponds to a java `BigDecimal` with at most 4 decimal places.
public static final DataType	NUMERIC Corresponds to a java `BigDecimal`.
public static final DataType	OLE Corresponds to a java `byte[]` of max length 16777215 bytes.
public static final DataType	SHORT_DATE_TIME Corresponds to a java `Date` or `LocalDateTime`.
private static final Map<Integer, DataType[]>	SQL_TYPES Map of SQL types to Access data types
private final Integer	sqlType SQL type equivalent, or null if none defined
public static final DataType	TEXT Corresponds to a java `String` of max length 255 chars.
private final String	typeName display name of this type
private final int	unitSize the number of bytes per "unit" for this data type
public static final DataType	UNSUPPORTED_FIXEDLEN Dummy type for a fixed length type which is not currently supported.
public static final DataType	UNSUPPORTED_VARLEN Placeholder type for a variable length type which is not currently supported.
private final byte	value Internal Access value
private final boolean	variableLength is this a variable length field

Constructor Summary

Access	Constructor and Description
private	DataType(byte value, String typeName, Integer sqlType, Integer fixedSize)
private	DataType(byte value, String typeName, Integer sqlType, Integer fixedSize, boolean variableLength, boolean longValue, int minSize, int defaultSize, int maxSize, int unitSize)
private	DataType(byte value, String typeName, Integer sqlType, Integer fixedSize, boolean variableLength, boolean longValue, int minSize, int defaultSize, int maxSize, boolean hasScalePrecision, int minScale, int defaultScale, int maxScale, int minPrecision, int defaultPrecision, int maxPrecision, int unitSize)

Method Summary

Modifier and Type	Method and Description
private static void	addNewSqlType(String typeName, DataType type, DataType altType) Adds mappings for a sql type which was added after jdk 1.5 (using reflection).
public static DataType	fromByte(byte b)
public static DataType	fromSQLType(int sqlType)
public static DataType	fromSQLType(int sqlType, int lengthInUnits)
public static DataType	fromSQLType(int sqlType, int lengthInUnits, Database.FileFormat fileFormat)
public int	fromUnitSize(int size)
public int	fromUnitSize(int size, JetFormat format)
public int	getDefaultPrecision()
public int	getDefaultScale()
public int	getDefaultSize()
public int	getFixedSize()
public int	getFixedSize(Short colLength)
public boolean	getHasScalePrecision()
public int	getMaxPrecision()
public int	getMaxScale()
public int	getMaxSize()
public int	getMinPrecision()
public int	getMinScale()
public int	getMinSize()
public int	getSQLType()
public String	getTypeName()
public static String	getTypeName(short value)
public int	getUnitSize()
public int	getUnitSize(JetFormat format)
public byte	getValue()
public boolean	isLongValue()
public boolean	isMultipleAutoNumberAllowed()
public boolean	isSupported()
public boolean	isTextual()
public boolean	isTrueVariableLength()
public boolean	isValidPrecision(int precision)
public boolean	isValidScale(int scale)
public boolean	isValidSize(int size)
public boolean	isVariableLength()
private static boolean	isWithinRange(int value, int minValue, int maxValue)
public boolean	mayBeAutoNumber()
public int	toUnitSize(int size)
public int	toUnitSize(int size, JetFormat format)
public int	toValidPrecision(int precision)
private static int	toValidRange(int value, int minValue, int maxValue)
public int	toValidScale(int scale)
public int	toValidSize(int size)
public static DataType	valueOf(String name)
public static DataType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALT_SQL_TYPES	back to summary
private static final Map<Integer, DataType> ALT_SQL_TYPES Alternate map of SQL types to Access data types

BIG_BINARY	back to summary
public static final DataType BIG_BINARY A fixed length binary column longer than the 255 byte `BINARY`, which the engine calls "BigBinary". Only the `Data` column of `MSysAccessObjects` uses it, which holds the forms, reports and VBA of the database. Jet4 only, since Jet3 used `BINARY` for that column and the ACE engine dropped the table. Handled like a fixed length BINARY/OLE.

BIG_INT	back to summary
public static final DataType BIG_INT Corresponds to a java `Long`. Accepts any `Number` (using `Number#longValue`), Boolean as 1 or 0, any Object converted to a String and parsed as Double, or `null`. Equivalent to SQL `Types#BIGINT`.

BINARY	back to summary
public static final DataType BINARY Corresponds to a java `byte[]` of max length 255 bytes. Accepts a `byte[]`, or `null`. Equivalent to SQL `Types#BINARY`, `Types#VARBINARY`.

BOOLEAN	back to summary
public static final DataType BOOLEAN Corresponds to a java `Boolean`. Accepts Boolean or `null` (which is considered `false`). Equivalent to SQL `Types#BOOLEAN`.

BYTE	back to summary
public static final DataType BYTE Corresponds to a java `Byte`. Accepts any `Number` (using `Number#byteValue`), Boolean as 1 or 0, any Object converted to a String and parsed as Double, or `null`. Equivalent to SQL `Types#TINYINT`, `Types#BIT`.

COMPLEX_TYPE	back to summary
public static final DataType COMPLEX_TYPE Complex type corresponds to a special `LONG` autonumber field which is the key for a secondary table which holds the "real" data.

DATA_TYPES_BY_VALUE	back to summary
private static final Map<Byte, DataType> DATA_TYPES_BY_VALUE

defaultPrecision	back to summary
private final int defaultPrecision the default precision value

defaultScale	back to summary
private final int defaultScale the default scale value

defaultSize	back to summary
private final int defaultSize default size in bytes for var length columns

DOUBLE	back to summary
public static final DataType DOUBLE Corresponds to a java `Double`. Accepts any `Number` (using `Number#doubleValue`), Boolean as 1 or 0, any Object converted to a String and parsed as Double, or `null`. Equivalent to SQL `Types#DOUBLE`, `Types#REAL`.

EXT_DATE_TIME	back to summary
public static final DataType EXT_DATE_TIME Corresponds to a java `LocalDateTime` (with 7 digits of nanosecond precision). Accepts a Date, LocalDateTime (or related types), any `Number` (using `Number#longValue`), or `null`. Equivalent to SQL `Types#TIMESTAMP`, `Types#DATE`, `Types#TIME`.

fixedSize	back to summary
private final Integer fixedSize Size in bytes of fixed length columns

FLOAT	back to summary
public static final DataType FLOAT Corresponds to a java `Float`. Accepts any `Number` (using `Number#floatValue`), Boolean as 1 or 0, any Object converted to a String and parsed as Double, or `null`. Equivalent to SQL `Types#FLOAT`.

GUID	back to summary
public static final DataType GUID Corresponds to a java `String` with the pattern `"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"`, also known as a "Replication ID" in Access. Accepts any Object converted to a String matching this pattern (surrounding "{}" are optional, so `java.util.UUID`s are supported), or `null`.

hasScalePrecision	back to summary
private final boolean hasScalePrecision does this field have scale/precision

INT	back to summary
public static final DataType INT Corresponds to a java `Short`. Accepts any `Number` (using `Number#shortValue`), Boolean as 1 or 0, any Object converted to a String and parsed as Double, or `null`. Equivalent to SQL `Types#SMALLINT`.

LONG	back to summary
public static final DataType LONG Corresponds to a java `Integer`. Accepts any `Number` (using `Number#intValue`), Boolean as 1 or 0, any Object converted to a String and parsed as Double, or `null`. Equivalent to SQL `Types#INTEGER`, `Types#BIGINT`.

longValue	back to summary
private final boolean longValue is this a long value field

maxPrecision	back to summary
private final int maxPrecision max precision value

maxScale	back to summary
private final int maxScale max scale value

maxSize	back to summary
private final int maxSize Max size in bytes for var length columns

MEMO	back to summary
public static final DataType MEMO Corresponds to a java `String` of max length 8388607 chars. Accepts any `CharSequence`, any Object converted to a String , or `null`. Equivalent to SQL `Types#LONGVARCHAR`, `Types#CLOB`.

minPrecision	back to summary
private final int minPrecision min precision value

minScale	back to summary
private final int minScale min scale value

minSize	back to summary
private final int minSize min in bytes size for var length columns

MONEY	back to summary
public static final DataType MONEY Corresponds to a java `BigDecimal` with at most 4 decimal places. Accepts any `Number` (using `Number#doubleValue`), a BigInteger, a BigDecimal (with at most 4 decimal places), Boolean as 1 or 0, any Object converted to a String and parsed as BigDecimal, or `null`. Equivalent to SQL `Types#DECIMAL`.

NUMERIC	back to summary
public static final DataType NUMERIC Corresponds to a java `BigDecimal`. Accepts any `Number` (using `Number#doubleValue`), a `BigInteger`, a BigDecimal, Boolean as 1 or 0, any Object converted to a String and parsed as BigDecimal, or `null`. Equivalent to SQL `Types#NUMERIC`.

OLE	back to summary
public static final DataType OLE Corresponds to a java `byte[]` of max length 16777215 bytes. Accepts a `byte[]`, or `null`. Equivalent to SQL `Types#LONGVARBINARY`, `Types#BLOB`.

SHORT_DATE_TIME	back to summary
public static final DataType SHORT_DATE_TIME Corresponds to a java `Date` or `LocalDateTime`. Accepts a Date, LocalDateTime (or related types), any `Number` (using `Number#longValue`), or `null`. Equivalent to SQL `Types#TIMESTAMP`, `Types#DATE`, `Types#TIME`.

SQL_TYPES	back to summary
private static final Map<Integer, DataType[]> SQL_TYPES Map of SQL types to Access data types

sqlType	back to summary
private final Integer sqlType SQL type equivalent, or null if none defined

TEXT	back to summary
public static final DataType TEXT Corresponds to a java `String` of max length 255 chars. Accepts any `CharSequence`, any Object converted to a String , or `null`. Equivalent to SQL `Types#VARCHAR`, `Types#CHAR`.

typeName	back to summary
private final String typeName display name of this type

unitSize	back to summary
private final int unitSize the number of bytes per "unit" for this data type

UNSUPPORTED_FIXEDLEN	back to summary
public static final DataType UNSUPPORTED_FIXEDLEN Dummy type for a fixed length type which is not currently supported. Handled like a fixed length `BINARY`.

UNSUPPORTED_VARLEN	back to summary
public static final DataType UNSUPPORTED_VARLEN Placeholder type for a variable length type which is not currently supported. Handled like `BINARY`.

value	back to summary
private final byte value Internal Access value

variableLength	back to summary
private final boolean variableLength is this a variable length field

Constructor Detail

DataType	back to summary
private DataType(byte value, String typeName, Integer sqlType, Integer fixedSize)

DataType	back to summary
private DataType(byte value, String typeName, Integer sqlType, Integer fixedSize, boolean variableLength, boolean longValue, int minSize, int defaultSize, int maxSize, int unitSize)

DataType	back to summary
private DataType(byte value, String typeName, Integer sqlType, Integer fixedSize, boolean variableLength, boolean longValue, int minSize, int defaultSize, int maxSize, boolean hasScalePrecision, int minScale, int defaultScale, int maxScale, int minPrecision, int defaultPrecision, int maxPrecision, int unitSize)

Method Detail

addNewSqlType	back to summary
private static void addNewSqlType(String typeName, DataType type, DataType altType) Adds mappings for a sql type which was added after jdk 1.5 (using reflection).

fromByte	back to summary
public static DataType fromByte(byte b) throws IOException

fromSQLType	back to summary
public static DataType fromSQLType(int sqlType) throws IOException

fromSQLType	back to summary
public static DataType fromSQLType(int sqlType, int lengthInUnits) throws IOException

fromSQLType	back to summary
public static DataType fromSQLType(int sqlType, int lengthInUnits, Database.FileFormat fileFormat) throws IOException

fromUnitSize	back to summary
public int fromUnitSize(int size)

fromUnitSize	back to summary
public int fromUnitSize(int size, JetFormat format)

getDefaultPrecision	back to summary
public int getDefaultPrecision()

getDefaultScale	back to summary
public int getDefaultScale()

getDefaultSize	back to summary
public int getDefaultSize()

getFixedSize	back to summary
public int getFixedSize()

getFixedSize	back to summary
public int getFixedSize(Short colLength)

getHasScalePrecision	back to summary
public boolean getHasScalePrecision()

getMaxPrecision	back to summary
public int getMaxPrecision()

getMaxScale	back to summary
public int getMaxScale()

getMaxSize	back to summary
public int getMaxSize()

getMinPrecision	back to summary
public int getMinPrecision()

getMinScale	back to summary
public int getMinScale()

getMinSize	back to summary
public int getMinSize()

getSQLType	back to summary
public int getSQLType() throws IOException

getTypeName	back to summary
public String getTypeName()

getTypeName	back to summary
public static String getTypeName(short value)

getUnitSize	back to summary
public int getUnitSize()

getUnitSize	back to summary
public int getUnitSize(JetFormat format)

getValue	back to summary
public byte getValue()

isLongValue	back to summary
public boolean isLongValue()

isMultipleAutoNumberAllowed	back to summary
public boolean isMultipleAutoNumberAllowed()

isSupported	back to summary
public boolean isSupported()

isTextual	back to summary
public boolean isTextual()

isTrueVariableLength	back to summary
public boolean isTrueVariableLength()

isValidPrecision	back to summary
public boolean isValidPrecision(int precision)

isValidScale	back to summary
public boolean isValidScale(int scale)

isValidSize	back to summary
public boolean isValidSize(int size)

isVariableLength	back to summary
public boolean isVariableLength()

isWithinRange	back to summary
private static boolean isWithinRange(int value, int minValue, int maxValue)

mayBeAutoNumber	back to summary
public boolean mayBeAutoNumber()

toUnitSize	back to summary
public int toUnitSize(int size)

toUnitSize	back to summary
public int toUnitSize(int size, JetFormat format)

toValidPrecision	back to summary
public int toValidPrecision(int precision)

toValidRange	back to summary
private static int toValidRange(int value, int minValue, int maxValue)

toValidScale	back to summary
public int toValidScale(int scale)

toValidSize	back to summary
public int toValidSize(int size)

valueOf	back to summary
public static DataType valueOf(String name)

values	back to summary
public static DataType[] values()

public final Enum DataType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail