Package org.osid.lexicon

package org.osid.lexicon

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

The Lexicon OSID provides a means for managing and building textual strings ( DisplayTexts ) for the purposes of localizing messages, errors, or other application text that is displayed to a person. The Lexicon OSID provides an extra layer of convenience above the Locale or Dictionary OSIDs while also providing a means for variable substitution for dynamic text construction.

Texts

A Text identifies a set of textual strings that vary by language and/or format.

Idioms

Idioms come into play when managing Texts . An Idiom represents a variant of text for language and format.

Parameters

A Parameter is a substituted value. Parameter values are determined by their Syntax and supplied as arguments is retrieving the textual string in the TextSession . The order of the input arguments is constant across all Idioms in a Text although may appear in different places from one Idiom to the next.

Example (General Usage)

osid.locale.DisplayText text = TextSession.text(pangranmId, {"fox", "dog"});
print(text);

<xosid:token>=> "The quick brown fox jumps over the lazy dog."</xosid:token>        
 

The language, script, and format are determined by the context of the TextSession.

Example (Management)

Text: {pangramId}
Idiom: {idiom1Id, Text=pangramId, language=English string="The quick brown %1 jumped over the lazy %2."}
Idiom: {idiom2Id, Text=pangramId, language=Esperanto string="La rapida bruna %1 susaltas la pigra %2."}
Idiom: {idiom3Id, Text=pangramId, language=English format="Reverse" string="The lazy %2 was jumped over by the quick brown %1."}
Parameter: {parameter1Id, Text=pangramId Syntax=STRING, inputPosition=1}
Parameter: {parameter2Id, Text=pangramId Syntax=STRING, inputPosition=2}        
 

The means in which the Parameters are specified in an Idiom is not currently defined.

Press Cataloging

All Texts , Idioms , and Parameters may be organized into federateable OsidCatalogs called Presses .

Sub Packages

The Lexicon OSID includes a Lexicon Batch OSID for managing texts in bulk.

Copyright © 2014 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 nodify 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 IDIOM 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.

Related Packages

Package	Description
org.osid	The Open Service Interface Definitions for the org.osid service.
org.osid.lexicon.batch	The Open Service Interface Definitions for the org.osid.lexicon.batch service.
org.osid.lexicon.records

Interfaces

Class	Description
Idiom	A Idiom is a localized variant of a Text .
IdiomAdminSession	This session creates, updates, and deletes Idioms .
IdiomForm	This is the form for creating and updating Idioms .
IdiomList	Like all OsidLists , IdiomList provides a means for accessing Idiom elements sequentially either one at a time or many at a time.
IdiomLookupSession	This session provides methods for retrieving Idioms .
IdiomNotificationSession	This session defines methods to receive notifications on adds/changes to Idioms in this Press .
IdiomPressAssignmentSession	This session provides methods to re-assign Idioms to Press mappings.
IdiomPressSession	This session provides methods to retrieve Idiom to Press mappings.
IdiomQuery	This is the query for searching idioms.
IdiomQueryInspector	This is the query inspector for examining idiom queries.
IdiomQuerySession	This session provides methods for searching among Idioms .
IdiomReceiver	The idiom receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Idiom objects.
IdiomSearch	The search interface for governing idiom searches.
IdiomSearchOrder	An interface for specifying the ordering of search results.
IdiomSearchResults	This interface provides a means to capture results of a search.
IdiomSearchSession	This session provides methods for searching among Idioms .
IdiomSmartPressSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
LexiconManager	The lexicon manager provides access to lexicon sessions and provides interoperability tests for various aspects of this service.
LexiconProfile	The lexicon profile describes the interoperability among lexicon services.
LexiconProxyManager	The lexicon proxy manager provides access to lexicon sessions and provides interoperability tests for various aspects of this service.
Parameter	A Parameter specifies a variable substitution in the string of a Text to produce an Idiom .
ParameterAdminSession	This session creates, updates, and deletes Parameters .
ParameterForm	This is the form for creating and updating Parameters .
ParameterList	Like all OsidLists , ParameterList provides a means for accessing Parameter elements sequentially either one at a time or many at a time.
ParameterLookupSession	This session provides methods for retrieving Parameters .
ParameterNotificationSession	This session defines methods to receive notifications on adds/changes to Parameters in this Press .
ParameterPressAssignmentSession	This session provides methods to re-assign Parameter to Press mappings.
ParameterPressSession	This session provides methods to retrieve Parameter to Press mappings.
ParameterQuery	This is the query for searching parameters.
ParameterQueryInspector	This is the query inspector for examning parameter queries.
ParameterQuerySession	This session provides methods for searching among Parameters .
ParameterReceiver	The parameter receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted parameters.
ParameterSearch	The search interface for governing parameter searches.
ParameterSearchOrder	An interface for specifying the ordering of search results.
ParameterSearchResults	This interface provides a means to capture results of a search.
ParameterSearchSession	This session provides methods for searching among Parameters .
ParameterSmartPressSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Press	A Press represents a collection of texts, idioms, and parameters.
PressAdminSession	This session creates, updates, and deletes Presses .
PressForm	This is the form for creating and updating presses.
PressHierarchyDesignSession	This session defines methods for managing a hierarchy of Presses .
PressHierarchySession	This session defines methods for traversing a hierarchy of Presses .
PressList	Like all OsidLists , PressList provides a means for accessing Press elements sequentially either one at a time or many at a time.
PressLookupSession	This session provides methods for retrieving Presses .
PressNode	This interface is a container for a partial hierarchy retrieval.
PressNodeList	Like all OsidLists , PressNodeList provides a means for accessing PressNode elements sequentially either one at a time or many at a time.
PressNotificationSession	This session defines methods to receive notifications on adds/changes to Presses .
PressQuery	This is the query for searching presses.
PressQueryInspector	This is the query inspector for examining press queries.
PressQuerySession	This session provides methods for searching among Presses .
PressReceiver	The press receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Press objects.
PressSearch	The search interface for governing press searches.
PressSearchOrder	An interface for specifying the ordering of search results.
PressSearchResults	This interface provides a means to capture results of a search.
PressSearchSession	This session provides methods for searching among Presses .
Text	A Text .
TextAdminSession	This session creates, updates, and deletes Texts .
TextForm	This is the form for creating and updating Texts .
TextList	Like all OsidLists , TextList provides a means for accessing Text elements sequentially either one at a time or many at a time.
TextLookupSession	This session provides methods for retrieving Text objects.
TextNotificationSession	This session defines methods to receive notifications on adds/changes to Texts in this Press .
TextPressAssignmentSession	This session provides methods to re-assign Texts to Press mappings.
TextPressSession	This session provides methods to retrieve Text to Press mappings.
TextQuery	This is the query for searching texts.
TextQueryInspector	This is the query inspector for examining text queries.
TextQuerySession	This session provides methods for searching among Texts .
TextReceiver	The text receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Text objects.
TextSearch	The search interface for governing text searches.
TextSearchOrder	An interface for specifying the ordering of search results.
TextSearchResults	This interface provides a means to capture results of a search.
TextSearchSession	This session provides methods for searching among Texts .
TextSession	This session defines methods for retrieving DisplayTexts for a Text and set of Parameter arguments.
TextSmartPressSession	This session manages queries and sequencing to create "smart" dynamic catalogs.