Automatic generation produced by ISE Eiffel
indexing
description: "Deferred Class that is a template for all User Data Access Classes"
author: "Marco Piccioni, Peizhu Li"
date: "$Date$"
revision: "$0.6$"
deferred class
USER_MANAGER
feature {NONE} -- Initialization
default_create
-- Process instances of classes with no creation clause.
-- (Default: do nothing.)
-- (from ANY)
do
end
feature -- Access
generating_type: STRING_8
-- Name of current object's generating type
-- (type of which it is a direct instance)
-- (from ANY)
external
"built_in"
ensure -- from ANY
generating_type_not_void: Result /= Void
generating_type_not_empty: not Result.is_empty
end
generator: STRING_8
-- Name of current object's generating class
-- (base class of the type of which it is a direct instance)
-- (from ANY)
external
"built_in"
ensure -- from ANY
generator_not_void: Result /= Void
generator_not_empty: not Result.is_empty
end
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)
do
if some = Void then
Result := other = Void
else
Result := other /= Void and then some.is_deep_equal (other)
end
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)
end
frozen equal (some: ANY; other: like arg #1): BOOLEAN
-- Are `some' and `other' either both void or attached
-- to objects considered equal?
-- (from ANY)
do
if some = Void then
Result := other = Void
else
Result := other /= Void and then some.is_equal (other)
end
ensure -- from ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))
end
frozen is_deep_equal (other: like Current): BOOLEAN
-- Are `Current' and `other' attached to isomorphic object structures?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
external
"built_in"
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)
end
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
do
Result := standard_is_equal (other)
ensure -- from ANY
symmetric: Result implies other.is_equal (Current)
consistent: standard_is_equal (other) implies Result
end
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)
do
if some = Void then
Result := other = Void
else
Result := other /= Void and then some.standard_is_equal (other)
end
ensure -- from ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))
end
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
external
"built_in"
ensure -- from ANY
same_type: Result implies same_type (other)
symmetric: Result implies other.standard_is_equal (Current)
end
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
external
"built_in"
end
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
external
"built_in"
ensure -- from ANY
definition: Result = (conforms_to (other) and other.conforms_to (Current))
end
feature -- Duplication
frozen clone (other: ANY): like other
obsolete "Use `twin' instead."
-- Void if `other' is void; otherwise new object
-- equal to `other'
--
-- For non-void `other', clone calls copy;
-- to change copying/cloning semantics, redefine copy.
-- (from ANY)
do
if other /= Void then
Result := other.twin
end
ensure -- from ANY
equal: equal (Result, other)
end
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)
external
"built_in"
ensure -- from ANY
is_equal: is_equal (other)
end
frozen deep_clone (other: ANY): like other
obsolete "Use `deep_twin' instead."
-- Void if `other' is void: otherwise, new object structure
-- recursively duplicated from the one attached to `other'
-- (from ANY)
do
if other /= Void then
Result := other.deep_twin
end
ensure -- from ANY
deep_equal: deep_equal (other, Result)
end
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
do
copy (other.deep_twin)
ensure -- from ANY
deep_equal: deep_equal (Current, other)
end
frozen deep_twin: like Current
-- New object structure recursively duplicated from Current.
-- (from ANY)
external
"built_in"
ensure -- from ANY
deep_twin_not_void: Result /= Void
deep_equal: deep_equal (Current, Result)
end
frozen standard_clone (other: ANY): like other
obsolete "Use `standard_twin' instead."
-- Void if `other' is void; otherwise new object
-- field-by-field identical to `other'.
-- Always uses default copying semantics.
-- (from ANY)
do
if other /= Void then
Result := other.standard_twin
end
ensure -- from ANY
equal: standard_equal (Result, other)
end
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)
external
"built_in"
ensure -- from ANY
is_standard_equal: standard_is_equal (other)
end
frozen standard_twin: like Current
-- New object field-by-field identical to `other'.
-- Always uses default copying semantics.
-- (from ANY)
local
l_temp: BOOLEAN
do
l_temp := {ISE_RUNTIME}.check_assert (False)
Result ?= {ISE_RUNTIME}.c_standard_clone ($Current)
Result.standard_copy (Current)
l_temp := {ISE_RUNTIME}.check_assert (l_temp)
ensure -- from ANY
standard_twin_not_void: Result /= Void
equal: standard_equal (Result, Current)
end
frozen twin: like Current
-- New object equal to `Current'
-- twin calls copy; to change copying/twining semantics, redefine copy.
-- (from ANY)
local
l_temp: BOOLEAN
do
l_temp := {ISE_RUNTIME}.check_assert (False)
Result ?= {ISE_RUNTIME}.c_standard_clone ($Current)
Result.copy (Current)
l_temp := {ISE_RUNTIME}.check_assert (l_temp)
ensure -- from ANY
twin_not_void: Result /= Void
is_equal: Result.is_equal (Current)
end
feature -- Basic operations
frozen default: like Current
-- Default value of object's type
-- (from ANY)
do
end
frozen default_pointer: POINTER
-- Default value of type `POINTER'
-- (Avoid the need to write `p'.default for
-- some `p' of type `POINTER'.)
-- (from ANY)
do
end
default_rescue
-- Process exception for routines with no Rescue clause.
-- (Default: do nothing.)
-- (from ANY)
do
end
frozen do_nothing
-- Execute a null action.
-- (from ANY)
do
end
feature -- Attributes
encryptor: ENCRYPTOR
-- encrypt user login name and password, void to skip encryption
user_list: HASH_TABLE [USER, STRING_8]
feature -- Output
io: STD_FILES
-- Handle to standard file setup
-- (from ANY)
once
create Result
Result.set_output_default
ensure -- from ANY
io_not_void: Result /= Void
end
out: STRING_8
-- New string containing terse printable representation
-- of current object
-- (from ANY)
do
Result := tagged_out
ensure -- from ANY
out_not_void: Result /= Void
end
print (some: ANY)
-- Write terse external representation of `some'
-- on standard output.
-- (from ANY)
do
if some /= Void then
io.put_string (some.out)
end
end
frozen tagged_out: STRING_8
-- New string containing terse printable representation
-- of current object
-- (from ANY)
external
"built_in"
ensure -- from ANY
tagged_out_not_void: Result /= Void
end
feature -- Platform
operating_environment: OPERATING_ENVIRONMENT
-- Objects available from the operating system
-- (from ANY)
once
create Result
ensure -- from ANY
operating_environment_not_void: Result /= Void
end
feature {NONE} -- Retrieval
frozen internal_correct_mismatch
-- Called from runtime to perform a proper dynamic dispatch on `correct_mismatch'
-- from MISMATCH_CORRECTOR.
-- (from ANY)
local
l_corrector: MISMATCH_CORRECTOR
l_msg: STRING_8
l_exc: EXCEPTIONS
do
l_corrector ?= Current
if l_corrector /= Void then
l_corrector.correct_mismatch
else
create l_msg.make_from_string ("Mismatch: ")
create l_exc
l_msg.append (generating_type)
l_exc.raise_retrieval_exception (l_msg)
end
end
feature --Basic Operations
add_user (a_user: USER)
--adds a user to the userlist
require
a_user_valid: a_user /= Void
user_not_exists: not username_defined (a_user.username)
do
user_list.extend (a_user, a_user.username)
ensure
one_user_added: user_list.count = old user_list.count + 1
end
delete_user_by_name (username: STRING_8)
--
require
username_exists: username /= Void and then not username.is_empty and then user_list.has (username)
do
user_list.remove (username)
ensure
one_user_removed: user_list.count = old user_list.count - 1
end
get_user_by_name (username: STRING_8): USER
-- return the USER object identified by username
require
username_exists: username /= Void and then not username.is_empty and then user_list.has (username)
do
Result := user_list [username]
ensure
user_found: Result /= Void
end
is_user_authentication_valid (username, pass: STRING_8): BOOLEAN
-- check user authentication
require
name_pass_not_empty: username /= Void and then not username.is_empty and then pass /= Void and then not pass.is_empty
do
user_list.start
user_list.search (username)
if user_list.found then
if user_list [username].password.is_equal (pass) then
Result := True
end
end
end
persist_data
deferred
end
set_encryptor (cryptor: ENCRYPTOR)
-- retrieve the saved session object with given session_id
do
encryptor := cryptor
end
update_user (a_user: USER)
--update a existing user
require
a_user_valid: a_user /= Void
user_exists: username_defined (a_user.username)
do
user_list.replace (a_user, a_user.username)
ensure
same_user_number: user_list.count = old user_list.count
end
user_count: INTEGER_32
--
do
Result := user_list.count
end
username_defined (username: STRING_8): BOOLEAN
--adds a user to the userlist
require
username_valid: username /= Void and then not username.is_empty
do
Result := user_list.has (username)
end
invariant
invariant_clause: True
-- from ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)
end -- class USER_MANAGER
-- Generated by ISE Eiffel --
For more details: www.eiffel.com