alma.tools.idlgen

Class JacorbVisitor

java.lang.Object

JavaMappingGeneratingVisitor

alma.tools.idlgen.JacorbVisitor

public class JacorbVisitor
extends JavaMappingGeneratingVisitor

This class gets instantiated by XmlIdlCompiler and gets called by org.jacorb.idl.parser#compile(String[], StringWriter). It walks the tree of IDL parser nodes and collects information about ACS interfaces and typedefs, structs and those interfaces that are affected by XML.

It does not rename any tree nodes nor does it generate code.

Author:

jschwarz, hsommer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACSCOMPONENT_IDLTYPE
static java.lang.String	ACSOFFSHOOT_IDLTYPE
static java.lang.String	XML_ENTITY_STRUCT_NAME

Constructor Summary

Constructors

Constructor and Description
JacorbVisitor()

Method Summary

Modifier and Type	Method and Description
static Interface	resolveForwardDecl(Interface interfce) If the given interface is instantiated from a forward declaration then this method returns the corresponding Interface object that contains the actual definition.
void	visitAlias(AliasTypeSpec alias) We override this to detect all XmlEntityStruct typedefs, even if they do not get used as parameters or struct members inside our own IDL file, be it directly or through other typedefs.
void	visitDeclaration(Declaration declaration) Overridden to avoid the annoying log that the base impl produces.
void	visitEnum(EnumType enumType) We override this method only to fix a bug with an endless loop in the base class.
void	visitInterface(Interface interfce)
void	visitInterfaceBody(InterfaceBody body) We override this method in order to descend not only to operations but also to inner structs and typedefs.
void	visitModule(Module module)
void	visitOpDecl(OpDecl op)
void	visitParamDecl(ParamDecl param) We override this method to check if a parameter is of an XML-related type and to mark the respective interface.
void	visitSpec(Spec spec) The top-level call, from which we start walking the IDL parse tree using mostly the base class implementation of the tree descend.
void	visitStruct(StructType struct)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XML_ENTITY_STRUCT_NAME

public static final java.lang.String XML_ENTITY_STRUCT_NAME

See Also:

Constant Field Values

ACSCOMPONENT_IDLTYPE

public static final java.lang.String ACSCOMPONENT_IDLTYPE

See Also:

Constant Field Values

ACSOFFSHOOT_IDLTYPE

public static final java.lang.String ACSOFFSHOOT_IDLTYPE

See Also:

Constant Field Values

Constructor Detail

JacorbVisitor

public JacorbVisitor()

Method Detail

visitSpec

public void visitSpec(Spec spec)

The top-level call, from which we start walking the IDL parse tree using mostly the base class implementation of the tree descend.

visitModule

public void visitModule(Module module)

visitAlias

public void visitAlias(AliasTypeSpec alias)

We override this to detect all XmlEntityStruct typedefs, even if they do not get used as parameters or struct members inside our own IDL file, be it directly or through other typedefs. The reason is that these typedefs may get included in other IDL files, where the respective Holder class is then expected to be found in the jar generated from this IDL. (Note that in contrast to the normal Idl2Java mapping, we always must generate a Holder class for an Xml typedef, e.g. SchedBlockHolder with the castor class field "mycastorpackage.SchedBlock value".)

This method corresponds to alma.tools.idlgen.IdlTreeManipulator#findXmlTypedefNodes(IdlObject, Set) in the OpenORB based implementation.

visitStruct

public void visitStruct(StructType struct)

visitInterface

public void visitInterface(Interface interfce)

visitInterfaceBody

public void visitInterfaceBody(InterfaceBody body)

We override this method in order to descend not only to operations but also to inner structs and typedefs.

See Also:

org.jacorb.idl.InterfaceBody#print(PrintWriter)

visitOpDecl

public void visitOpDecl(OpDecl op)

visitParamDecl

public void visitParamDecl(ParamDecl param)

We override this method to check if a parameter is of an XML-related type and to mark the respective interface.

The check is simple enough so that we could inline it in visitOpDecl(OpDecl), but by using visitParamDecl we cleanly follow jacorb's visitor pattern.

resolveForwardDecl

public static Interface resolveForwardDecl(Interface interfce)

If the given interface is instantiated from a forward declaration then this method returns the corresponding Interface object that contains the actual definition. Otherwise the same object is returned.

visitDeclaration

public void visitDeclaration(Declaration declaration)

Overridden to avoid the annoying log that the base impl produces.

visitEnum

public void visitEnum(EnumType enumType)

We override this method only to fix a bug with an endless loop in the base class.

Note that the normal jacorb run does not call EnumType#accept which calls the broken "visitEnum", but instead it calls EnumType#print, so that the bug in JavaMappingGeneratingVisitor goes unnoticed.