Config.NLS.SubTables

persistent class Config.NLS.SubTables extends %Library.Persistent, %XML.Adaptor, %SYSTEM.Help

SQL Table Name: Config_NLS.SubTables

The objects of this class contain the data points for tables of type XLT, COL, Case and the input side of Mode tables.
The name of a sub-table is a string with three pieces separated by "-": type-from-to

Warning!

Only sub-tables whose names have a "from" or "to" piece beginning with "y" (e.g. "XLT-yEBCDIC-Unicode" or "XLT-Latin1-yPrinter") or that end with a dot followed by 4 digits (e.g. "XLT-CP1250-Unicode.0001") are considered custom sub-tables and are preserved during system upgrades. All other sub-tables are restored to their original state and any changes to them made with methods from this class will be lost in an upgrade.

Property Inventory (Including Private)

• Description
• FromTo
• Name
• Type

Method Inventory (Including Private)

• Create()
• CreateSkeleton()
• Delete()
• Exists()
• Export()
• ExportAllToNls()
• ExportDir()
• ExportList()
• ExportToNls()
• Get()
• Import()
• ImportAllFromNls()
• ImportDir()
• ImportFromNls()
• Modify()

Copy link to this sectionProperties

Copy link to this section property Description as %String (MAXLEN = 128);

Description of the SubTable.

Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()

Copy link to this section property FromTo as array of %String;

Each node of this array contains one mapping. Both the index and the value of the node can be either a single character code (e.g. "168") or a comma-separated list of codes (e.g. "251,128,65"). For collation tables, the value can contain a disambiguator (e.g. "65,65;1").

Property methods: FromToBuildValueArray(), FromToCollectionToDisplay(), FromToCollectionToOdbc(), FromToDisplayToCollection(), FromToDisplayToLogical(), FromToGet(), FromToGetObject(), FromToGetObjectId(), FromToGetStored(), FromToGetSwizzled(), FromToIsValid(), FromToLogicalToDisplay(), FromToLogicalToOdbc(), FromToNormalize(), FromToOdbcToCollection(), FromToSet(), FromToSetObject(), FromToSetObjectId()

Copy link to this section property Name as %String (MAXLEN = 64, MINLEN = 1) [ Required ];

The name of a sub-table contains 3 parts separated by "-": type, source encoding and target encoding.

