alma.tools.idlgen.comphelpgen.ComponentHelperGeneratorProxy Class Reference

List of all members.

Public Member Functions
	ComponentHelperGeneratorProxy (String outputRootDir, boolean verbose)
void	setOriginalParseTree (IdlObject root, String rootPackage)
void	generateComponentHelperCode ()

---

Detailed Description

Gets the information together that the generator for component helper classes (alma.acs.tools.comphelpergen.CompHelperGenerator) needs, and runs it.

The communication is through XML to decouple this module from the comphelpgen module. The XML complies with the schema HelperInfo.xsd from the module comphelpgen which is listed here for convenience:

 <?xml version="1.0" encoding="ISO-8859-1"?>
 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
 	<xs:element name="ComponentHelperInfo">
 		<xs:complexType>
 			<xs:sequence>
 				<xs:element ref="ComponentInterface" minOccurs="0" maxOccurs="unbounded"/>
 			</xs:sequence>
 			<xs:attribute name="outputRootDirectory" type="xs:string" use="required"/>
 		</xs:complexType>
 	</xs:element>
 	<xs:element name="ComponentInterface">
 		<xs:complexType>
 			<xs:attribute name="idlPackage" type="xs:string" use="required"/>
 			<xs:attribute name="componentClassName" type="xs:string" use="required"/>
 			<xs:attribute name="internalInterface" type="xs:string" use="optional"/>			
 		</xs:complexType>
 	</xs:element>
 </xs:schema>
 

In the implementation, schema conformance is guaranteed by using identical binding classes on either side of the XML communication.

Author:

hsommer Jan 16, 2003 5:47:15 PM

---

Constructor & Destructor Documentation

alma.tools.idlgen.comphelpgen.ComponentHelperGeneratorProxy.ComponentHelperGeneratorProxy	(	String	outputRootDir,
		boolean	verbose
	)

Constructor for ComponentHelperGeneratorProxy.

Parameters:

	outputRootDir	the directory under which the component helper classes will be put.
	verbose	if true, some information will be dumped to System.out, including the XML.

References alma.acs.tools.comphelpergen.generated.ComponentHelperInfo.setOutputRootDirectory().

---

Member Function Documentation

void alma.tools.idlgen.comphelpgen.ComponentHelperGeneratorProxy.generateComponentHelperCode

(

)

Creates the configuration XML and sends it to an alma.acs.tools.comphelpergen.CompHelperGenerator for code generation.

References alma.acs.tools.comphelpergen.generated.ComponentHelperInfo.addComponentInterface(), alma.acs.tools.comphelpergen.CompHelperGenerator.generate(), alma.tools.idlgen.comphelpgen.JavaPackageScout.getPackage(), alma.acs.tools.comphelpergen.generated.ComponentHelperInfo.marshal(), alma.acs.tools.comphelpergen.generated.ComponentInterface.setComponentClassName(), alma.acs.tools.comphelpergen.generated.ComponentInterface.setCorbaRepositoryId(), alma.acs.tools.comphelpergen.generated.ComponentInterface.setIdlPackage(), and alma.acs.tools.comphelpergen.generated.ComponentInterface.setInternalInterface().

void alma.tools.idlgen.comphelpgen.ComponentHelperGeneratorProxy.setOriginalParseTree	(	IdlObject	root,
		String	rootPackage
	)

Sets the original parse tree. This method must be called before alma.tools.idlgen.IdlTreeManipulator does its work because we need the original interface names that could otherwise be altered.

Parameters:

root

the root node of the IDL parse tree

References alma.tools.idlgen.comphelpgen.JavaPackageScout.collectInterfacePackages().

---

The documentation for this class was generated from the following file:

• ComponentHelperGeneratorProxy.java