Automatic generation produced by ISE Eiffel
note description: "Database Manager using database structure description." 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 $" class interface DB_TABLE_MANAGER create make (dbm: like database_manager) -- Set dbm to manage database -- interactions. require database_manager_not_void: dbm /= Void feature -- Initialization make (dbm: like database_manager) -- Set dbm to manage database -- interactions. require database_manager_not_void: dbm /= Void feature -- Access Case_insensitive: BOOLEAN = False -- Selection is case insensitive. -- (from ABSTRACT_DB_TABLE_MANAGER) Case_sensitive: BOOLEAN = True -- Selection is case sensitive. -- (from ABSTRACT_DB_TABLE_MANAGER) Contains_type: INTEGER_32 = 5 -- Attribute contains value. -- (from ABSTRACT_DB_TABLE_MANAGER) database_result: detachable DB_TABLE -- Database unique result. Selection should -- have been qualified with ID. require no_error: not has_error is_id_selection: is_id_selection database_result_list: detachable ARRAYED_LIST [DB_TABLE] -- Database result list. require -- from ABSTRACT_DB_TABLE_MANAGER no_error: not has_error Equals_type: INTEGER_32 = 0 -- Attribute equals value. -- (from ABSTRACT_DB_TABLE_MANAGER) generating_type: TYPE [detachable DB_TABLE_MANAGER] -- 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 Greater_type: INTEGER_32 = 1 -- Attribute is greater than value. -- (from ABSTRACT_DB_TABLE_MANAGER) Lower_type: INTEGER_32 = 2 -- Attribute is lower than value. -- (from ABSTRACT_DB_TABLE_MANAGER) Max_type: INTEGER_32 = 5 -- Maximum type. -- (from ABSTRACT_DB_TABLE_MANAGER) Prefix_type: INTEGER_32 = 3 -- Value is prefix of attribute. -- (from ABSTRACT_DB_TABLE_MANAGER) select_qualifiers: detachable STRING_32 -- Qualifying clause of current SQL query. select_query_32: STRING_32 -- Select query to execute. Execute with load_result_list. require select_query_prepared: select_query_prepared select_table_descr: detachable DB_TABLE_DESCRIPTION -- Table description of select query to execute. Execute with load_result_list. Suffix_type: INTEGER_32 = 4 -- Value is suffix of attribute. -- (from ABSTRACT_DB_TABLE_MANAGER) 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_MANAGER): 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_MANAGER): 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_MANAGER): 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 error_message_32: detachable STRING_32 -- Error message if an error occurred during last -- database operation. has_error: BOOLEAN -- Has an error occurred during last database operation? has_id (tablerow: DB_TABLE): BOOLEAN -- Does tablerow have an ID and can it be found? require -- from ABSTRACT_DB_TABLE_MANAGER tablerow_not_void: tablerow /= Void is_connected: BOOLEAN -- Is the application connected to a database? is_id_selection: BOOLEAN -- Is prepared select query qualified with ID? is_valid_code (code: INTEGER_32): BOOLEAN -- Does code represents a database table? -- (from DB_TABLES_ACCESS_USE) like_type (type: INTEGER_32): BOOLEAN -- Does type require a SQL query using 'like'? 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)) select_query_prepared: BOOLEAN -- Is a select query prepared? tables_set: BOOLEAN -- Is abstract description of database tables -- set? -- (from DB_TABLES_ACCESS_USE) valid_type (type: INTEGER_32): BOOLEAN -- Is type a valid qualifying type? -- (from ABSTRACT_DB_TABLE_MANAGER) feature -- Duplication copy (other: DB_TABLE_MANAGER) -- 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_MANAGER) -- 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_MANAGER -- 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_MANAGER) -- 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_MANAGER -- 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_MANAGER -- 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 add_qualifier (value: READABLE_STRING_GENERAL) -- Add qualifier value to prepared select query. require select_query_prepared: select_query_prepared value_not_void: value /= Void add_specific_qualifier (column: INTEGER_32; value: READABLE_STRING_GENERAL; type: INTEGER_32; case_sens: BOOLEAN) -- Add qualifier column related to value with type and case. -- 'LIKE' predicates are implemented by both Oracle and ODBC with '%' and '_' wild -- card characters. -- Case sensitiveness can only be specified for Oracle. ODBC set case sensitiveness -- directly on database columns. require -- from ABSTRACT_DB_TABLE_MANAGER select_query_prepared: select_query_prepared not_void: value /= Void valid_type: valid_type (type) add_value_qualifier (column: INTEGER_32; value: READABLE_STRING_GENERAL) -- Add qualifier column = value to prepared select query. require -- from ABSTRACT_DB_TABLE_MANAGER select_query_prepared: select_query_prepared not_void: value /= Void frozen default: detachable DB_TABLE_MANAGER -- 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 load_result -- Load result. Set `has_error`. Result is available in -- `database_result` if result is unique, `database_result_list` otherwise. require -- from ABSTRACT_DB_TABLE_MANAGER select_query_prepared: select_query_prepared prepare_select_with_table (tablecode: INTEGER_32) -- Prepare a simple select query on table with code tablecode. -- Execute it with load_result_list. require -- from ABSTRACT_DB_TABLE_MANAGER is_valid_tablecode: is_valid_code (tablecode) remove_order_by -- Remove order by from current prepared select query. require select_query_prepared: select_query_prepared remove_qualifiers -- Remove all qualifiers of prepared select query. require select_query_prepared: select_query_prepared ensure is_not_id_selection: not is_id_selection set_all_columns -- Select all columns for prepared select query. require select_query_prepared: select_query_prepared set_columns (cols: ARRAYED_LIST [INTEGER_32]) -- Set cols as result columns of prepared select query. -- Don't change other select query parameters. require select_query_prepared: select_query_prepared set_id_qualifier (id_value: STRING_8) -- Prepared select query will select table row with id id_value. require has_id: attached select_table_descr as lr_table_descr and then lr_table_descr.id_code /= lr_table_descr.No_id ensure is_id_selection: is_id_selection set_multiple_order_by (column_list: ARRAYED_LIST [INTEGER_32]) -- Order result by attribute of code column. require select_query_prepared: select_query_prepared column_list_not_void: column_list /= Void set_order_by (column: INTEGER_32) -- Order result by attribute of code column. require select_query_prepared: select_query_prepared set_table (tablecode: INTEGER_32) -- Set table with code tablecode as result table of prepared select query. -- Don't change other select query parameters. require select_query_prepared: select_query_prepared is_valid_code: is_valid_code (tablecode) feature -- Commitment commit -- Commit changes in the database. feature -- Connection disconnect -- Disconnect from database. require is_connected: is_connected establish_connection -- Establish connection to database. ensure not_void: session_control /= Void set_connection_information (user_name, password, data_source: STRING_8) -- Set database connection information: user_name, password -- and data_source. require not_void: user_name /= Void and password /= Void and data_source /= Void set_connection_string_information (a_connection_string: STRING_8) -- Set connection string required to connect to the database. -- It overrides the information set by `set_connection_information` when login. require not_void: a_connection_string /= Void feature -- Creation create_item (an_obj: DB_TABLE) -- Store in the DB object an_obj. create_item_with_id (an_obj: DB_TABLE) -- Store in the DB object an_obj after giving it -- a valid ID. -- Was declared in {DB_TABLE_MANAGER} as synonym of `set_id_and_create_tablerow`. new_id_for_tablerow (table_descr: DB_TABLE_DESCRIPTION): detachable ANY -- Next available ID for table described by table_descr. require not_void: table_descr /= Void has_id: table_descr.id_code /= table_descr.No_id ensure result_not_void: not has_error implies Result /= Void set_id_and_create_tablerow (an_obj: DB_TABLE) -- Store in the DB object an_obj after giving it -- a valid ID. -- Was declared in {DB_TABLE_MANAGER} as synonym of `create_item_with_id`. require -- from ABSTRACT_DB_TABLE_MANAGER not_void: an_obj /= Void has_id: has_id (an_obj) feature -- Deletion delete_item (an_obj: DB_TABLE) -- Delete an_obj in the database, i.e. -- the table row of an_obj table with an_obj ID. delete_tablerow (an_obj: DB_TABLE) -- Delete an_obj in the database, -- i.e. the table row of an_obj table with an_obj ID. require -- from ABSTRACT_DB_TABLE_MANAGER not_void: an_obj /= Void has_id: has_id (an_obj) feature -- General command execute_query (query: READABLE_STRING_32) -- Execute SQL query and commit changes. require not_void: query /= 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 feature -- Queries load_data_with_select (s: READABLE_STRING_GENERAL): detachable ANY -- Load directly an integer value from the database. require meaningful_select: s /= Void load_list_with_query_and_tablecode (query: READABLE_STRING_GENERAL; tablecode: INTEGER_32): detachable ARRAYED_LIST [DB_TABLE] -- Load list of table rows from query. Table rows type is -- table of code tablecode. require query_not_void: query /= Void is_valid_code: is_valid_code (tablecode) feature -- Update update_tablerow (tablerow: DB_TABLE) -- Update item with description in database. require -- from ABSTRACT_DB_TABLE_MANAGER not_void: tablerow /= Void has_id: has_id (tablerow) 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_MANAGER -- Generated by Eiffel Studio --
For more details: eiffel.org