Examples: "XLT-Latin2-Unicode", "COL-Latin1-German2"

Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIndexCheck(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

Copy link to this section property Type as %Integer (MAXVAL = 6, MINVAL = 0) [ Required ];

Type of sub-table.

• 0 - SUBSingle
• 1 - SUBToMulti
• 2 - SUBFromMulti
• 3 - SUBMulti
• 4 - SUBLeadByte
• 5 - SUBToCol
• 6 - SUBFromCol

Property methods: TypeDisplayToLogical(), TypeGet(), TypeGetStored(), TypeIsValid(), TypeLogicalToDisplay(), TypeNormalize(), TypeSet(), TypeXSDToLogical()

Copy link to this sectionMethods

Copy link to this section classmethod Create(Name, ByRef Properties As %String) as %Status [ Language = objectscript ]

Creates a SubTable the NLS database.

Parameters:

• Name - Name of the SubTable to create
• Properties - Array of properties corresponding to the class properties

Copy link to this section classmethod CreateSkeleton(Name As %String, Maxchar As %Integer, ByRef SubTable As %ObjectHandle) as %Status [ Language = objectscript ]

Creates a SubTable with common default parameters.
Doesn't require passing a complete subtable specification. Sets each character mapping to itself.

Parameters:

• Name - Name of the SubTable to create
• MaxChar - Highest character (0, 255 or 65535)
• SubTable - Return oref of created object

Copy link to this section classmethod Delete(Name As %String) as %Status [ Language = objectscript ]

Deletes a SubTable.

Parameters:

• Name - Name of SubTable to delete

Copy link to this section classmethod Exists(Name As %String, ByRef SubTable As %ObjectHandle, ByRef Status As %Status) as %Boolean [ Language = objectscript ]

Checks for the existence of a SubTable in the NLS database.

Parameters:

• Name - Name of the SubTable to check existence of

Return values:
If Value of the method = 0 (SubTable does not exist, or some error occured)

• SubTable = Null
• Status = SubTable "x" does not exist, or other error message

If Value of the method = 1 (SubTable exists)

• SubTable = Object handle to SubTable
• Status = $$$OK

Copy link to this section classmethod Export(FileName As %String = "SubTablesExport.xml", ByRef NumExported As %Integer, SubTables As %String = "*") as %Status [ Language = objectscript ]

Exports SubTable Objects to a file in xml format.

Parameters:

• FileName - Output file name
• NumExported (byref) - Returns number of SubTable records exported.
• SubTables - Comma separated list of SubTables to export, "*" = All

Copy link to this section classmethod ExportAllToNls(ByRef NumExported As %Integer) as %Status [ Language = objectscript ]

Exports all SubTable records to ^%nls.

Parameters:

• NumExported - Number of exported records

Copy link to this section classmethod ExportDir(Dir As %String, ByRef NumExported As %Integer, SubTables As %String = "*") as %Status [ Language = objectscript ]

Exports SubTable Objects to separate xml files.

Parameters:

Dir - Directory where the files will be created

NumExported (byref) - Returns number of SubTable records exported.

SubTables - Comma separated list of SubTables to export, "*" = All

Copy link to this section classmethod ExportList(FileName As %String = "SubTablesExport.xml", ByRef NumExported As %Integer, ByRef SubTables As %String) as %Status [ Language = objectscript ]

Similar to Export() but uses a list of SubTables to export rather than a query. Used internally by Tables.ExportList() and other utilities.

Parameters:

• FileName - Output file name
• NumExported - Number of exported SubTables [out]
• SubTables - Array of SubTables to export

Copy link to this section classmethod ExportToNls(sub As %String) as %Status [ Language = objectscript ]

Exports ONE SubTable record to ^%nls.

Parameters:

• Name - SubTable name

Copy link to this section classmethod Get(Name As %String, ByRef Properties As %String) as %Status [ Language = objectscript ]

Gets a SubTable's properties from the NLS database.

Parameters:

• Name - Name of the SubTable to get
• Properties - Array of properties. See the Create() method for a full list

Copy link to this section classmethod Import(FileName As %String = "SubTablesExport.xml", ByRef NumImported As %Integer, Flags As %Integer = 0) as %Status [ Language = objectscript ]

Imports SubTable records from an xml file.

Parameters:

• FileName - Filename to import SubTable records from
• NumImported (byref) - Returns number of records imported
• Flags - Control import
• Bit 0 - Do not import records, just return count

Copy link to this section classmethod ImportAllFromNls(ByRef NumImported As %Integer, Flags As %Integer = 0, Ref As %String = "^%nls") as %Status [ Language = objectscript ]

Imports all SubTable records from ^%nls.

Parameters:

• NumImported (byref) - Returns number of records imported
• Flags - Control import
• Bit 0 - Do not import records, just return count
• Ref - Source global reference

Copy link to this section classmethod ImportDir(Dir As %String, ByRef NumImported As %String, forcemulticompile As %Boolean = "") as %Status [ Language = objectscript ]

Imports subtable files from a directory.

Parameters:

• Dir - Directory to import NLS files from
• NumImported (byref) - Returns number of subtables imported.

Copy link to this section classmethod ImportFromNls(Sub As %String, Ref As %String = "^%nls") as %Status [ Language = objectscript ]

Imports SubTable record from ^%nls.

Parameters:

• Name - SubTable name
• Ref - Source global reference

Copy link to this section classmethod Modify(Name As %String, ByRef Properties As %String) as %Status [ Language = objectscript ]

Modifies an existing SubTable's properties in the NLS database.

Parameters:

• Name - Name of the SubTable to modify
• Properties - Array of properties to modify.
If a specific property is not passed in the properties array, or is the same as the existing value, the value is not modified.

Copy link to this sectionQueries

Copy link to this section query List(Names As %String)

Selects Name As %String, Description As %String

Copy link to this sectionIndices

Copy link to this section index (NameIndex on Name) [IdKey, Type = key];

Index methods: NameIndexCheck(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()

Copy link to this sectionInherited Members

Inherited Methods (Including Private)

• %AcquireLock()
• %AddToSaveSet()
• %AddToSyncSet()
• %BMEBuilt()
• %BuildIndicesAsync()
• %BuildIndicesAsyncResponse()
• %CheckConstraints()
• %CheckConstraintsForExtent()
• %ClassIsLatestVersion()
• %ClassName()
• %ComposeOid()
• %ConstructClone()
• %ConstructCloneInit()
• %Delete()
• %DeleteData()
• %DeleteExtent()
• %DeleteId()
• %DispatchClassMethod()
• %DispatchGetModified()
• %DispatchGetProperty()
• %DispatchMethod()
• %DispatchSetModified()
• %DispatchSetMultidimProperty()
• %DispatchSetProperty()
• %Exists()
• %ExistsId()
• %Extends()
• %GUID()
• %GUIDSet()
• %GetLock()
• %GetParameter()
• %GetSwizzleObject()
• %Id()
• %InsertBatch()
• %IsA()
• %IsModified()
• %IsNull()
• %KillExtent()
• %KillExtentData()
• %LoadData()
• %LoadFromMemory()
• %LockExtent()
• %LockId()
• %New()
• %NormalizeObject()
• %ObjectIsNull()
• %ObjectModified()
• %Oid()
• %OnAddToSaveSet()
• %OnAfterBuildIndices()
• %OnAfterDelete()
• %OnAfterPurgeIndices()
• %OnBeforeAddToSync()
• %OnBeforeBuildIndices()
• %OnBeforePurgeIndices()
• %OnClose()
• %OnConstructClone()
• %OnDeleteFinally()
• %OnDetermineClass()
• %OnJournalObject()
• %OnNew()
• %OnOpen()
• %OnOpenFinally()
• %OnReload()
• %OnRollBack()
• %OnSaveFinally()
• %Open()
• %OpenId()
• %OriginalNamespace()
• %PackageName()
• %PhysicalAddress()
• %PurgeIndices()
• %ReleaseLock()
• %Reload()
• %RemoveFromSaveSet()
• %ResolveConcurrencyConflict()
• %RollBack()
• %Save()
• %SaveData()
• %SaveDirect()
• %SaveIndices()
• %SerializeObject()
• %SetModified()
• %SortBegin()
• %SortEnd()
• %SyncObjectIn()
• %SyncTransport()
• %UnlockExtent()
• %UnlockId()
• %ValidateIndices()
• %ValidateObject()
• %ValidateTable()
• Help()
• XMLDTD()
• XMLExport()
• XMLExportToStream()
• XMLExportToString()
• XMLImportAttributes()
• XMLNew()
• XMLSchema()
• XMLSchemaNamespace()
• XMLSchemaType()

Copy link to this sectionStorage

Storage Model: Storage (Config.NLS.SubTables)

^|"^^"_$ZU(12)|SYS("NLS","SubTablesD")(ID,"FromTo",n)

=

FromTo(n)

Storage Model: Storage (Config.NLS.SubTables)

^|"^^"_$ZU(12)|SYS("NLS","SubTablesD")(ID)

=

%%CLASSNAME Description Type Subtype