IRISLIB database
TranslationDevice Class Reference

This class is intended as a secondary superclass for those Stream classes that are implemented using InterSystems IRIS devices and thus support the use of a Translation Table for character set conversion on input, on output, or both. More...

Inheritance diagram for TranslationDevice:
Collaboration diagram for TranslationDevice:

Public Member Functions

_.Library.Status SetCharEncodingTable (_.Library.String pCharEncoding, _.Library.String pCharEncodingAlias)
 Set translation table based on character encoding.
 
- Public Member Functions inherited from CharacterIO
_.Library.Boolean IsCharacterGet ()
 (This property is overridden from IO.I.Stream but has a different meaning in this context of character IO.)
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Public Member Functions inherited from LineIO
_.Library.String ReadLine (_.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Status pSC, _.Library.String pLineTerminator)
 Read until pMaxReadLen chars are gotten, pTimeout expires, or a LineTerminator character is found. More...
 
 WriteLine (_.Library.String pLine, _.Library.Boolean pFlush, _.Library.Status pSC)
 Write pLine to the stream buffer, followed by the current LineTerminator characters. More...
 

Public Attributes

 IsSingleByte
 Does the TranslationTable currently in effect represent a single-byte encoding. More...
 
 TranslationTable
 The name of the TranslationTable in effect for the Stream's device. More...
 
- Public Attributes inherited from CharacterIO
 CharEncoding
 Names the character encoding used to encode this character stream in its storage or transport format. More...
 
- Public Attributes inherited from ByteIO
 CharEncoding
 Info-only description of the character encoding that this byte stream represents, if it. More...
 
- Public Attributes inherited from LineIO
 LineTerminator
 A string of characters that will be written at the end of each WriteLine operation, and any of which will terminate a ReadLine() operation if it is encountered. More...
 

Additional Inherited Members

- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

This class is intended as a secondary superclass for those Stream classes that are implemented using InterSystems IRIS devices and thus support the use of a 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.

Member Data Documentation

◆ IsSingleByte

IsSingleByte

Does the TranslationTable currently in effect represent a single-byte encoding.

 

◆ TranslationTable

TranslationTable

The name of the TranslationTable in effect for the Stream's device.