com.simba.dsi.dataengine.utilities
Enum MetadataSourceColumnTag

java.lang.Object
  extended by java.lang.Enum<MetadataSourceColumnTag>
      extended by com.simba.dsi.dataengine.utilities.MetadataSourceColumnTag
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<MetadataSourceColumnTag>

public enum MetadataSourceColumnTag
extends java.lang.Enum<MetadataSourceColumnTag>

A MetadataSourceColumnTag value identifies a specific metadata column tag that can retrieved using IMetadataSource.getMetadata().


Enum Constant Summary
AUTO_UNIQUE
          Identifies whether the data type is autoincrementing.
BUFFER_LENGTH
          Identifies that this column holds the buffer length for the data type.
CASE_SENSITIVE
          Identifies whether a character data type is case sensitive in collations and comparisons.
CATALOG_NAME
          Identifies this column holds the catalog name.
CHAR_OCTET_LENGTH
          Identifies the maximum length in bytes of a character or binary data type column.
COLUMN_DEF
          Indicates the default value for the column.
COLUMN_NAME
          Identifies that this column holds the column name.
COLUMN_SIZE
          Identifies that this column holds the column size for the data type.
COLUMN_USAGE
          Identifies the allowed usage for the column.
CREATE_PARAM
          Identifies that this column holds the list of keywords, separated by commas, corresponding to each parameter that the application may specify in parentheses when using the name that is returned in the TYPE_NAME field.
DATA_TYPE
          Identifies that this column holds the data type for the column the contents of this column.
DATA_TYPE_NAME
          Identifies that this column holds the data source-dependent type name.
DECIMAL_DIGITS
          Identifies that this column holds the total number of significant digits to the right of the decimal point.
DEFERRABILITY
          Identifies the deferability.
FIXED_PREC_SCALE
          Identifies whether the data type has predefined fixed precision and scale.
FOREIGN_KEY_CATALOG_NAME
          Identifies the Foreign Key catalog name.
FOREIGN_KEY_COLUMN_NAME
          Identifies the Foreign Key column name.
FOREIGN_KEY_DELETE_RULE
          Identifies the action applied to the foreign key when the SQL operation is DELETE.
FOREIGN_KEY_NAME
          Identifies the foreign key name.
FOREIGN_KEY_SCHEMA_NAME
          Identifies the Foreign Key schema name.
FOREIGN_KEY_TABLE_NAME
          Identifies the Foreign Key table name.
FOREIGN_KEY_UPDATE_RULE
          Identifies the action applied to the foreign key when the SQL operation is UPDATE.
GRANTEE
          Identifies that this column holds the grantee name.
GRANTOR
          Identifies that this column holds the grantor name.
IDENTIFIER_TYPE_TAG
          Is a restriction column passed to the Metadata Source for Special Columns.
INDEX_CARDINALITY
          Identifies: The cardinality of the table or index; The number of rows in table if INDEX_TYPE is SQL_TABLE_STAT; The number of unique values in the index if INDEX_TYPE is not SQL_TABLE_STAT; The DSII should call setNull(true) if the value for this key is not available from the data source.
INDEX_FILTER_CONDITION
          Identifies if the index is a filtered index, this is the filter condition, such as SALARY > 30000; if the filter condition cannot be determined, the value for this key is an empty string.
INDEX_NAME
          Identifies the Index name.
INDEX_PAGES
          Identifies: The number of pages used to store the index or table; The number of pages for the table if INDEX_TYPE is SQL_TABLE_STAT; The number of pages for the index if INDEX_TYPE is not SQL_TABLE_STAT; The DSII should call setNull(true) if the value for this key is not available from the data source.
INDEX_QUALIFIER
          Identifies the identifier that is used to qualify the index name doing a DROP INDEX;
INDEX_SORT_SEQUENCE
          Identifies the sort sequence for the column.
INDEX_TYPE
          Identifies the type of information being returned by the index.
INTERVAL_PRECISION
          Identifies that this column contains the interval leading precision for an interval data type
IS_AUTOINCREMENT
          The value for this column will be one of the following: "NO" : If the column is not auto incremented "YES" : If the column is auto incremented "" : If it cannot be determined whether the column is auto incremented This column returns a zero-length string if nullability is unknown.
