Vision Messages: Dictionary

| Home | Dictionary Class | Message XRef | Messages (General) |

Profile of Class Dictionary


Object
  | 
  +--- Dictionary
  |      |
  |      +--- AdminTools Named
  |      |
  |      +--- Environment
  |      |
  |      +--- Interface Named
  |      |
  |      +--- LocalDBDictionary
  |      |
  |      +--- Named
  |      |
  |      +--- SystemDictionary
  |      |
  |      +--- XRef
  |      |      |
  |      |      +--- Currency XRef


The Dictionary subclasses are used to name related objects in a homogeneous way. A Dictionary is similar to an IndexedList that is indexed by a String value.


Message Index

o asSelf
o at: string
o at: string put: object
o classDescriptor
o cleanupClassStructures
o defaultInstance
o delete: string
o initialize
o initializeGlobalSubclassProperties
o initializeLocalAttributes
o isDictionary
o locate: string
o new
o newAs: string
o objects
o specialized
o uniformAt: string
o whatAmI


Messages

o asSelf

Synopsis:
Dictionary asSelf

Description:

Returns the original object.

Type: Primitive          Returns: Dictionary

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o at:

Synopsis:
Dictionary at: string

Description:

Returns the object stored at the supplied string.

Type: Method          Returns: Object

Parameters:

1 - String

Also Defined At:
| List | String |

o at:put:

Synopsis:
Dictionary at: string put: object

Description:

Stores the supplied object at the supplied string in the recipient.

Type: Method          Returns: Object

Parameters:

1 - String
2 - Object

Also Defined At:
| List | String |

o classDescriptor

Synopsis:
Dictionary classDescriptor

Description:

Reference to the object which describes the class. Class level information is stored here.

Type: Constant          Returns: Object

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o cleanupClassStructures

Synopsis:
Dictionary cleanupClassStructures

Description:

Runs 'cleanStoreAndDictionary' at Object, this method is redefined as needed by subclasses to perform general cleanup functions.

Type: Method          Returns: Object

Also Defined At:
| Entity | Object |

o defaultInstance

Synopsis:
Dictionary defaultInstance

Description:

Returns the default instance of the recipient object's class

Type: Constant          Returns: Dictionary

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Entity | IndexedList | Interface | List | Number | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o delete:

Synopsis:
Dictionary delete: string

Description:

Removes string entry from recipient dictionary.

Type: Method          Returns: Object

Parameters:

1 - String

Also Defined At:
| IndexedList | TimeSeries |

o initialize

Synopsis:
Dictionary initialize

Description:

Initializes a new instance of the recipient dictionary. Run as part of the instance creation process.

Type: Method          Returns: Dictionary

Also Defined At:
| Currency | Entity |

o initializeGlobalSubclassProperties

Synopsis:
Dictionary initializeGlobalSubclassProperties

Description:

Initializes a new subclass of the recipient dictionary. Run as part of the subclass creation process.

Type: Method          Returns: Dictionary

Also Defined At:
| Entity | Object |

o initializeLocalAttributes

Synopsis:
Dictionary initializeLocalAttributes

Description:

Initializes the new instance of the recipient dictionary. Run as part of the instance creation process.

Type: Method          Returns: Dictionary

Also Defined At:
| Entity | Object |

o isDictionary

Synopsis:
Dictionary isDictionary

Description:

Returns a TRUE value when sent to any Dictionary

Type: Constant          Returns: TRUE

Also Defined At:
| Object |

o locate:

Synopsis:
Dictionary locate: string

Description:

Finds object associated with the supplied string in dictionary, searching inheritance path if needed.

Type: Method          Returns: Object

Parameters:

1 - String

o new

Synopsis:
Dictionary new

Description:

Special version of 'new' message designed to address the peculiar requirements of dictionary instance creation.

Type: Method          Returns: Dictionary

Also Defined At:
| Boolean | Collection | DateRange | Object | Undefined |

o newAs:

Synopsis:
Dictionary newAs: string

Description:

Special version of 'newAs:' message designed to address the peculiar requirements of dictionary instance creation.

Type: Method          Returns: Dictionary

Also Defined At:
| Entity | Object |

o objects

Synopsis:
Dictionary objects

Description:

Returns list of objects referenced by dictionary entries.

Type: Method          Returns: List

o specialized

Synopsis:
Dictionary specialized

Description:

Special version of 'specialized' message designed to address the peculiar requirements of dictionary subclass creation.

Type: Method          Returns: Dictionary

Also Defined At:
| Object |

o uniformAt:

Synopsis:
Dictionary uniformAt: string

Description:

Returns the object stored at the supplied string. If no object is found, returns the object stored at the string "Default". If no object is found, returns NA.

Type: Method          Returns: Object

Parameters:

1 - String

Also Defined At:
| List |

o whatAmI

Synopsis:
Dictionary whatAmI

Description:

Returns the string "Dictionary".

Type: Constant          Returns: String

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |