[This is preliminary documentation and is subject to change.]
A ValueSet is an arbitrary mapping table used to map an application's
proprietary codes and constants to SIF codes and constants. For example, an
agent might define a ValueSet to map grade levels, ethnicity codes, english
proficiency codes, and so on.
ValueSet stores its data in a HashMap. For each entry in the map, the key is
a value defined by the application and the value is a ValueSetEntry object
that encapsulates the associated SIF value and other fields like a display
title for user interfaces.
For example, a ValueSet that maps grade levels might be comprised of the
following entries:
To translate an application-defined value to its SIF equivalent, call the
CopyC# method. To translate a SIF-defined value to its
application-defined equivalent, call the CopyC#
method.
| Key | Value |
| PREK | PK |
| K | 0K |
| 1 | 01 |
| 2 | 02 |
| 3 | 03 |
| 4 | 04 |
| 5 | 05 |
| 6 | 06 |
| 7 | 07 |
| 8 | 08 |
| 9 | 09 |
CopyC#translate
CopyC#translateReverse
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class ValueSet : IComparer
<SerializableAttribute> _ Public Class ValueSet _ Implements IComparer
[SerializableAttribute] public ref class ValueSet : IComparer
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | ValueSetValueSetNew(String) | Constructs a ValueSet with an ID |
| ValueSetValueSetNew(String, String) | Constructs a ValueSet with an ID and display title |
| ValueSetValueSetNew(String, String, XmlElement) | Constructs a ValueSet with an ID, display title, and associated DOM XmlElement |
| Clear()() | Clears the table |
| Compare(Object, Object) | Compares two ValueSetEntry objects for order |
| Copy(Mappings) | |
| Define(String, String, String) | Sets a value |
| Define(String, String, String, XmlElement) | Sets a value |
 | Entries | Return a sorted array of the ValueSet's entries |
| Id | |
| Lookup(String) | Gets a value |
| Map | |
| Remove(String) | Removes a value |
| ReverseMap | |
| Title | |
| ToString()() | (Overrides Object.ToString()().) |
| Translate(String) | Translates a value.
This method differs from CopyC#get CopyC#get |
| TranslateReverse(String) | Performs a reverse translation.
|
| XmlElement |
Inheritance Hierarchy| Object | |
 | ValueSet |