DocBook|Search
Class Reference
%IO.I.TranslationDevice
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%IO] >  [I] >  [TranslationDevice]
Private  Storage  

abstract class %IO.I.TranslationDevice extends %IO.IParts.CharacterIO

This class is intended as a secondary superclass for those Stream classes that are implemented using Cache devices and thus support the use of a Cache Translation Table for character set conversion on input, on output, or both. It contains a property TranslationTable that names the translation table to be used, if any. It also implements a number of classmethods to support the use of a Translation Table. This class also extends the class ILineStream which facilitates line-by-line Read and Write operations.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 12


Summary

Properties
CharEncoding IsSingleByte LineTerminator TranslationTable

Methods
%%OIDGet %AddToSaveSet %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject CharEncodingSet GetCharEncodingTable GetDeviceLineTerminator
GetDeviceTranslationTable GetLocaleDefaultTable GetTableCharEncoding IsCharacterGet
IsLocaleUnicode IsTableSingleByte ReadLine SetCharEncodingTable
SetDeviceLineTerminator SetDeviceTranslationTable SetTranslationTable TranslationTableSet
WriteLine

Subclasses
%IO.DeviceStream

Properties

• property IsSingleByte as %Boolean;
Does the TranslationTable currently in effect represent a single-byte encoding.
• property TranslationTable as %String;
The name of the TranslationTable in effect for the Stream's device.

Methods

• classmethod GetCharEncodingTable(pCharEncoding As %String) as %String
• classmethod GetDeviceLineTerminator(pDevice As %String) as %String
• classmethod GetDeviceTranslationTable(pDevice As %String) as %String
• classmethod GetLocaleDefaultTable() as %String
• classmethod GetTableCharEncoding(pTable As %String) as %String
• classmethod IsLocaleUnicode() as %Boolean
• classmethod IsTableSingleByte(pTable As %String) as %String
• method SetCharEncodingTable(pCharEncoding As %String, pCharEncodingAlias As %String) as %Status
Set translation table based on character encoding
• classmethod SetDeviceLineTerminator(pDevice As %String, pLineTerm As %String, Output pSC As %Status)
• classmethod SetDeviceTranslationTable(pDevice As %String, pTable As %String, Output pSC As %Status) as %String
• method SetTranslationTable(pTable As %String) as %Status
• method TranslationTableSet(pTable As %String) as %Status
This is a Set accessor method for the TranslationTable property.