Automatic generation produced by ISE Eiffel
note description: "Description of a table." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2021-06-25 04:16:34 -0800 (Fri, 25 Jun 2021) $" revision: "$Revision: 105580 $" deferred class interface DB_TABLE_DESCRIPTION feature -- Initialization make -- Enable to ensure unicity of object. feature -- Access generating_type: TYPE [detachable DB_TABLE_DESCRIPTION] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: DB_TABLE_DESCRIPTION): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: DB_TABLE_DESCRIPTION): 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 ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b 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 instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: DB_TABLE_DESCRIPTION): 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: DB_TABLE_DESCRIPTION) -- 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: Current ~ other frozen deep_copy (other: DB_TABLE_DESCRIPTION) -- 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: DB_TABLE_DESCRIPTION -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: DB_TABLE_DESCRIPTION) -- 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: DB_TABLE_DESCRIPTION -- 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: DB_TABLE_DESCRIPTION -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable DB_TABLE_DESCRIPTION -- 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) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class set_attribute (code: INTEGER_32; value: detachable 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 = 3 Character_type: INTEGER_32 = 2 Date_time_type: INTEGER_32 = 21 description_list: ARRAYED_LIST [STRING_32] -- Feature name list. Can be interpreted as a list -- or a hash-table. Double_type: INTEGER_32 = 6 id_code: INTEGER_32 -- Table ID attribute code. id_name_32: STRING_32 -- 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 = 4 No_id: INTEGER_32 = 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 = 5 String_type: INTEGER_32 = 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_list: ARRAYED_LIST [ANY] -- Table row attribute values. ensure not_void: Result /= Void attribute_value (code: INTEGER_32): ANY -- Value of attribute with code. require valid_code: valid (code) id: ANY -- Table row ID. mapped_list (action: FUNCTION [STRING_32, STRING_32]): ARRAYED_LIST [STRING_32] -- Feature list mapped with action. -- This can be useful to create tags or parameter names. require action_not_void: action /= Void printable_attribute (code: INTEGER_32): STRING_32 -- String value of attribute with code. require valid_code: valid (code) ensure result_not_void: Result /= Void printable_attribute_list: ARRAYED_LIST [STRING_32] -- 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_32] -- 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) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2021, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., 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 -- Generated by Eiffel Studio --
For more details: eiffel.org