IS_GENERATEDCOLUMN
          The value for this column will be one of the following: "NO" : If this a generated column "YES" : If this not a generated column "" : If it cannot be determined whether this is a generated column This column returns a zero-length string if nullability is unknown.
IS_NULLABLE
          The value for this column will be one of the following: "NO" If the column does not include NULLs.
IS_RESULT_SET
          A custom DSI column tag that specifies whether the current row is a parameter or a result set column.
ISGRANTABLE
          This column identifies if the grantee is permitted to grant privilege to others.
KEY_SEQ
          Identifies the column sequence number within either the primary or foreign key.
LITERAL_PREFIX
          Identifies that this column holds the character(s) used to prefix a literal.
LITERAL_SUFFIX
          pIdentifies that this column holds the character(s) used to terminate a literal.
LOCAL_TYPE_NAME
          Identifies that this column contains the localized version of the data source dependent name of the data type
MAXIMUM_SCALE
          Identifies that this column contains the maximum scale of the data type.
MINIMUM_SCALE
          Identifies that this column contains the minimum scale of the data type.
NON_UNIQUE_INDEX
          Identifies whether the index does not allow duplicate values.
NULLABLE
          Identifies that the column can hold a NULL value.
NULLABLE_TAG
          Is a restriction column passed to the Metadata Source for Special Columns.
NUM_INPUT_PARAMS
          Identifies this column holds the number of input parameters.
NUM_OUTPUT_PARAMS
          Identifies this column holds the number of output parameters.
NUM_PREC_RADIX
          Identifies that this column contains the following:
NUM_RESULT_SETS
          Identifies this column holds the number of result sets.
ORDINAL_POSITION
          Identifies the ordinal position of the column in the table.
PRIMARY_KEY_CATALOG_NAME
          Identifies the Primary Key catalog name.
PRIMARY_KEY_COLUMN_NAME
          Identifies the Primary Key column name.
PRIMARY_KEY_NAME
          Identifies the primary key name.
PRIMARY_KEY_SCHEMA_NAME
          Identifies the Primary Key schema name.
PRIMARY_KEY_TABLE_NAME
          Identifies the Primary Key table name.
PRIVILEGE
          Identifies this column holds the column privilege.
PROCEDURE_COLUMN_TYPE
          Identifies whether the procedure column is a parameter or a result set column:
PROCEDURE_NAME
          Identifies this column holds the procedure or function name.
PROCEDURE_TYPE
          Identifies this column holds the procedure type.
PSEUDO
          Indicates whether the column is a pseudo-column, such as Oracle ROWID.
REMARKS
          Identifies this column holds the column tag.
RESERVED_TAG
          Is a restriction column passed to the Metadata Source for Statistics Columns.
SCHEMA_NAME
          Identifies this column holds the schema name.
SCOPE
          Indicates the scope of the rowid.
SEARCHABLE
          Identifies how the data type is used in a WHERE clause.
SPECIFIC_NAME
          Identifies this column holds the specific name for a procedure or a function.
SQL_DATA_TYPE
          Identifies the SQL Data Type, as it is to appear in the Implicit Row Descriptor record for the column.
SQL_DATETIME_SUB
          Identifies the subtype code for datetime and interval data types.
TABLE_NAME
          Identifies this column holds the table name.
TABLE_TYPE
          Identifies this column holds the table type.
UNIQUE_TAG
          Is a restriction column passed to the Metadata Source for Statistics Columns.
UNSIGNED_ATTRIBUTE
          Identifies whether the data type is unsigned.
USER_DATA_TYPE
          A custom DSI column tag that identifies the User Data Type.
 
