Inheritance diagram for AbstractDocument:

[legend]

Collaboration diagram for AbstractDocument:

[legend]

Static Private Member Functions
_.Library.Status	Generate (_.Dictionary.CompiledClass pTargetClass, _.Stream.TmpCharacter pCode, _.Library.String pXDataName)
	This method is called from a method generator within a target class. More...

_.Library.Status	GenerateDefaultCode (_.Dictionary.CompiledClass pTargetClass, _.Stream.TmpCharacter pCode, _.Library.String pXDataName)
	This method is invoked when there is no XDATA block defined in the target. More...

Additional Inherited Members
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 Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Static Public Member Functions inherited from SASchemaClass
_.Library.Status	GetAttrsForClass (_.Library.String pClass, pAttrList)
	Given a class (and default namespace) find the list of XML attributes. More...

_.Library.Status	GetElementsForClass (_.Library.String pClass, pElementList, pReferencedClasses)
	Given a class (and default namespace) find the list of XML elements. More...

_.Library.Status	GetXMLElementsForClass (_.Library.String pClass, pElements)
	Return an array of XML element names that could be used within a. More...

_.Library.String	GetXMLNameForClass (_.Library.String pClass)
	Return the XML name for the given class (or "" if there is none). More...

_.Library.Boolean	IsUpToDate (_.Library.String pChecksum, _.Library.String pParameter)
	Subclass should override this method. More...

_.Library.Status	OutputToStream (_.Stream.Object pStream, _.Library.String pChecksum, _.Library.String pParameter)
	Output SASchema definition into a stream.

_.Library.String	SchemaToPrefix (_.Library.String pSchema)
	Convert a schema name to a reasonable "prefix".

_.Library.String	XMLName2DisplayName (_.Library.String pName, _.Library.String pCurrentNS)
	Take an element and make sure it has the correct namespace prefix. More...

Static Public Member Functions inherited from SASchema
_.Library.Status	OutputToFile (pFilename)
	Output the SASchema definition to a file. More...

Public Attributes inherited from AbstractElement
	name
	This is the logical name of this node. More...

Public Attributes inherited from AbstractGroup
	children
	This is the set of child nodes that belong to this sequence. More...

	skipChildren
	If this transient property is true, then the children of the group will not. More...

Static Public Attributes inherited from AbstractElement
	XGENDOCUMENT = None
	This is the name of the XGEN document class that this node belongs to. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	By setting this to 0, we disallow use of invalid attribute names.

	XMLIGNORENULL = None
	By setting this 1, we ignore the difference between null and empty nodes within XGEN.

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...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Static Public Attributes inherited from SASchemaClass
	ROOTCLASSES = None
	This class is the base class for Studio Assist schema generators that are based on XML-enabled class definitions. More...

	SACATEGORY = None
	Optional. More...

	XMLNAMESPACE = None
	This is the namespace value used to identify this SA schema. More...

Detailed Description

Note: This class is included because it is needed by other parts of the library. You should not use this or any other class within this package within your applications as a future version will be incompatible. If you are interested in this functionality please contact InterSystems.

This is the base class for XGEN documents.

XGEN: XML-based Code Generation Language

XGEN is a framework for creating specialized code generators that are driven by an XML-based specification.

Overview:
XGEN contains a set of base classes from which a user can implement an XML-based code generator.

An XGEN document is an XML document that can be compiled into executable code. Every activity within an XGEN document is implemented as a class.
Within an XGEN document, each XGEN class provides the following:

The XML representation of the activity (i.e., its name and attributes).
Generation of code for the activity.
Generation of Studio Assist schema information.

Member Function Documentation

◆ Generate()

_.Library.Status Generate	(	_.Dictionary.CompiledClass	pTargetClass,
		_.Stream.TmpCharacter	pCode,
		_.Library.String	pXDataName
	)

staticprivate

This method is called from a method generator within a target class.

It generates code for the method.
pTargetClass is the compiled class definition for the target class.
pCode is a character stream that contains the generated code.
pXDataName is the name of the XData block containing the XGEN document definition.

◆ GenerateDefaultCode()

_.Library.Status GenerateDefaultCode	(	_.Dictionary.CompiledClass	pTargetClass,
		_.Stream.TmpCharacter	pCode,
		_.Library.String	pXDataName
	)

staticprivate

This method is invoked when there is no XDATA block defined in the target.

class.

Static Private Member Functions

Additional Inherited Members

Detailed Description

XGEN: XML-based Code Generation Language

Member Function Documentation

◆ Generate()

◆ GenerateDefaultCode()