IRISLIB database
SchemaResult Class Reference

This class manages and contains the list of class defintions that are created from an XML Schema. More...

Inheritance diagram for SchemaResult:
Collaboration diagram for SchemaResult:

Public Member Functions

_.Library.Status AddToXSchema (_.Library.String classname)
 Create the XSchema data Structure for one class.
 
_.Library.Status CompileClasses (_.Library.Boolean verbose, _.Library.String CompileFlags)
 Compile all the class definitions in this result.
 
_.Library.Status CreateClassDef (_.Library.String pClassName, _.Library.Boolean test, _.Dictionary.ClassDefinition pCDef)
 Create a class definition for an entry in the class tree.
 
 DisplayClasses ()
 List all the classes in this Result.
 
_.Library.Status DisplayClassesHTML ()
 Provide an HTML list of classes (for Wizard)
 
_.Library.Status ElementsToXSchema ()
 Add top level elements to the XSchema data structure.
 
 OutputXSchema (_.Library.Integer nsno)
 Output the XSchema data structure to a file.
 
_.Library.Status SaveClasses (_.Library.Boolean verbose, _.Library.Boolean test)
 Save all the class definitions in this result to the database.
 
_.XML.Utils.SchemaResult SetupResult (_.XML.Utils.SchemaReader pReader, _.Library.String pPackage, _.Library.String pFeatures)
 Setup a new Schema Result given a SchemaReader.
 
_.Library.Status XSchemaToFile (_.Library.String filepath)
 Output an XSchema format file based on the parsed XML schema.
 
- 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...
 

Static Public Member Functions

_.XML.Utils.SchemaResult CreateResult (_.XML.Utils.SchemaReader pReader, _.Library.String pPackage, _.Library.String pFeatures)
 Create a Schema Result given a SchemaReader.
 
_.Library.Status DisplayClass (_.Dictionary.ClassDefinition cdef)
 Write out a formatted version of a class definition.
 
_.Library.Boolean IsSQLWord (_.Library.String name)
 Test if name is an SQL reserved word.
 
_.Library.Boolean IsValidClassName (_, _.Library.Binary val)
 !!!Test if name is a valid class name
 

Public Attributes

 Classes
 A multi-dimensional array of class names
More...
 
 Features
 Array of feature codes for generated classes: More...
 
 PrefixIndex
 Index for creating namespace prefixes. More...
 
 Reader
 SchemaReader that created this result. More...
 
 Tree
 Integer tree id within ^IRIS.Temp. More...
 

Static Public Attributes

 DOMAIN = None
 Messages for localization of XML Schema Wizard result. More...
 
- 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 manages and contains the list of class defintions that are created from an XML Schema.

This class is intended for internal use by the XML Schema Wizard.

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Member Data Documentation

◆ DOMAIN

DOMAIN = None
static

Messages for localization of XML Schema Wizard result.


◆ Classes

Classes

A multi-dimensional array of class names

Classes(name) = key (in original ClassTree)  

◆ Features

Features

Array of feature codes for generated classes:

The possible nodes are as follows:
Features("DEFAULTSEQUENCE") If this node exists, the wizard does not set the XMLSEQUENCE parameter in the generated classes.
Features("JAVA") If this node exists, each class includes a Java projection.
Features("NOSEQUENCE") If this node exists, the wizard sets the XMLSEQUENCE parameter to 0 in the generated classes.
Features("POPULATE") If this node exists, each class extends Populate in addition to XML.Adaptor.
Features("SQLCOLUMNS") If this node exists, each class property specifies a value for the SqlColumnNumber keyword, so that the properties have the same order in SQL that they have in the schema.
Features("IGNORENULL") If this node is set, the XMLIGNORENULL parameter is set to this value for each class. Features("BINARYASSTREAM") If this node exists, then use Stream.GlobalBinary for base64Binary type Features("XMLFORMAT") If this node is set, the XMLFORMAT parameter is set to this value for each class.  

◆ PrefixIndex

PrefixIndex

Index for creating namespace prefixes.

 

◆ Reader

SchemaReader that created this result.

 

◆ Tree

Tree

Integer tree id within ^IRIS.Temp.