indexing
	description: "Description of a database table column"
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
	revision: "$Revision: 56675 $"

class interface
	COLUMNS [G -> DATABASE create default_create end]

create 
	default_create
			-- Process instances of classes with no creation clause.
			-- (Default: do nothing.)
			-- (from ANY)

feature -- Access

	db_spec: DATABASE
			-- Handle to actual database
			-- (from HANDLE_SPEC)
		ensure -- from HANDLE_SPEC
			not_void: Result /= Void

	generating_type: STRING_8
			-- Name of current object's generating type
			-- (type of which it is a direct instance)
			-- (from ANY)

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)
	
feature -- Comparison

	frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		ensure -- from ANY
			shallow_implies_deep: standard_equal (some, other) implies Result
			both_or_none_void: (some = Void) implies (Result = (other = Void))
			same_type: (Result and (some /= Void)) implies some.same_type (other)
			symmetric: Result implies deep_equal (other, some)

	frozen equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))

	is_equal (other: like Current): BOOLEAN
			-- Is `other' attached to an object considered
			-- equal to current object?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			symmetric: Result implies other.is_equal (Current)
			consistent: standard_is_equal (other) implies Result

	frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached to
			-- field-by-field identical objects of the same type?
			-- Always uses default object comparison criterion.
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))

	frozen standard_is_equal (other: like Current): BOOLEAN
			-- Is `other' attached to an object of the same type
			-- as current object, and field-by-field identical to it?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
	
feature -- Status report

	buffer_length: INTEGER_32
			-- Column length in bytes

	column_id: INTEGER_32
			-- Column identification number (number of column in table)

	column_name: STRING_8
			-- Column name

	column_nulls: STRING_8
			-- 'Y' if the column can contain null values, 'N' if the column can't contain null values

	column_size: INTEGER_32
			-- precision of the Column

	column_typename: STRING_8

	conforms_to (other: ANY): BOOLEAN
			-- Does type of current object conform to type
			-- of `other' (as per Eiffel: The Language, chapter 13)?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void

	creation_date: DATE_TIME
			-- Table creation date

	data_default: STRING_8
			-- Default field value

	data_length: INTEGER_32
			-- Column length in bytes

	data_precision: INTEGER_32
			-- precision of the Column

	data_scale: INTEGER_32
			-- the scale of the column

	data_type: INTEGER_32
			-- Data type of a column. Ingres has the following data type code(negative is for nullable field):
			-- integer 	-30/30
			-- float	-31/31
			-- c		-32/32
			-- text		-37/37
			-- date		-3/3
			-- money 	-5/5
			-- char		-20/20
			-- varchar	-21/21
			-- table_key -12/12
			-- object_key -11/11

	decimal_digits: INTEGER_32
			-- the scale of the column

	default_length: INTEGER_32
			-- Length of default value for a column

	density: INTEGER_32
			-- Oracle V7 add ons.

	duplicate: like Current
			-- Duplicate copy of Current

	eiffel_type: INTEGER_32
			-- Eiffel type code mapped to Ingres type data_type

	high_value: INTEGER_32
			-- Oracle V7 add ons.

	length: INTEGER_32
			-- Column length in bytes

	low_value: INTEGER_32
			-- Oracle V7 add ons.

	nullable: INTEGER_32
			-- if the column can get NULL value

	num_distinct: INTEGER_32
			-- Oracle V7 add ons.

	num_prec_radix: INTEGER_32
			-- the radix of the Column

	owner: STRING_8
			-- Owner id of table of name table_name

	owner_id: INTEGER_32
			-- Owner id of table of name table_name

	precision: INTEGER_32
			-- precision of the Column

	radix: INTEGER_32
			-- the radix of the Column

	same_type (other: ANY): BOOLEAN
			-- Is type of current object identical to type of `other'?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))

	scale: INTEGER_32
			-- the scale of the column

	status: INTEGER_32
			--  Flag to check whether a column field can be null

	table_cat: STRING_8
			-- Qualifier of the table in which the column belongs

	table_id: INTEGER_32
			-- Table identification number

	table_name: STRING_8
			-- Table name

	table_owner: STRING_8
			-- Owner id of table of name table_name

	table_qualifier: STRING_8
			-- Qualifier of the table in which the column belongs

	table_schem: STRING_8
			-- Owner id of table of name table_name

	table_type: STRING_8
			-- Table type

	type_name: STRING_8
			-- type name in ODBC
	
