AbstractGroup Class Reference

Inheritance diagram for AbstractGroup:

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

Private Member Functions
_.Library.Status	GenerateCode (_.Dictionary.CompiledClass pTargetClass, _.Stream.TmpCharacter pCode, _.XGEN.AbstractDocument pDocument)
	Loop over the members of this sequence and fire their. More...
_.Library.Status	OnAfterGenerateCode (_.Dictionary.CompiledClass pTargetClass, _.Stream.TmpCharacter pCode, _.XGEN.AbstractDocument pDocument)
	This method is called when a class containing an XGEN. More...
_.Library.Status	OnBeforeGenerateCode (_.Dictionary.CompiledClass pTargetClass, _.Stream.TmpCharacter pCode, _.XGEN.AbstractDocument pDocument)
	This method is called when a class containing an XGEN. More...
_.Library.Status	OnGenerateCode (_.Dictionary.CompiledClass pTargetClass, _.Stream.TmpCharacter pCode, _.XGEN.AbstractDocument pDocument)
	This callback does not apply to groups, so we stub it out here.

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 abstract class is the basis for all groups within XGEN (such as documents or sequences).
See <class>XGEN.AbstractDocument</class> for an overview of XGEN.
User classes should not extend this class, instead they should extend either <class>XGEN.AbstractDocument</class> or <class>XGEN.AbstractSequence</class>.

Member Function Documentation

GenerateCode()

_.Library.Status GenerateCode ( _.Dictionary.CompiledClass  pTargetClass, _.Stream.TmpCharacter  pCode, _.XGEN.AbstractDocument  pDocument  )

private

Loop over the members of this sequence and fire their.

<method>GenerateCode</method> methods.
Subclasses can customize the behavior using the <method>OnBeforeGenerateCode</method> and <method>OnAfterGenerateCode</method> callback methods.

OnAfterGenerateCode()

_.Library.Status OnAfterGenerateCode ( _.Dictionary.CompiledClass  pTargetClass, _.Stream.TmpCharacter  pCode, _.XGEN.AbstractDocument  pDocument  )

private

This method is called when a class containing an XGEN.

document is compiled. It is called after the <method>GenerateCode</method> method processes its children.
pTargetClass is the class that contains the XGEN document.
pCode is a stream containing the generated code.
pDocument is the top-level XGEN document object that contains this node.
A subclass can provide an implementation of this method that will generate specific lines of code.

OnBeforeGenerateCode()

_.Library.Status OnBeforeGenerateCode ( _.Dictionary.CompiledClass  pTargetClass, _.Stream.TmpCharacter  pCode, _.XGEN.AbstractDocument  pDocument  )

private

This method is called when a class containing an XGEN.

document is compiled. It is called before the <method>GenerateCode</method> method processes its children.
pTargetClass is the class that contains the XGEN document.
pCode is a stream containing the generated code.
pDocument is the top-level XGEN document object that contains this node.
A subclass can provide an implementation of this method that will generate specific lines of code.

Member Data Documentation

children

children

This is the set of child nodes that belong to this sequence.

 

skipChildren

skipChildren

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

be processed. This provides a way for a subclass to disable processing of a group.