Namespace: OpenEdge.Core.Collections
Class
KeySet
Parent classes:
Progress.Lang.Object
OpenEdge.Core.Collections.MapBackedCollection
OpenEdge.Core.Collections.KeySet

Inherits: OpenEdge.Core.Collections.MapBackedCollection
Implements: OpenEdge.Core.Collections.ISet

Purpose: ****************************************************************************
Copyright 2012, 2020 Progress Software Corporation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
File:KeySet
Author(s):hdaniels
Created:apr 2010
Notes:no empty constructor, specialized for KeySet of IMap
- Changes to the map are reflected here, and vice-versa.
- Supports removal and removes the corresponding map entry from the map
(Iterator.remove, Collection.remove, removeAll, retainAll and clear) .
- Do not support add and addAll.
- no empty constructor, specialised for IMap
/* Constructor




Method Summary
Options Name Purpose
LOGICAL Add (Object)
Inherited from OpenEdge.Core.Collections.MapBackedCollection
LOGICAL AddAll (ICollection)
Inherited from OpenEdge.Core.Collections.MapBackedCollection
LOGICAL AddArray (Object[])
Inherited from OpenEdge.Core.Collections.MapBackedCollection
Clear ()
Inherited from OpenEdge.Core.Collections.MapBackedCollection
LOGICAL Contains (Object)
Overrides OpenEdge.Core.Collections.MapBackedCollection:Contains (Object)
LOGICAL ContainsAll (ICollection)
Overrides OpenEdge.Core.Collections.MapBackedCollection:ContainsAll (ICollection)
LOGICAL Equals (Object) /* Equals if Set and every member of the specified set is contained in this set */
LOGICAL IsEmpty ()
Inherited from OpenEdge.Core.Collections.MapBackedCollection
OpenEdge.Core.Collections.IIterator Iterator () /* Returns a new IIterator over the collection. */
Inherited from OpenEdge.Core.Collections.MapBackedCollection
LOGICAL Remove (Object)
Overrides OpenEdge.Core.Collections.MapBackedCollection:Remove (Object)
LOGICAL RemoveAll (ICollection)
Overrides OpenEdge.Core.Collections.MapBackedCollection:RemoveAll (ICollection)
LOGICAL RetainAll (ICollection)
Overrides OpenEdge.Core.Collections.MapBackedCollection:RetainAll (ICollection)
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) */
Inherited from OpenEdge.Core.Collections.MapBackedCollection
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. */
Inherited from OpenEdge.Core.Collections.MapBackedCollection

Constructor Summary
Options Name Purpose
KeySet (IMap, handle, character)
KeySet (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
Inherited from OpenEdge.Core.Collections.MapBackedCollection
HANDLE OwningBuffer
Inherited from OpenEdge.Core.Collections.MapBackedCollection
OpenEdge.Core.Collections.IMap OwningMap
Inherited from OpenEdge.Core.Collections.MapBackedCollection
CHARACTER QueryString
Inherited from OpenEdge.Core.Collections.MapBackedCollection
INTEGER Size
Inherited from OpenEdge.Core.Collections.MapBackedCollection


Method Detail
Top

PUBLIC LOGICAL Add (Object)
Inherited from OpenEdge.Core.Collections.MapBackedCollection
Parameters:
newObject Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC LOGICAL AddAll (ICollection)
Inherited from OpenEdge.Core.Collections.MapBackedCollection
Parameters:
newCollection OpenEdge.Core.Collections.ICollection
Returns LOGICAL
Top

PUBLIC LOGICAL AddArray (Object[])
Inherited from OpenEdge.Core.Collections.MapBackedCollection
Parameters:
o Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC Clear ()
Inherited from OpenEdge.Core.Collections.MapBackedCollection
Top

PUBLIC LOGICAL Contains (Object)
Overrides OpenEdge.Core.Collections.MapBackedCollection:Contains (Object)
Parameters:
poObj Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC LOGICAL ContainsAll (ICollection)
Overrides OpenEdge.Core.Collections.MapBackedCollection:ContainsAll (ICollection)
Parameters:
collection OpenEdge.Core.Collections.ICollection
Returns LOGICAL
Top

PUBLIC LOGICAL Equals (Object)
/* Equals if Set and every member of the specified set is contained in this set
Parameters:
o Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC LOGICAL IsEmpty ()
Inherited from OpenEdge.Core.Collections.MapBackedCollection
Returns LOGICAL
Top

PUBLIC OpenEdge.Core.Collections.IIterator Iterator ()
Inherited from OpenEdge.Core.Collections.MapBackedCollection
/* Returns a new IIterator over the collection.
Returns OpenEdge.Core.Collections.IIterator
Top

PUBLIC LOGICAL Remove (Object)
Overrides OpenEdge.Core.Collections.MapBackedCollection:Remove (Object)
Parameters:
poOld Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC LOGICAL RemoveAll (ICollection)
Overrides OpenEdge.Core.Collections.MapBackedCollection:RemoveAll (ICollection)
Parameters:
collection OpenEdge.Core.Collections.ICollection
Returns LOGICAL
Top

PUBLIC LOGICAL RetainAll (ICollection)
Overrides OpenEdge.Core.Collections.MapBackedCollection:RetainAll (ICollection)
Parameters:
collection OpenEdge.Core.Collections.ICollection
Returns LOGICAL
Top

PUBLIC Progress.Lang.Object ToArray ()
Inherited from OpenEdge.Core.Collections.MapBackedCollection
/* 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

PUBLIC ToTable (table-handle)
Inherited from OpenEdge.Core.Collections.MapBackedCollection
/* 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

PUBLIC KeySet (IMap, handle, character)
Parameters:
poMap OpenEdge.Core.Collections.IMap
phTT HANDLE
pcKeyField CHARACTER
Top

PUBLIC KeySet (IMap, handle, character, character)
/* Constructor
Parameters:
pMap OpenEdge.Core.Collections.IMap
pTT HANDLE
pQueryString CHARACTER
pValueField CHARACTER


Property Detail
Top

PROTECTED HANDLE KeyField
Inherited from OpenEdge.Core.Collections.MapBackedCollection
Returns HANDLE
Top

PROTECTED HANDLE OwningBuffer
Inherited from OpenEdge.Core.Collections.MapBackedCollection
Returns HANDLE
Top

PROTECTED OpenEdge.Core.Collections.IMap OwningMap
Inherited from OpenEdge.Core.Collections.MapBackedCollection
Returns OpenEdge.Core.Collections.IMap
Top

PROTECTED CHARACTER QueryString
Inherited from OpenEdge.Core.Collections.MapBackedCollection
Returns CHARACTER
Top

PUBLIC INTEGER Size
Inherited from OpenEdge.Core.Collections.MapBackedCollection
Returns INTEGER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0