Method Summary
static MetadataSourceColumnTag valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static MetadataSourceColumnTag[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

CATALOG_NAME

public static final MetadataSourceColumnTag CATALOG_NAME
Identifies this column holds the catalog name.


SCHEMA_NAME

public static final MetadataSourceColumnTag SCHEMA_NAME
Identifies this column holds the schema name.


TABLE_NAME

public static final MetadataSourceColumnTag TABLE_NAME
Identifies this column holds the table name.


TABLE_TYPE

public static final MetadataSourceColumnTag TABLE_TYPE
Identifies this column holds the table type.


REMARKS

public static final MetadataSourceColumnTag REMARKS
Identifies this column holds the column tag.


PROCEDURE_NAME

public static final MetadataSourceColumnTag PROCEDURE_NAME
Identifies this column holds the procedure or function name.


NUM_INPUT_PARAMS

public static final MetadataSourceColumnTag NUM_INPUT_PARAMS
Identifies this column holds the number of input parameters.


NUM_OUTPUT_PARAMS

public static final MetadataSourceColumnTag NUM_OUTPUT_PARAMS
Identifies this column holds the number of output parameters.


NUM_RESULT_SETS

public static final MetadataSourceColumnTag NUM_RESULT_SETS
Identifies this column holds the number of result sets.


PROCEDURE_TYPE

public static final MetadataSourceColumnTag PROCEDURE_TYPE
Identifies this column holds the procedure type.

Must be one of the following values:


COLUMN_NAME

public static final MetadataSourceColumnTag COLUMN_NAME
Identifies that this column holds the column name.


GRANTOR

public static final MetadataSourceColumnTag GRANTOR
Identifies that this column holds the grantor name.


GRANTEE

public static final MetadataSourceColumnTag GRANTEE
Identifies that this column holds the grantee name.


PRIVILEGE

public static final MetadataSourceColumnTag PRIVILEGE
Identifies this column holds the column privilege.

Must be one of the following values:


ISGRANTABLE

public static final MetadataSourceColumnTag ISGRANTABLE
This column identifies if the grantee is permitted to grant privilege to others.

Must be one of the following values:


DATA_TYPE

public static final MetadataSourceColumnTag DATA_TYPE
Identifies that this column holds the data type for the column the contents of this column. Could be either the SQL Data Type or the data source specific data type.


DATA_TYPE_NAME

public static final MetadataSourceColumnTag DATA_TYPE_NAME
Identifies that this column holds the data source-dependent type name.

For example: "CHAR", "VARCHAR", "MONEY", etc...


COLUMN_SIZE

public static final MetadataSourceColumnTag COLUMN_SIZE
Identifies that this column holds the column size for the data type.

If DATA_TYPE is SQL_CHAR or SQL_VARCHAR, this column contains the maximum length in characters of the column. For datetime data types, this is the total number of characters required to display the value when it is converted to characters.

For numeric data types, this is either the total number of digits or the total number of bits allowed in the column, according to the NUM_PREC_RADIX column.

For interval data types, this is the number of characters in the character representation of the interval literal (as defined by the interval leading precision, see Interval Data Type Length ( http://msdn2.microsoft.com/en-us/library/ms716230.aspx) in Appendix D: Data Types.

For more information, see Column Size, Decimal Digits, Transfer Octet Length, and Display Size in Appendix D: Data Types ( http://msdn2.microsoft.com/en-us/library/ms712499.aspx).


BUFFER_LENGTH

public static final MetadataSourceColumnTag BUFFER_LENGTH
Identifies that this column holds the buffer length for the data type.

The length in bytes of data transferred on an SQLGetData, SQLFetch, or SQLFetchScroll operation if SQL_C_DEFAULT is specified.

For numeric data, this size may differ from the size of the data stored on the data source.

This value might differ from COLUMN_SIZE column for character data.

For more information about length, see Column Size, Decimal Digits, Transfer Octet Length, and Display Size ( http://msdn2.microsoft.com/en-us/library/ms712499.aspx) in Appendix D: Data Types.


DECIMAL_DIGITS

public static final MetadataSourceColumnTag DECIMAL_DIGITS
Identifies that this column holds the total number of significant digits to the right of the decimal point.

For SQL_TYPE_TIME and SQL_TYPE_TIMESTAMP, this column contains the number of digits in the fractional seconds component.

For the other data types, this is the decimal digits of the column on the data source.

For interval data types that contain a time component, this column contains the number of digits to the right of the decimal point (fractional seconds).

For interval data types that do not contain a time component, this column is 0.

For more information about decimal digits, see Column Size, Decimal Digits, Transfer Octet Length, and Display Size ( http://msdn2.microsoft.com/en-us/library/ms712499.aspx) in Appendix D: Data Types.

The DSII should call SetNull(true) for columns of data types where the DECIMAL_DIGITS is not applicable.


NUM_PREC_RADIX

public static final MetadataSourceColumnTag NUM_PREC_RADIX
Identifies that this column contains the following:

For numeric data types, either 10 or 2. If it is 10, the values in COLUMN_SIZE and DECIMAL_DIGITS give the number of decimal digits allowed for the column. For example a DECIMAL(12,5) column would return 10 for the NUM_PREC_RADIX, 12 for the COLUMN_SIZE and 5 for the DECIMAL_DIGITS.

A FLOAT column could return 10 for the NUM_PREC_RADIC, 15 for the COLUMN_SIZE and SetNull(true) on the SQLData provided for the DECIMAL_DIGITS.

If it is 2, the values for the COLUMN_SIZE and DECIMAL_DIGITS give the number of bits allowed in the column. For example, a FLOAT column could return 2 for the NUM_PREC_RADIX, 53 for COLUMN_SIZE, and a SetNull(true) on the SQLData provided for the DECIMAL_DIGITS.

The DSII should call SetNull(true) for columns of data types where the NUM_PREC_RADIX is not applicable.


NULLABLE

public static final MetadataSourceColumnTag NULLABLE
Identifies that the column can hold a NULL value.

Must be one of the following values:

The value returned for this column differs from the value returned for the IS_NULLABLE. This column indicates with certainty that a column can accept NULLS, but cannot indicate with certainty that a column does not accept NULLs. The value for the IS_NULLABLE column indicates with certainty that a column cannot accept NULLs, but cannot indicate with certainty that a column accepts NULLs.


COLUMN_DEF

public static final MetadataSourceColumnTag COLUMN_DEF
Indicates the default value for the column.


SQL_DATA_TYPE

public static final MetadataSourceColumnTag SQL_DATA_TYPE
Identifies the SQL Data Type, as it is to appear in the Implicit Row Descriptor record for the column.

This can be an ODBC SQL data type or a driver-specific SQL data type. This column is the same as the DATA_TYPE column, except for datetime and interval data types.

This column returns the nonconcise data type (such as SQL_DATETIME or SQL_INTERVAL), instead of the concise data type (such as SQL_TYPE_DATE or SQL_INTERVAL_YEAR_TO_MONTH) for datetime and interval data types. If this column returns SQL_DATETIME or SQL_INTERVAL, the specific data type can be determined from the SQL_DATETIME_SUB column.

For a list of valid ODBC SQL data types, see SQL Data Types in Appendix D: Data Types ( http://msdn2.microsoft.com/en-us/library/ms710150.aspx).


SQL_DATETIME_SUB

public static final MetadataSourceColumnTag SQL_DATETIME_SUB
Identifies the subtype code for datetime and interval data types. For all other data types, this DSII will call setNull(true) on the SQLData provided for the column value.

For more information about datetime and interval subcodes, see "SQL_DESC_DATETIME_INTERVAL_CODE" in SQLSetDescField ( http://msdn2.microsoft.com/en-us/library/ms713560.aspx).


CHAR_OCTET_LENGTH

public static final MetadataSourceColumnTag CHAR_OCTET_LENGTH
Identifies the maximum length in bytes of a character or binary data type column.

For all other data types, this DSII will call SetNull(true) on the SQLData provided for the column value.


ORDINAL_POSITION

public static final MetadataSourceColumnTag ORDINAL_POSITION
Identifies the ordinal position of the column in the table. The first column in the table is number 1.


IS_NULLABLE

public static final MetadataSourceColumnTag IS_NULLABLE
The value for this column will be one of the following: This column returns a zero-length string if nullability is unknown.

The value returned for this column differs from the value returned for the NULLABLE column. (See the description for NULLABLE)


PROCEDURE_COLUMN_TYPE

public static final MetadataSourceColumnTag PROCEDURE_COLUMN_TYPE
Identifies whether the procedure column is a parameter or a result set column:

Must be one of the following values:


PRIMARY_KEY_CATALOG_NAME

public static final MetadataSourceColumnTag PRIMARY_KEY_CATALOG_NAME
Identifies the Primary Key catalog name.

The DSII should call setNull(true) on the SQLData provided for the this key, in the event that catalog names are not applicable to the data source.

If catalogs are supported for some tables but not for others, the buffer of the SQLData provided for this key is set to the empty string "".


PRIMARY_KEY_SCHEMA_NAME

public static final MetadataSourceColumnTag PRIMARY_KEY_SCHEMA_NAME
Identifies the Primary Key schema name.

The DSII should call setNull(true) on the SQLData provided for the this key, in the event that schema names are not applicable to the data source.

If schemas are supported for some tables but not for others, the buffer of the SQLData provided for this key is set to the empty string "".


PRIMARY_KEY_TABLE_NAME

public static final MetadataSourceColumnTag PRIMARY_KEY_TABLE_NAME
Identifies the Primary Key table name.


PRIMARY_KEY_COLUMN_NAME

public static final MetadataSourceColumnTag PRIMARY_KEY_COLUMN_NAME
Identifies the Primary Key column name.

The buffer of the SQLData provided for this key is set to the empty string "" if the column does not have a name.


PRIMARY_KEY_NAME

public static final MetadataSourceColumnTag PRIMARY_KEY_NAME
Identifies the primary key name.

The DSII should call SetNull(true) on the SQLData provided for the this key, in the event that primary key names are not applicable to the data source.


FOREIGN_KEY_CATALOG_NAME

public static final MetadataSourceColumnTag FOREIGN_KEY_CATALOG_NAME
Identifies the Foreign Key catalog name.

The DSII should call SetNull(true) on the SQLData provided for the this key, in the event that catalog names are not applicable to the data source.

If catalogs are supported for some tables but not for others, the buffer of the SQLData provided for this key is set to the empty string "".


FOREIGN_KEY_SCHEMA_NAME

public static final MetadataSourceColumnTag FOREIGN_KEY_SCHEMA_NAME
Identifies the Foreign Key schema name.

The DSII should call SetNull(true) on the SQLData provided for the this key, in the event that schema names are not applicable to the data source.

If schemas are supported for some tables but not for others, the buffer of the SQLData provided for this key is set to the empty string "".


FOREIGN_KEY_TABLE_NAME

public static final MetadataSourceColumnTag FOREIGN_KEY_TABLE_NAME
Identifies the Foreign Key table name.


FOREIGN_KEY_COLUMN_NAME

public static final MetadataSourceColumnTag FOREIGN_KEY_COLUMN_NAME
Identifies the Foreign Key column name.

The buffer of the SQLData provided for this key is set to the empty string "" if the column does not have a name.


KEY_SEQ

public static final MetadataSourceColumnTag KEY_SEQ
Identifies the column sequence number within either the primary or foreign key.

Column sequence number start at 1.


FOREIGN_KEY_UPDATE_RULE

public static final MetadataSourceColumnTag FOREIGN_KEY_UPDATE_RULE
Identifies the action applied to the foreign key when the SQL operation is UPDATE. Can have one of the following values (the referenced table is the table that has the primary key; the referencing table is the table that has the foreign key):


FOREIGN_KEY_DELETE_RULE

public static final MetadataSourceColumnTag FOREIGN_KEY_DELETE_RULE
Identifies the action applied to the foreign key when the SQL operation is DELETE. Can have one of the following values (the referenced table is the table that has the primary key; the referencing table is the table that has the foreign key):

FOREIGN_KEY_NAME

public static final MetadataSourceColumnTag FOREIGN_KEY_NAME
Identifies the foreign key name.

The DSII should call setNull(true) on the SQLData provided for the this key, in the event that foreign key names are not applicable to the data source.


DEFERRABILITY

public static final MetadataSourceColumnTag DEFERRABILITY
Identifies the deferability.

Could be one of the following values:


NON_UNIQUE_INDEX

public static final MetadataSourceColumnTag NON_UNIQUE_INDEX
Identifies whether the index does not allow duplicate values.

Could be one of the following values:

The DSII should call setNull(true) on the SQLData provided for this key, in the event that the value for INDEX_TYPE is SQL_TABLE_STAT.


INDEX_QUALIFIER

public static final MetadataSourceColumnTag INDEX_QUALIFIER
Identifies the identifier that is used to qualify the index name doing a DROP INDEX;

The DSII should call setNull(true) on the SQLData provided for this key if an index qualifier is not supported by the data source or if the value for INDEX_TYPE is SQL_TABLE_STAT.

If a non-null value is returned in this column, it must be used to qualify the index name on a DROP INDEX statement; otherwise, the value for SCHEMA_NAME should be used to qualify the index name.


INDEX_NAME

public static final MetadataSourceColumnTag INDEX_NAME
Identifies the Index name.

The DSII should call setNull(true) on the SQLData provided for this key if the value for INDEX_TYPE is SQL_TABLE_STAT.


INDEX_TYPE

public static final MetadataSourceColumnTag INDEX_TYPE
Identifies the type of information being returned by the index.

Could be one of the following values:


INDEX_SORT_SEQUENCE

public static final MetadataSourceColumnTag INDEX_SORT_SEQUENCE
Identifies the sort sequence for the column.

Must be one of the following values:

The DSII should call setNull(true) on the SQLData provided for this key if the value for INDEX_TYPE is SQL_TABLE_STAT.


INDEX_CARDINALITY

public static final MetadataSourceColumnTag INDEX_CARDINALITY
Identifies: The DSII should call setNull(true) if the value for this key is not available from the data source.


INDEX_PAGES

public static final MetadataSourceColumnTag INDEX_PAGES
Identifies: The DSII should call setNull(true) if the value for this key is not available from the data source.


INDEX_FILTER_CONDITION

public static final MetadataSourceColumnTag INDEX_FILTER_CONDITION
Identifies if the index is a filtered index, this is the filter condition, such as SALARY > 30000; if the filter condition cannot be determined, the value for this key is an empty string.

The DSII should call setNull(true) if the index is not a filtered index, it cannot be determined whether the index is a filtered index, or the value for INDEX_TYPE is SQL_TABLE_STAT.


LITERAL_PREFIX

public static final MetadataSourceColumnTag LITERAL_PREFIX
Identifies that this column holds the character(s) used to prefix a literal. (ie. a single quotation mark for string types or 0x for binary types)


LITERAL_SUFFIX

public static final MetadataSourceColumnTag LITERAL_SUFFIX
pIdentifies that this column holds the character(s) used to terminate a literal. (ie. a single quotation mark for string types)


CREATE_PARAM

public static final MetadataSourceColumnTag CREATE_PARAM
Identifies that this column holds the list of keywords, separated by commas, corresponding to each parameter that the application may specify in parentheses when using the name that is returned in the TYPE_NAME field. The keywords appear in the order that the syntax requires them to be used. The test in this column may be in the language of the country/region where it is used. The keywords can either represent a length, precision, or scale.


CASE_SENSITIVE

public static final MetadataSourceColumnTag CASE_SENSITIVE
Identifies whether a character data type is case sensitive in collations and comparisons.

Can be one of the following values:


SEARCHABLE

public static final MetadataSourceColumnTag SEARCHABLE
Identifies how the data type is used in a WHERE clause.

Can be one of the following values:


UNSIGNED_ATTRIBUTE

public static final MetadataSourceColumnTag UNSIGNED_ATTRIBUTE
Identifies whether the data type is unsigned.

Can be one of the following values:


FIXED_PREC_SCALE

public static final MetadataSourceColumnTag FIXED_PREC_SCALE
Identifies whether the data type has predefined fixed precision and scale.

Can be one of the following values:


AUTO_UNIQUE

public static final MetadataSourceColumnTag AUTO_UNIQUE
Identifies whether the data type is autoincrementing.

Can be one of the following values:


LOCAL_TYPE_NAME

public static final MetadataSourceColumnTag LOCAL_TYPE_NAME
Identifies that this column contains the localized version of the data source dependent name of the data type


MINIMUM_SCALE

public static final MetadataSourceColumnTag MINIMUM_SCALE
Identifies that this column contains the minimum scale of the data type. This is the same as the MAXIMUM_SCALE column if the data type has a fixed scale.


MAXIMUM_SCALE

public static final MetadataSourceColumnTag MAXIMUM_SCALE
Identifies that this column contains the maximum scale of the data type. This is the same as the MINIMUM_SCALE column if the data type has a fixed scale.


INTERVAL_PRECISION

public static final MetadataSourceColumnTag INTERVAL_PRECISION
Identifies that this column contains the interval leading precision for an interval data type


SCOPE

public static final MetadataSourceColumnTag SCOPE
Indicates the scope of the rowid. The column value for this tag must be one of the following values: A value for IDENTIFIER_TYPE_TAG will be provided as part of the restrictions to the Special Columns Metadata Source. If this value is SQL_ROWVER, then the DSII should call setNull(true) on the provided SQLData for the value for SCOPE.

See the documentation for SPECIAL_COLUMNS_METADATA.


PSEUDO

public static final MetadataSourceColumnTag PSEUDO
Indicates whether the column is a pseudo-column, such as Oracle ROWID. Must be one of the following values:


IDENTIFIER_TYPE_TAG

public static final MetadataSourceColumnTag IDENTIFIER_TYPE_TAG
Is a restriction column passed to the Metadata Source for Special Columns. The value associated with this tag will be one of the following:


NULLABLE_TAG

public static final MetadataSourceColumnTag NULLABLE_TAG
Is a restriction column passed to the Metadata Source for Special Columns. The value for this tag determines whether the DSII should return special columns that can have a NULL value. The value for this tag will be one of the following:


UNIQUE_TAG

public static final MetadataSourceColumnTag UNIQUE_TAG
Is a restriction column passed to the Metadata Source for Statistics Columns. The value for this tag determines the type of indexing. The value for this tag will be one of the following:


RESERVED_TAG

public static final MetadataSourceColumnTag RESERVED_TAG
Is a restriction column passed to the Metadata Source for Statistics Columns. The value for this tag indicates the importance of the public static final MetadataSourceColumnTag INDEX_CARDINALITY and public static final MetadataSourceColumnTag INDEX_PAGES columns, and the return value for these two columns. The value for this tag will be one of the following:


IS_RESULT_SET

public static final MetadataSourceColumnTag IS_RESULT_SET
A custom DSI column tag that specifies whether the current row is a parameter or a result set column. This is to be used for SQLProcedureColumns. Must be one of the following values: SQL_TRUE: If the current row is for a result set column. SQL_FALSE: If the current row is for a parameter (return value, input, IO, or output)


USER_DATA_TYPE

public static final MetadataSourceColumnTag USER_DATA_TYPE
A custom DSI column tag that identifies the User Data Type. Must be one of the following values: UDT_STANDARD_SQL_TYPE: If the data type is a standard SQL type. Between 0x4000 and 0x7FFF: If the data type is a user defined data type.


SPECIFIC_NAME

public static final MetadataSourceColumnTag SPECIFIC_NAME
Identifies this column holds the specific name for a procedure or a function.


IS_AUTOINCREMENT

public static final MetadataSourceColumnTag IS_AUTOINCREMENT
The value for this column will be one of the following: This column returns a zero-length string if nullability is unknown.

The value returned for this column differs from the value returned for the AUTOINCREMENT column. (See the description for AUTOINCREMENT)


IS_GENERATEDCOLUMN

public static final MetadataSourceColumnTag IS_GENERATEDCOLUMN
The value for this column will be one of the following: This column returns a zero-length string if nullability is unknown.

The value returned for this column differs from the value returned for the GENERATEDCOLUMN column. (See the description for GENERATEDCOLUMN)


COLUMN_USAGE

public static final MetadataSourceColumnTag COLUMN_USAGE
Identifies the allowed usage for the column. The value returned will correspond to the enum name returned by PseudoColumnUsage.name()

Method Detail

values

public static MetadataSourceColumnTag[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (MetadataSourceColumnTag c : MetadataSourceColumnTag.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static MetadataSourceColumnTag valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null


Copyright © 2006-2014 Simba Technologies Incorporated. All Rights Reserved.