indexing
	description: "Description of a table."
	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 $"

deferred class interface
	DB_TABLE_DESCRIPTION

feature -- Initialization

	make
			-- Enable to ensure unicity of object.
	
feature -- Access

	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

	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

	is_valid_code (code: INTEGER_32): BOOLEAN
			-- Does `code' represents a database table?
			-- (from DB_TABLES_ACCESS_USE)

	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))

	tables_set: BOOLEAN
			-- Is abstract description of database tables
			-- set?
			-- (from DB_TABLES_ACCESS_USE)

	valid (code: INTEGER_32): BOOLEAN
			-- Is `code' a valid attribute code?
	
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)

	set_attribute (code: INTEGER_32; value: ANY)
			-- Set attribute with `code' to `value'.
			-- `value' must be of type STRING, INTEGER, BOOLEAN, CHARACTER,
			-- DOUBLE or DATE_TIME. References are made automatically from
			-- expanded types.
		require
			valid_code: valid (code)

	set_id (value: ANY)
			-- Set ID of table row to `value'.
			-- `value' must be of type STRING, INTEGER
			-- (reference created automatically) or DATE_TIME.
	
feature -- Access (table description)

	attribute_code_list: ARRAYED_LIST [INTEGER_32]
			-- Feature code list.

	attribute_number: INTEGER_32
			-- Number of attributes in the table.

	boolean_type: INTEGER_32 is 3

	character_type: INTEGER_32 is 2

	date_time_type: INTEGER_32 is 21

	description_list: ARRAYED_LIST [STRING_8]
			-- Feature name list. Can be interpreted as a list
			-- or a hash-table.

	double_type: INTEGER_32 is 6

	id_code: INTEGER_32
			-- Table ID attribute code.

	id_name: STRING_8
			-- Table ID attribute name.

	identity_column: INTEGER_32
			-- Column ID for IDENTITY column of table (0 if there is no IDENTITY column, default)

	integer_type: INTEGER_32 is 4

	no_id: INTEGER_32 is 0
			-- id_code value when no ID exists or ID constraint is not
			-- located to a single attribute.

	printable_type_table: HASH_TABLE [STRING_8, INTEGER_32]
			-- Default string associated to attributes possible
			-- types.

	real_type: INTEGER_32 is 5

	string_type: INTEGER_32 is 20

	table_code: INTEGER_32
			-- Eiffel table code, matches IDs definition in LOG_TABLE.

	table_name: STRING_8
			-- Database table name.

	to_create_fkey_from_table: HASH_TABLE [INTEGER_32, INTEGER_32]
			-- List of associated necessary tables and the  
			-- linking foreign keys.
			-- Creation on this table may imply creations on
			-- associated necessary tables.

	to_delete_fkey_from_table: HASH_TABLE [INTEGER_32, INTEGER_32]
			-- List of tables depending on this one and their
			-- foreign key for this table.
			-- Deletion on this table may imply deletions on
			-- depending tables. 

	type_list: ARRAYED_LIST [INTEGER_32]
			-- Feature type list. Can be interpreted as a list
			-- or a hash-table.
	
feature -- Access (table row values)

	attribute (code: INTEGER_32): ANY
			-- Value of attribute with `code'.
		require
			valid_code: valid (code)

	attribute_list: ARRAYED_LIST [ANY]
			-- Table row attribute values.
		ensure
			not_void: Result /= Void

	id: ANY
			-- Table row ID.

	mapped_list (action: FUNCTION [ANY, TUPLE [STRING_8], STRING_8]): ARRAYED_LIST [STRING_8]
			-- Feature list mapped with `action'.
			-- This can be useful to create tags or parameter names.

	printable_attribute (code: INTEGER_32): STRING_8
			-- String value of attribute with `code'.
		require
			valid_code: valid (code)
		ensure
			result_not_void: Result /= Void

	printable_attribute_list: ARRAYED_LIST [STRING_8]
			-- Table row attribute string values.
		ensure
			not_void: Result /= Void

	printable_id: STRING_8
			-- String value of table row ID.

	selected_attribute_list (list: ARRAYED_LIST [INTEGER_32]): ARRAYED_LIST [ANY]
			-- Table row attribute values which codes are in `list'.
		require
			not_void: list /= Void
		ensure
			not_void: Result /= Void

	selected_printable_attribute_list (list: ARRAYED_LIST [INTEGER_32]): ARRAYED_LIST [STRING_8]
			-- Table row attribute values which codes are in `list'.
		require
			not_void: list /= Void
		ensure
			not_void: Result /= Void
	
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 DB_TABLE_DESCRIPTION