org.biomage.tools.generate_classes
Class CreatePackageFile

java.lang.Object
  extended by org.biomage.tools.generate_classes.CreateFile
      extended by org.biomage.tools.generate_classes.CreatePackageFile

public class CreatePackageFile
extends CreateFile

Description: Class that is resposible for generating a java file for the class represented by the class node passed into the constructor.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.biomage.tools.generate_classes.CreateFile
CreateFile.AssociationAttrInformation, CreateFile.AttrInformation, CreateFile.IdentifierAttrInformation, CreateFile.RoleInformation
 
Field Summary
 
Fields inherited from class org.biomage.tools.generate_classes.CreateFile
associationInfo, baseClassCreateFile, baseClassID, baseClassName, classDoc, className, concreteSubClassNames, dataAttrInfo, importDate, importSerializable, importVector, interfaceInfo, isAbstract, isBaseClass, isIdentifiable, isIndependent, isInterface, isReferenced, JAVA_INTERFACE, methodInfo, NEWLINE, packageDoc, packageImports, packageName, roleNames, subClassNames, typeOwned, UML_CLASS, UML_MODEL, UML_PACKAGE, visibility
 
Constructor Summary
protected CreatePackageFile(org.w3c.dom.Element packageNode, org.w3c.dom.Element packageOrder, java.util.Map id2classFiles, java.util.Map id2extInfo)
          Description: Constructor for the package file generator.
 
Method Summary
protected  java.util.Vector associationAttrInformation(org.w3c.dom.Element packageNode, org.w3c.dom.Element packageOrder, java.util.Map id2classFiles)
          Description: Puts together the information on the class associations.
protected  java.lang.String getClassName()
          Description: Returns the class name of the class.
 int getFileType()
          Description: Returns what kind of model element this class is based on.
protected  void headerInformation(org.w3c.dom.Element packageNode, java.util.Map id2extInfo)
          Description: Obtains the information to generate the information for the package and the declaration of the class.
 
Methods inherited from class org.biomage.tools.generate_classes.CreateFile
addAssociation, addAssociation, addAssociation, addRoleName, getAssociationInfo, getAttrInfo, getBaseClassCreateFile, getBaseClassFileName, getBaseClassID, getClassDoc, getClassFileName, getConcreteSubClassNames, getDocumentation, getImports, getInterfaceInfo, getMethodInfo, getPackageID, getPackageName, getRoleNames, getVisibility, importDate, importSerializable, importVector, isAbstract, isBaseClass, isIdentifiableClass, isIndependentClass, isReferenced, isReferenced, registerSubClassName, registerWithBaseClass, setBaseClassCreateFile, setIsIndependentClass, setVisibility, typeOwned, typeOwned
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CreatePackageFile

protected CreatePackageFile(org.w3c.dom.Element packageNode,
                            org.w3c.dom.Element packageOrder,
                            java.util.Map id2classFiles,
                            java.util.Map id2extInfo)
                     throws java.lang.Exception
Description: Constructor for the package file generator.

Parameters:
packageNode: - information for the package file to create.
packageOrder: - information for how the associations should be ordered.
id2classFiles: - look up to the class files to find which ones should generate associations in the package file.
id2extInfo: - map where documentation for the class can be found

Throws:
java.lang.Exception
Method Detail

getClassName

protected java.lang.String getClassName()
                                 throws java.lang.Exception
Description: Returns the class name of the class.

Returns:
the class name

Throws:
java.lang.Exception

headerInformation

protected void headerInformation(org.w3c.dom.Element packageNode,
                                 java.util.Map id2extInfo)
                          throws java.lang.Exception
Description: Obtains the information to generate the information for the package and the declaration of the class.

Parameters:
packageNode: - node representing the package.
id2extInfo: - map where documentation for the class can be found

Throws:
java.lang.Exception

associationAttrInformation

protected java.util.Vector associationAttrInformation(org.w3c.dom.Element packageNode,
                                                      org.w3c.dom.Element packageOrder,
                                                      java.util.Map id2classFiles)
                                               throws java.lang.Exception
Description: Puts together the information on the class associations.

Parameters:
packageNode: - package node and the contained class nodes.
id2classFiles: - map to the class files for list information.

Returns:
Vector of ClassAttrInformations

Throws:
java.lang.Exception

getFileType

public int getFileType()
Description: Returns what kind of model element this class is based on.

Specified by:
getFileType in class CreateFile
Returns:
returns that this represents the model itself