Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

alma::acs::tools::comphelpergen::CompHelperClass Class Reference

Collaboration diagram for alma::acs::tools::comphelpergen::CompHelperClass:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 CompHelperClass ()
 CompHelperClass (boolean verbose)
void initCompHelper (String repositoryId, String componentClassName, String internalInterface, String idlPackage, String outputRootDir)

Protected Member Functions

String computeFullOutputPath ()
String computeFullXmlOutputPath ()
void saveFile ()

Package Attributes

IOSpecification ioSpecification

Private Member Functions

String getImplPackage ()
String getJavaComponentClass ()
String getClassName ()
String getClassJavadoc ()
String getImports ()
String ctor ()
String createComponentImpl ()
String getPOATieClass ()
String getOperationsIrf ()
String getInternalIrf ()
String getLicenceHeader ()
String getContents ()

Private Attributes

char sep = File.separatorChar
String m_outputRootDir
String m_idlPackage
String m_componentClassName
String m_internalInterface
String m_implPackage
String m_operationsClass
String m_repositoryId
boolean m_verbose = false

Static Private Attributes

final String m_helperSuffix = "Helper"

Detailed Description

Author:
rgeorgie This class generates helper classes that are specified by the parameters componentClassName, internalInterface, idlPackage, outputRootDir.


Constructor & Destructor Documentation

alma::acs::tools::comphelpergen::CompHelperClass::CompHelperClass  )  [inline]
 

Constructs an object with a reference to the IO Specifications variables current directory.

See also:
java.lang.Object#Object()

alma::acs::tools::comphelpergen::CompHelperClass::CompHelperClass boolean  verbose  )  [inline]
 

Constructs an object with a reference to the IO Specifications variables current directory.

Parameters:
verbose 


Member Function Documentation

String alma::acs::tools::comphelpergen::CompHelperClass::computeFullOutputPath  )  [inline, protected]
 

Gets the full output path without having the name of the output file.

Returns:
String

String alma::acs::tools::comphelpergen::CompHelperClass::computeFullXmlOutputPath  )  [inline, protected]
 

Method computeFullXmlOutputPath.

Returns:
String

String alma::acs::tools::comphelpergen::CompHelperClass::createComponentImpl  )  [inline, private]
 

Outputs the code for the method _createComponentImpl().

Returns:
String

String alma::acs::tools::comphelpergen::CompHelperClass::ctor  )  [inline, private]
 

Outputs the code for the constructor method.

Returns:
String

String alma::acs::tools::comphelpergen::CompHelperClass::getClassJavadoc  )  [inline, private]
 

Outputs the code with the author's name.

Returns:
String

String alma::acs::tools::comphelpergen::CompHelperClass::getClassName  )  [inline, private]
 

Outputs the the class name.

Returns:
String

String alma::acs::tools::comphelpergen::CompHelperClass::getContents  )  [inline, private]
 

Collects all the blocks needed for outputing the current file's contents.

Returns:
String

String alma::acs::tools::comphelpergen::CompHelperClass::getImplPackage  )  [inline, private]
 

Gets a line of code with the package description.

Returns:
String

String alma::acs::tools::comphelpergen::CompHelperClass::getImports  )  [inline, private]
 

Outputs the code for all the imports.

Returns:
String

String alma::acs::tools::comphelpergen::CompHelperClass::getInternalIrf  )  [inline, private]
 

Outputs the code for the method _getInternalInterface().

Returns:
String

String alma::acs::tools::comphelpergen::CompHelperClass::getJavaComponentClass  )  [inline, private]
 

Gets the full name of the file.

Returns:
String

String alma::acs::tools::comphelpergen::CompHelperClass::getLicenceHeader  )  [inline, private]
 

Outputs the code for the LGPL.

Returns:
String

String alma::acs::tools::comphelpergen::CompHelperClass::getOperationsIrf  )  [inline, private]
 

Outputs the code for the method _getOperationsInterface()

Returns:
String

String alma::acs::tools::comphelpergen::CompHelperClass::getPOATieClass  )  [inline, private]
 

Outputs the code for the method _getPOATieClass().

Returns:
String

void alma::acs::tools::comphelpergen::CompHelperClass::initCompHelper String  repositoryId,
String  componentClassName,
String  internalInterface,
String  idlPackage,
String  outputRootDir
[inline]
 

Returns an instance of the class.

Parameters:
componentClassName 
internalInterface 
idlPackage 
outputRootDir 

void alma::acs::tools::comphelpergen::CompHelperClass::saveFile  )  [inline, protected]
 

Saves a file according to its contents and location.


Member Data Documentation

IOSpecification alma::acs::tools::comphelpergen::CompHelperClass::ioSpecification [package]
 

String alma::acs::tools::comphelpergen::CompHelperClass::m_componentClassName [private]
 

final String alma::acs::tools::comphelpergen::CompHelperClass::m_helperSuffix = "Helper" [static, private]
 

String alma::acs::tools::comphelpergen::CompHelperClass::m_idlPackage [private]
 

String alma::acs::tools::comphelpergen::CompHelperClass::m_implPackage [private]
 

String alma::acs::tools::comphelpergen::CompHelperClass::m_internalInterface [private]
 

String alma::acs::tools::comphelpergen::CompHelperClass::m_operationsClass [private]
 

String alma::acs::tools::comphelpergen::CompHelperClass::m_outputRootDir [private]
 

String alma::acs::tools::comphelpergen::CompHelperClass::m_repositoryId [private]
 

boolean alma::acs::tools::comphelpergen::CompHelperClass::m_verbose = false [private]
 

char alma::acs::tools::comphelpergen::CompHelperClass::sep = File.separatorChar [private]
 


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 02:54:34 2009 for ACS Java API by doxygen 1.3.8