Automatic generation produced by ISE Eiffel
indexing
description: "read the website configuration file, initialize handler-mapping, actual session class name and expiration time information."
author: "Peizhu Li, <lip@student.ethz.ch>"
date: "20.12.2008"
revision: "$0.6$"
class interface
CONFIG_READER
create
make (file_name: STRING_8)
-- initialize objects / default values
feature -- Access
generating_type: STRING_8
-- Name of current object's generating type
-- (type of which it is a direct instance)
-- (from ANY)
ensure -- from ANY
generating_type_not_void: Result /= Void
generating_type_not_empty: not Result.is_empty
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 (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))
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
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: 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
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))
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_twin_not_void: Result /= Void
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)
ensure -- from ANY
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 (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
-- (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
operating_environment_not_void: Result /= Void
feature -- access
get_constant (name: STRING_8): STRING_8
-- retrieve a constant string defined in configuration file, return "" if not exists
require
valid_name_is_given: name /= Void and not name.is_empty
get_handler_type (request: STRING_8): STRING_8
-- parse config file to get the handler id string for specified request/command
require
config_file_name /= Void
get_template_file (request, command: STRING_8): STRING_8
-- parse config file to get template file for specified request/command
require
config_file_name /= Void
has_constant (name: STRING_8): BOOLEAN
-- check whether a specified constant is defined in config file
require
valid_name_is_given: name /= Void and not name.is_empty
read_configuration (request, command: STRING_8)
-- parse config file to get configurations for sepcified request/command
require
config_file_name /= Void
feature -- attribute
application_path: STRING_8
-- path to eiffel application
config_file_name: STRING_8
-- full path to the config file
database_name: STRING_8
database_password: STRING_8
database_port: INTEGER_32
database_server: STRING_8
database_socket_file: STRING_8
database_username: STRING_8
default_command: STRING_8
-- default request and command string in case client hasn't specified a request
default_request: STRING_8
error_template_page: STRING_8
-- a template page will be used for HTML error pages (4xx errors)
handler: STRING_8
-- handler class name for given request/action
image_path: STRING_8
-- path to image files
javascript: STRING_8
-- javascript path
notfound_command: STRING_8
-- in case of an unknown request, request/command string used to identify a handler
notfound_request: STRING_8
session_expiration: INTEGER_32
-- session expirated (in hours)
session_files_folder: STRING_8
-- folder that all session files will be saved in
session_id_length: INTEGER_32
-- length of generated session id
stylesheet: STRING_8
-- stylesheet path
template: STRING_8
-- html template file for given request/action
variables: HASH_TABLE [STRING_8, STRING_8]
-- application constants as strings
invariant
invariant_clause: True
-- from ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)
end -- class CONFIG_READER
-- Generated by ISE Eiffel --
For more details: www.eiffel.com