This class is a description of a locale. More...
Public Member Functions | |
ConvertCacheToIRIS () | |
Convert Cache standard collation to IRIS standard. | |
GetTables (_.Library.String Tables) | |
Gets all tables defined in a locale and creates an array with. More... | |
_.Library.Status | ValidateConfigDefaults () |
Remove any configured table default not available in this locale. | |
def | __init__ (self) |
Deprecated. More... | |
Public Attributes | |
AM | |
Sufix which may optionally be appended to time values. More... | |
AccentTable | |
The default accent table. More... | |
AccentTables | |
List of available accent tables. More... | |
CharacterSet | |
Name of character set on which this locale is based. More... | |
CollationTable | |
The default collation table. More... | |
CollationTables | |
List of available collation tables. More... | |
Country | |
Country supported by this locale. More... | |
CountryAbbr | |
ISO 3166 two-letter abbreviation of Country. More... | |
Currency | |
Currency symbol (string) encoded in native character set. More... | |
DateFormat | |
The DateFormat code used whenever a $ZDATE, $ZDATEH,. More... | |
DateMaximum | |
The maximum value for a date allowed in $ZDATE, $ZDATEH,. More... | |
DateMinimum | |
The minimum value for a date allowed in $ZDATE, $ZDATEH,. More... | |
DateSeparator | |
The character used to delimit the months, days, and years. More... | |
DecimalSeparator | |
The character used by the $FNUMBER function to separate. More... | |
Description | |
Simple description of locale. More... | |
IdentifierTable | |
The default identifier table. More... | |
IdentifierTables | |
List of available identifier tables. More... | |
Language | |
Localization language for this locale. More... | |
LanguageAbbr | |
ISO 639-2 two-letter abbreviation of Language. More... | |
LowerCaseTable | |
The default lower-case table. More... | |
LowerCaseTables | |
List of available lower-case tables. More... | |
Midnight | |
The suffix which may optionally be appended to time. More... | |
MinusSign | |
The character which may precede or follow a negative. More... | |
MonthAbbr | |
The abbreviations of the names of the twelve months,. More... | |
MonthName | |
The full names of the twelve months, used whenever a. More... | |
Name | |
Code name of the locale. More... | |
Noon | |
The suffix which may optionally be appended to time values. More... | |
NumericGroupSeparator | |
The character used to separate groups of numeric digits. More... | |
NumericGroupSize | |
The number of digits in a numeric group formatted by the. More... | |
PM | |
The suffix which may optionally be appended to time values. More... | |
PatternTable | |
The default pattern match table. More... | |
PatternTables | |
List of available pattern match tables. More... | |
PhysicalCursor | |
True if terminals should have Physical Cursor set by default. More... | |
PlusSign | |
The character which may optionally precede or follow a. More... | |
Resource | |
TimeFormat | |
The TimeFormat code used whenever a $ZDATETIME, $ZDATETIMEH,. More... | |
TimePrecision | |
The number of fractional digits displayed in a time value. More... | |
TimeSeparator | |
The character used to delimit the hours, minutes and seconds. More... | |
TitleCaseTable | |
The default title-case table. More... | |
TitleCaseTables | |
List of available title-case tables. More... | |
TranDDP | |
The default translation table for DDP. More... | |
TranDTMDCP | |
The default translation table for DTM-DCP. More... | |
TranMagTape | |
The default translation table for magtapes. More... | |
TranPrinter | |
The default translation table for printers. More... | |
TranProgrammer | |
The default translation table for the InterSystems IRIS Terminal. More... | |
TranSequential | |
The default translation table for files and other sequential devices. More... | |
TranSystemCall | |
The default translation table for OS system calls. More... | |
TranTCP | |
The default translation table for TCP/IP connections. More... | |
TranTerminal | |
The default translation table for LAT and Telnet terminals. More... | |
TranZCVT | |
The default translation table for $ZCVT(). More... | |
UpperCaseTable | |
The default upper-case table. More... | |
UpperCaseTables | |
List of available upper-case tables. More... | |
WeekdayAbbr | |
The abbreviations of the names of the seven days of the. More... | |
WeekdayName | |
The full names of the seven days of the week, starting. More... | |
XLTTables | |
("table name")=$LB(InputFrom,InputTo,OutputFrom,OutputTo) More... | |
XYTable | |
The default $X/$Y table. More... | |
XYTables | |
List of available $X/$Y tables. More... | |
YearOption | |
The YearOption code used whenever a $ZDATE, $ZDATEH,. More... | |
Static Public Attributes | |
DOMAIN = None | |
Default Localization Domain. | |
This class is a description of a locale.
A locale contains:
Warning!
Only locales whose names begin with "y" (e.g. "yda8" or "yptw") are considered custom locales and are preserved during system upgrades. All other locales are restored to their original state and any changes to them made with methods from this class will be lost in an upgrade.
def __init__ | ( | self | ) |
Deprecated.
For compatibility with previous versions.
|
static |
Compiles a single Locale<br>
Parameters:
|
static |
Creates a Locale in the NLS database.
Parameters:
|
static |
|
static |
Checks for the existence of a Locale in the NLS database.
Parameters:
Return values:
If Value of the method = 0 (Locale does not exist, or some error occured)
If Value of the method = 1 (Locale exists)
|
static |
|
static |
|
static |
|
static |
|
static |
Exports one Locale record to ^nls.
Parameters:
|
static |
GetTables | ( | _.Library.String | Tables | ) |
Gets all tables defined in a locale and creates an array with.
Table(<type>,<from>,<to>)
|
static |
Imports Locale records from an xml file.
Parameters:
Note: On failure, no records will be imported
|
static |
Imports all NLS records from an xml file.
Parameters:
Note: On failure, no records will be imported
|
static |
Imports all Locale records from ^nls.
Parameters:
|
static |
Imports locale files from a directory.
Parameters:
|
static |
Imports one Locale record from ^nls.
Parameters:
|
static |
Imports all NLS records from a legacy goq file.
Parameters:
Note: System records are skipped
|
static |
Sets the new "current locale" and loads its tables.
If the desired locale is not loadable, compiles it it before the installation.
Parameter:
|
static |
Checks whether a locale can be installed in the current system<br>
Parameters:
Warnings - Returned list of warnings Returns: True if the locale can be installed
False otherwise
|
static |
Verifies whether a locale can be loaded<br>
Parameters:
Returns: True if all its tables are loadable
False otherwise
|
static |
Verifies validity of locale<br>
Parameters:
Warnings - Returned list of warnings Returns: True if the locale has a consistent definition
False otherwise
|
static |
Loads all the tables from a Locale and sets the.
defaults as approprate
|
static |
Modifies an existing Locale's properties in the NLS database.
Parameters:
AM |
Sufix which may optionally be appended to time values.
prior to 12 noon.
Example: "AM"
AccentTable |
The default accent table.
AccentTables |
List of available accent tables.
CharacterSet |
Name of character set on which this locale is based.
Examples: "Latin1", "CP1251", "Unicode"
CollationTable |
The default collation table.
CollationTables |
List of available collation tables.
Country |
Country supported by this locale.
CountryAbbr |
ISO 3166 two-letter abbreviation of Country.
Example: US
Currency |
Currency symbol (string) encoded in native character set.
DateFormat |
The DateFormat code used whenever a $ZDATE, $ZDATEH,.
$ZDATETIME or $ZDATETIMEH function call omits its second parameter, or specifies a second parameter value of -1.
Example: 1
DateMaximum |
The maximum value for a date allowed in $ZDATE, $ZDATEH,.
$ZDATETIME or $ZDATETIMEH functions.
Example: 94232 (12/30/2098)
DateMinimum |
The minimum value for a date allowed in $ZDATE, $ZDATEH,.
$ZDATETIME or $ZDATETIMEH functions.
Example: 1
DateSeparator |
The character used to delimit the months, days, and years.
of those dates which are otherwise entirely numeric.
Example: "/"
DecimalSeparator |
The character used by the $FNUMBER function to separate.
the whole part of a number from the fractional part of the number. Also used by $ZDATETIME, $ZDATETIMEH, $ZTIME and $ZTIMEH to separate the whole part of the seconds from the optional fractional part of the seconds, if any.
Example: "."
Description |
Simple description of locale.
Usually in one of these formats:
IdentifierTable |
The default identifier table.
IdentifierTables |
List of available identifier tables.
Language |
Localization language for this locale.
LanguageAbbr |
ISO 639-2 two-letter abbreviation of Language.
possibly followed by "-" and CountryAbbr.
Examples: fr, en-US
LowerCaseTable |
The default lower-case table.
LowerCaseTables |
List of available lower-case tables.
Midnight |
The suffix which may optionally be appended to time.
values corresponding to exactly 12 midnight.
Example: "MIDNIGHT"
MinusSign |
The character which may precede or follow a negative.
numeric quantity formatted by the $FNUMBER function.
Example: "-"
MonthAbbr |
The abbreviations of the names of the twelve months,.
used whenever a $ZDATE, $ZDATEH, $ZDATETIME or $ZDATETIMEH function call omits its MonthNameList parameter, or specifies a MonthNameList parameter value of -1, and the selected date format uses month name abbreviations (i.e., the effective DateFormat code is 0, 2, 5, 6 or 7)
Example: " Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec"
MonthName |
The full names of the twelve months, used whenever a.
$ZDATE, $ZDATEH, $ZDATETIME or $ZDATETIMEH function call omits its MonthNameList parameter, or specifies a MonthNameList parameter value of -1, and the selected date format uses full month names (i.e., the effective DateFormat code is 9).
Example: " January February March April... November December"
Name |
Code name of the locale.
Generally this is a 3-letter code
expressing the language and country followed by a character size indicator: "8" for 8-bit character sets and "w" for Unicode.
Noon |
The suffix which may optionally be appended to time values.
corresponding to exactly 12 noon.
Example: "NOON"
NumericGroupSeparator |
The character used to separate groups of numeric digits.
within the whole number portion of a number formatted by the $FNUMBER function.
Example: ","
NumericGroupSize |
The number of digits in a numeric group formatted by the.
$FNUMBER function.
Example: 3
PM |
The suffix which may optionally be appended to time values.
at or after 12 noon.
Example: "PM"
PatternTable |
The default pattern match table.
PatternTables |
List of available pattern match tables.
PhysicalCursor |
True if terminals should have Physical Cursor set by default.
Used by Japanese locales
PlusSign |
The character which may optionally precede or follow a.
non-negative numeric quantity formatted by the $FNUMBER function.
Example: "+"
Resource |
TimeFormat |
The TimeFormat code used whenever a $ZDATETIME, $ZDATETIMEH,.
$ZTIME or $ZTIMEH function call omits its TimeFormat parameter, or specifies a TimeFormat parameter value of -1.
Example: 1
TimePrecision |
The number of fractional digits displayed in a time value.
whenever a $ZDATETIME or $ZTIME function call omits its Precision parameter, or specifies a Precision parameter value of -1.
Example: 0
TimeSeparator |
The character used to delimit the hours, minutes and seconds.
in a time value.
Example: ":"
TitleCaseTable |
The default title-case table.
TitleCaseTables |
List of available title-case tables.
TranDDP |
The default translation table for DDP.
TranDTMDCP |
The default translation table for DTM-DCP.
TranMagTape |
The default translation table for magtapes.
TranPrinter |
The default translation table for printers.
TranProgrammer |
The default translation table for the InterSystems IRIS Terminal.
TranSequential |
The default translation table for files and other sequential devices.
TranSystemCall |
The default translation table for OS system calls.
TranTCP |
The default translation table for TCP/IP connections.
TranTerminal |
The default translation table for LAT and Telnet terminals.
TranZCVT |
The default translation table for $ZCVT().
UpperCaseTable |
The default upper-case table.
UpperCaseTables |
List of available upper-case tables.
WeekdayAbbr |
The abbreviations of the names of the seven days of the.
week, starting with Sunday and ending with Saturday, used whenever a $ZDATE or $ZDATEIME function call selects a date format which uses weekday name abbreviations (i.e., the effective DateFormat code is 11).
Example: " Sun Mon Tue Wed Thu Fri Sat"
WeekdayName |
The full names of the seven days of the week, starting.
with Sunday and ending with Saturday, used whenever a $ZDATE or $ZDATEIME function call selects a date format which uses full weekday names (i.e., the effective DateFormat code is 12).
Example: " Sunday Monday Tuesday... Friday Saturday"
XLTTables |
("table name")=$LB(InputFrom,InputTo,OutputFrom,OutputTo)
Example: TranslationTables("LatinG")=$LB("LatinG","Unicode","Unicode","LatinG")
XYTable |
The default $X/$Y table.
XYTables |
List of available $X/$Y tables.
YearOption |
The YearOption code used whenever a $ZDATE, $ZDATEH,.
$ZDATETIME or $ZDATETIMEH function call omits its YearOption parameter, or specifies a YearOption parameter value of -1.
Example: 0