Namespace: OpenEdge.Core.Collections
Type: Class MapBackedCollection
Parent Classes:
Progress.Lang.Object
OpenEdge.Core.Collections.MapBackedCollection

Inherits: Progress.Lang.Object
Implements: OpenEdge.Core.Collections.ICollection

Copyright (c) 2013, 2017, 2020, 2022-2023 by Progress Software Corporation. All rights reserved.
File:MapBackedCollection
Purpose:This class acts as a helper for the Key and Value collections that comprise a temp-table-based Map
Author(s):pjudge
Created:Mon Dec 16 16:24:45 EST 2013
Notes:DEPRECATED: This class is retained for backwards compatibility
with applications using the OpenEdge.Core.Collections though
for Map objects it is highly recommended to directly use the
new Progress.Collections.HashMap<K,V> class directly.



Method Summary
  Options Name Purpose
  LOGICAL Add (Object)
  LOGICAL AddAll (ICollection)
  LOGICAL AddArray (Object[])
  LOGICAL AddNull ()
  Clear ()
  LOGICAL Contains (Object) /* abstract because this could be a key or value */
  LOGICAL ContainsAll (ICollection) /* abstract because this could be a collection of keys or values */
  LOGICAL IsEmpty ()
  OpenEdge.Core.Collections.IIterator Iterator () /* Returns a new IIterator over the collection. */
  LOGICAL Remove (Object) /* abstract because this could be a collection of keys or values */
  LOGICAL RemoveAll (ICollection) /* abstract because this could be a collection of keys or values */
  LOGICAL RetainAll (ICollection) /* abstract because this could be a collection of keys or values */
  Progress.Lang.Object ToArray () /* ToArray should not be used with large collections If there is too much data the ABL will throw: Attempt to update data exceeding 32000. (12371) */
  ToTable (table-handle) /* Returns a TT of the collection's data. This may be expensive, depending on the amount of data in the map. @param output table-handle A TT containing the data. */

Constructor Summary
  Options Name Purpose
  MapBackedCollection (IMap, handle, character)
  MapBackedCollection (IMap, handle, character, character) /* Constructor @param IMap The owning map @param handle The underlying TT holding the data @param character (optional) Query string @param character The field holding the data in the TT */

Property Summary
  Options Name Purpose
  HANDLE KeyField
  HANDLE OwningBuffer
  OpenEdge.Core.Collections.IMap OwningMap
  CHARACTER QueryString
  INTEGER Size


Method Detail
Top

LOGICAL Add (Object)

Parameters:
newObject Progress.Lang.Object
 
Returns LOGICAL
 
Top

LOGICAL AddAll (ICollection)

Parameters:
newCollection OpenEdge.Core.Collections.ICollection
 
Returns LOGICAL
 
Top

LOGICAL AddArray (Object[])

Parameters:
o Progress.Lang.Object
 
Returns LOGICAL
 
Top

LOGICAL AddNull ()

Returns LOGICAL
 
Top

Clear ()
Top

LOGICAL Contains (Object)

/* abstract because this could be a key or value
Parameters:
checkObject Progress.Lang.Object
 
Returns LOGICAL
 
Top

LOGICAL ContainsAll (ICollection)

/* abstract because this could be a collection of keys or values
Parameters:
poCollection OpenEdge.Core.Collections.ICollection
 
Returns LOGICAL
 
Top

LOGICAL IsEmpty ()

Returns LOGICAL
 
Top

OpenEdge.Core.Collections.IIterator Iterator ()

/* Returns a new IIterator over the collection.
Returns OpenEdge.Core.Collections.IIterator
 
Top

LOGICAL Remove (Object)

/* abstract because this could be a collection of keys or values
Parameters:
poOld Progress.Lang.Object
 
Returns LOGICAL
 
Top

LOGICAL RemoveAll (ICollection)

/* abstract because this could be a collection of keys or values
Parameters:
poRemoveCol OpenEdge.Core.Collections.ICollection
 
Returns LOGICAL
 
Top

LOGICAL RetainAll (ICollection)

/* abstract because this could be a collection of keys or values
Parameters:
poRetainCollection OpenEdge.Core.Collections.ICollection
 
Returns LOGICAL
 
Top

Progress.Lang.Object ToArray ()

/* ToArray should not be used with large collections
If there is too much data the ABL will throw:
Attempt to update data exceeding 32000. (12371)
Returns Progress.Lang.Object
 
Top

ToTable (table-handle)

/* Returns a TT of the collection's data.
This may be expensive, depending on the amount of data in the map.
Parameters:
tt TABLE-HANDLE
 


Constructor Detail
Top

MapBackedCollection (IMap, handle, character)

Parameters:
poMap OpenEdge.Core.Collections.IMap
 
phTT HANDLE
 
pcValuefield CHARACTER
 
Top

MapBackedCollection (IMap, handle, character, character)

/* Constructor
Parameters:
pMap OpenEdge.Core.Collections.IMap
 
pTT HANDLE
 
pQueryString CHARACTER
 
pValuefield CHARACTER
 


Property Detail
Top

HANDLE KeyField

Returns HANDLE
 
Top

HANDLE OwningBuffer

Returns HANDLE
 
Top

OpenEdge.Core.Collections.IMap OwningMap

Returns OpenEdge.Core.Collections.IMap
 
Top

CHARACTER QueryString

Returns CHARACTER
 
Top

INTEGER Size

Returns INTEGER