Package org.osid.dictionary

package org.osid.dictionary

The Open Service Interface Definitions for the org.osid.dictionary service.

The Dictionary OSID manages key/value pairs. A key and a value may be of an arbitrary type. Dictionaries may be used to support a Locale or Configuration OSID, or may be used to provide any dynamic translation or conversion. The Dictionary OSID is a powerful tool for abstracting and simplifying applications and other OSID implementations.

Entries

An Entry is indexed by a key and may contain multiple values of different types. The key, key type, and value type must be unique. The interpretation of the value and key are specified through the value type and key type.

Dictionary

Entries may be organized into federatable OsidCatalogs called Dictionaries .

Basic Example: 

EntryLookupSession lookupSession = mgr.getEntryLookupSession();
string definition = (string) lookupSession.getEntry("gambrel", strType, strType);

Federated Example: 

DictionaryLookupSession dictLookupSession = mgr.getDictionaryLookupSession();
Dictionary dict = dictLookupSession.getDictionary(dict_id);
EntryLookupSession lookupSession = mgr.getEntryLookupSessionForDictionary(dict);
JpegImage jpg = lookupSession.getEntry(tiffImage, tiffType, jpegType);


Copyright © 2002-2004, 2006-2008 Massachusetts Institute of Technology.

Copyright © 2010 Ingenescus. All Rights Reserved.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may modify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.

  • Interfaces
    Class
    Description
    Dictionary
    A Dictionary represents a collection of entries.
    DictionaryAdminSession
    This session creates, updates, and deletes Dictionaries .
    DictionaryForm
    This is the form for creating and updating a Dictionary .
    DictionaryHierarchyDesignSession
    This session manages a hierarchy of dictionaries.
    DictionaryHierarchySession
    This session defines methods for traversing a hierarchy of Dictionaries .
    DictionaryList
    Like all OsidLists , DictionaryList provides a means for accessing Dictionary elements sequentially either one at a time or many at a time.
    DictionaryLookupSession
    This session provides methods for retrieving Dictionaries .
    DictionaryManager
    The dictionary manager provides access to dictionary sessions and provides interoperability tests for various aspects of this service.
    DictionaryNode
    This interface is a container for a partial hierarchy retrieval.
    DictionaryNodeList
    Like all OsidLists , DictionaryNodeList provides a means for accessing DictionaryNode elements sequentially either one at a time or many at a time.
    DictionaryNotificationSession
    This session defines methods to receive notifications on adds/changes to Dictionaries .
    DictionaryProfile
    The DictionaryProfile describes the interoperability among dictionary services.
    DictionaryProxyManager
    The dictionary manager provides access to dictionary sessions and provides interoperability tests for various aspects of this service.
    DictionaryQuery
    This is the query for searching dictionaries.
    DictionaryQueryInspector
    This is the query inspector for examining dictionary searches.
    DictionaryQuerySession
    This session provides methods for searching Dictionaries .
    DictionaryReceiver
    The dictionary receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Dictionary objects.
    DictionarySearch
    This interface defines search options.
    DictionarySearchOrder
    An interface for specifying the ordering of search results.
    DictionarySearchResults
    This interface provides a means to capture results of a search.
    DictionarySearchSession
    This session provides methods for searching Dictionaries .
    Entry
    An Entry contains a key and a value.
    EntryAdminSession
    EntryAdminSession creates, updates and deletes dictionary entries.
    EntryDictionaryAssignmentSession
    This session provides methods to re-assign enrties to dictionaries.
    EntryDictionarySession
    This session provides methods to retrieve Entry to Dictionary mappings.
    EntryForm
    This is the form for creating and updating an Entry .
    EntryList
    Like all OsidLists , EntryList provides a means for accessing Entry elements sequentially either one at a time or many at a time.
    EntryLookupSession
    EntryLookupSession is used to look up dictionary entries.
    EntryNotificationSession
    This session defines methods to receive notifications on adds/changes to Entries within a Dictionary .
    EntryQuery
    This is the query for searching dictionary entries.
    EntryQueryInspector
    This is the query inspector for examining entry queries.
    EntryQuerySession
    This session provides methods for searching among entries.
    EntryReceiver
    The dictionary entry receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Entry objects.
    EntryRetrievalSession
    EntryRetrievalSession is used to get dictionary entries.
    EntrySearch
    This interface specifies options for governing entry searches.
    EntrySearchOrder
    This interface specifies options for ordering search results.
    EntrySearchResults
    This interface provides a means to capture results of a search.
    EntrySearchSession
    This session provides methods for searching among entries.
    EntrySmartDictionarySession
    This session manages queries and sequencing to create "smart" dynamic catalogs.