feature -- Status setting

	set_all (col_id, dat_type, dat_len, sca, rad, prec, nulable, def_len, num_dist, low_val, high_val, dens, own_id, tb_id, stat: INTEGER_32; dat_def, qualifier, own, tab_name, tab_type, col_name, col_nulls, col_typename: STRING_8; creat_date: DATE_TIME)
			-- Set attributes with input parameter values.
	
feature -- Removal

	clear_all
			-- Reset all attributes to default values.
	
feature -- Conversion

	boolean_type_database: INTEGER_32
			-- Boolean type code in Ingres
			-- (from TYPES)

	character_type_database: INTEGER_32
			-- Character type code in Ingres
			-- (from TYPES)

	date_type_database: INTEGER_32
			-- Datetime type code in Ingres
			-- (from TYPES)

	float_type_database: INTEGER_32
			-- Double type code in Ingres
			-- (from TYPES)

	integer_type_database: INTEGER_32
			-- Integer type code in Ingres
			-- (from TYPES)

	real_type_database: INTEGER_32
			-- Real type code in Ingres
			-- (from TYPES)

	string_type_database: INTEGER_32
			-- String type code in Ingres
			-- (from TYPES)
	
feature -- Duplication

	copy (other: like Current)
			-- Update current object using fields of object attached
			-- to `other', so as to yield equal objects.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_equal: is_equal (other)

	frozen deep_copy (other: like Current)
			-- Effect equivalent to that of:
			--		copy (`other' . deep_twin)
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)

	frozen deep_twin: like Current
			-- New object structure recursively duplicated from Current.
			-- (from ANY)
		ensure -- from ANY
			deep_equal: deep_equal (Current, Result)

	frozen standard_copy (other: like Current)
			-- Copy every field of `other' onto corresponding field
			-- of current object.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)

	frozen standard_twin: like Current
			-- New object field-by-field identical to `other'.
			-- Always uses default copying semantics.
			-- (from ANY)
		ensure -- from ANY
			standard_twin_not_void: Result /= Void
			equal: standard_equal (Result, Current)

	frozen twin: like Current
			-- New object equal to `Current'
			-- twin calls copy; to change copying/twining semantics, redefine copy.
			-- (from ANY)
		ensure -- from ANY
			twin_not_void: Result /= Void
			is_equal: Result.is_equal (Current)
	
feature -- Basic operations

	frozen default: like Current
			-- Default value of object's type
			-- (from ANY)

	frozen default_pointer: POINTER
			-- Default value of type `POINTER'
			-- (Avoid the need to write `p'.default for
			-- some `p' of type `POINTER'.)
			-- (from ANY)

	default_rescue
			-- Process exception for routines with no Rescue clause.
			-- (Default: do nothing.)
			-- (from ANY)

	frozen do_nothing
			-- Execute a null action.
			-- (from ANY)
	
feature -- Output

	io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)

	out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- Was declared in ANY as synonym of tagged_out.
			-- (from ANY)

	print (some: ANY)
			-- Write terse external representation of `some'
			-- on standard output.
			-- (from ANY)

	frozen tagged_out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- Was declared in ANY as synonym of out.
			-- (from ANY)
	
feature -- Platform

	operating_environment: OPERATING_ENVIRONMENT
			-- Objects available from the operating system
			-- (from ANY)
	
invariant
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

indexing
	copyright: "Copyright (c) 1984-2006, Eiffel Software and others"
	license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
	source: "[
		Eiffel Software
		356 Storke Road, Goleta, CA 93117 USA
		Telephone 805-685-1006, Fax 805-685-6869
		Website http://www.eiffel.com
		Customer support http://support.eiffel.com
	]"

end -- class COLUMNS