Namespace: Consultingwerk.Framework.Base
Class 
AblPrimitiveDictionary Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.Base.AblPrimitiveDictionary

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Framework.Base.ISupportsListChanged, Consultingwerk.Framework.Base.ISupportsListHash
Inherited by: Consultingwerk.Framework.Collections.CharacterDictionary Consultingwerk.Framework.Collections.HandleDictionary Consultingwerk.Framework.Collections.IntegerDictionary Consultingwerk.Framework.Collections.RowidDictionary
ABSTRACT

File:AblPrimitiveDictionary
Purpose:Abstract foundation for dictionaries of ABL primitive
values
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Jan 22 14:36:08 CET 2012
Purpose: Raised when the List is changed by adding or removing items or
clearing the list
Notes:

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ Clear () Removes all keys and values from the Dictionary
+ LOGICAL ContainsKey (character) Determines whether the Dictionary contains the specified key.
# INTEGER EntryOfKey (character) Determines the position of the specified key in the list of keys
+ Consultingwerk.Framework.Collections.CharacterList GetKeysAsList () Returns the Keys as a CharacterList
# InternalAdd (character, character) Adds the specified key and value to the dictionary.
# LOGICAL InternalContainsValue (character) Determines whether the Dictionary contains the specified value.
# CHARACTER InternalGetValue (character) Returns the Value for the specified Key
# InternalSetValue (character, character) Assigns the Value for the specified Key
# OnListChanged (ListChangedEventArgs) Raises the ListChanged event
+ Remove (character) Removes the Key/Value for the specified Key
# ValidateKey (character) Validates a Key
# ValidateValue (character) Validates a Value

Top Constructor Summary
Options Name Purpose
+ AblPrimitiveDictionary () Constructor for the AblPrimitiveDictionary class
+ AblPrimitiveDictionary (character, character) Constructor for the AblPrimitiveDictionary class
+ AblPrimitiveDictionary (character, character, character, character) Constructor for the AblPrimitiveDictionary class

Top Event Summary
Options Name Purpose
+ ListChanged (Object, ListChangedEventArgs) Raised when the List is changed by adding or removing items or clearing the list

Top Property Summary
Options Name Purpose
+ INTEGER Count
+ CHARACTER KeyDelimiter
+ CHARACTER Keys
+ CHARACTER ListHash
+ CHARACTER ValueDelimiter
+ CHARACTER Values


Method Detail
Top

PUBLIC Clear ()
Purpose: Removes all keys and values from the Dictionary
Notes: Raises the ListChanged event

Top

PUBLIC LOGICAL ContainsKey (character)
Purpose: Determines whether the Dictionary contains the specified key.
Notes:

Parameters:
pcKey CHARACTER
The key to locate in the Dictionary
Returns LOGICAL
Logical value indicating if the dictionary contains the specified key
Top

PROTECTED INTEGER EntryOfKey (character)
Purpose: Determines the position of the specified key in the list of keys
Notes:

Parameters:
pcKey CHARACTER
The Key to locate in the Keys
Returns INTEGER
The position of the specified in the list of keys
Top

PUBLIC Consultingwerk.Framework.Collections.CharacterList GetKeysAsList ()
Purpose: Returns the Keys as a CharacterList
Notes:

Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList with the keys
Top

PROTECTED InternalAdd (character, character)
Purpose: Adds the specified key and value to the dictionary.
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
pcKey CHARACTER
The key for the key/value pair to add to the dictionary
pcValue CHARACTER
The value for the key/value pair to add to the dictionary
Top

PROTECTED LOGICAL InternalContainsValue (character)
Purpose: Determines whether the Dictionary contains the specified value.
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
pcValue CHARACTER
The value to locate in the Dictionary
Returns LOGICAL
Logical value indicating if the Dictionary contains the specified value
Top

PROTECTED CHARACTER InternalGetValue (character)
Purpose: Returns the Value for the specified Key
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
pcKey CHARACTER
The value to locate in the Dictionary
Returns CHARACTER
The value for the specified key
Top

PROTECTED InternalSetValue (character, character)
Purpose: Assigns the Value for the specified Key
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
pcKey CHARACTER
The value to locate in the Dictionary
pcValue CHARACTER
The value to assign for the Key in the Dictionary
Top

PROTECTED OnListChanged (ListChangedEventArgs)
Purpose: Raises the ListChanged event
Notes:

Parameters:
e Consultingwerk.Framework.Base.ListChangedEventArgs
The ListChangedEventArgs object instance with the data of the ListChanged event
Top

PUBLIC Remove (character)
Purpose: Removes the Key/Value for the specified Key
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
pcKey CHARACTER
The value to remove from the Dictionary
Top

PROTECTED ValidateKey (character)
Purpose: Validates a Key
Notes:

Parameters:
pcKey CHARACTER
The key to validate
Top

PROTECTED ValidateValue (character)
Purpose: Validates a Value
Notes:

Parameters:
pcValue CHARACTER
The value to validate


Constructor Detail
Top

PUBLIC AblPrimitiveDictionary ()
Purpose: Constructor for the AblPrimitiveDictionary class
Notes:

Top

PUBLIC AblPrimitiveDictionary (character, character)
Purpose: Constructor for the AblPrimitiveDictionary class
Notes: Defaults to the comma (",") as the delimiter for Keys and Values

Parameters:
pcKeys CHARACTER
The initial list of Keys
pcValues CHARACTER
The initial list of Values
Top

PUBLIC AblPrimitiveDictionary (character, character, character, character)
Purpose: Constructor for the AblPrimitiveDictionary class
Notes:

Parameters:
pcKeys CHARACTER
The initial list of Keys
pcKeyDelimiter CHARACTER
The delimiter for the Keys
pcValues CHARACTER
The initial list of Values
pcValueDelimiter CHARACTER
The delimiter for the Values


Event Detail
Top

PUBLIC ListChanged (Object, ListChangedEventArgs)
Purpose: Raised when the List is changed by adding or removing items or
clearing the list
Notes:

Parameters:
sender Progress.Lang.Object
The sender of the event
e Consultingwerk.Framework.Base.ListChangedEventArgs
The ListChangedEventArgs object instance with the data of the ListChanged event


Property Detail
Top

PUBLIC INTEGER Count

Returns INTEGER
Top

PUBLIC CHARACTER KeyDelimiter

Returns CHARACTER
Top

PUBLIC CHARACTER Keys

Returns CHARACTER
Top

PUBLIC CHARACTER ListHash

Returns CHARACTER
Top

PUBLIC CHARACTER ValueDelimiter

Returns CHARACTER
Top

PUBLIC CHARACTER Values

Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 12:58:45