RubyClassifierCodeDocument Class Reference

#include <rubyclassifiercodedocument.h>

Inheritance diagram for RubyClassifierCodeDocument:

Public Member Functions
	RubyClassifierCodeDocument (UMLClassifier *classifier)
virtual	~RubyClassifierCodeDocument ()
bool	addCodeOperation (CodeOperation *op)
QString	getPath ()
QString	getRubyClassName (const QString &name)
RubyCodeGenerationPolicy *	getRubyPolicy ()
void	updateContent ()
Public Member Functions inherited from ClassifierCodeDocument
	ClassifierCodeDocument (UMLClassifier *parent)
virtual	~ClassifierCodeDocument ()
bool	addCodeClassField (CodeClassField *add_object)
void	addCodeClassFieldMethods (CodeClassFieldList &list)
CodeClassField *	findCodeClassFieldFromParentID (Uml::ID::Type id, int role_id=-1)
CodeClassFieldList *	getCodeClassFieldList ()
QList< CodeOperation * >	getCodeOperations ()
UMLClassifier *	getParentClassifier ()
CodeClassFieldList	getSpecificClassFields (CodeClassField::ClassFieldType cfType)
CodeClassFieldList	getSpecificClassFields (CodeClassField::ClassFieldType cfType, bool isStatic)
CodeClassFieldList	getSpecificClassFields (CodeClassField::ClassFieldType cfType, Uml::Visibility::Enum visibility)
CodeClassFieldList	getSpecificClassFields (CodeClassField::ClassFieldType cfType, bool isStatic, Uml::Visibility::Enum visibility)
bool	hasAssociationClassFields ()
bool	hasAttributeClassFields ()
bool	hasClassFields ()
bool	hasObjectVectorClassFields ()
virtual void	initCodeClassFields ()
virtual void	loadFromXMI (QDomElement &root)
bool	parentIsClass ()
bool	parentIsInterface ()
bool	removeCodeClassField (CodeClassField *remove_object)
virtual void	saveToXMI (QDomDocument &doc, QDomElement &root)
virtual void	synchronize ()
Public Member Functions inherited from CodeDocument
	CodeDocument ()
virtual	~CodeDocument ()
QString	cleanName (const QString &name)
TextBlock *	findTextBlockByTag (const QString &tag, bool descendIntoChildren=false)
QString	getFileExtension () const
QString	getFileName () const
CodeComment *	getHeader ()
QString	getPackage () const
virtual QString	getUniqueTag (const QString &prefix=QString(""))
bool	getWriteOutCode ()
QString	ID () const
bool	insertTextBlock (TextBlock *newBlock, TextBlock *existingBlock, bool after=true)
virtual CodeBlock *	newCodeBlock ()
virtual CodeBlockWithComments *	newCodeBlockWithComments ()
virtual HierarchicalCodeBlock *	newHierarchicalCodeBlock ()
void	setFileExtension (const QString &new_var)
void	setFileName (const QString &new_var)
void	setHeader (CodeComment *comment)
void	setID (const QString &new_id)
void	setPackage (UMLPackage *new_var)
void	setWriteOutCode (bool new_var)
virtual QString	toString ()
Public Member Functions inherited from CodeGenObjectWithTextBlocks
	CodeGenObjectWithTextBlocks (CodeDocument *parent)
virtual	~CodeGenObjectWithTextBlocks ()
CodeBlockWithComments *	addOrUpdateTaggedCodeBlockWithComments (const QString &tag, const QString &text, const QString &ctext, int indentLevel, bool forceUserBlockUpdate)
CodeComment *	addOrUpdateTaggedCodeComment (const QString &tag="", const QString &text="", int indentationLevel=0)
virtual bool	addTextBlock (TextBlock *add_object)
CodeGenObjectWithTextBlocks *	findParentObjectForTaggedTextBlock (const QString &tag)
TextBlock *	findTextBlockByTag (const QString &tag)
virtual CodeBlockWithComments *	getCodeBlockWithComments (const QString &tag, const QString &comment, int indentLevel)
virtual HierarchicalCodeBlock *	getHierarchicalCodeBlock (const QString &tag, const QString &comment, int indentLevel)
TextBlockList *	getTextBlockList () const
virtual bool	removeTextBlock (TextBlock *remove_object)

Protected Member Functions
void	addOrUpdateCodeClassFieldMethodsInCodeBlock (CodeClassFieldList &list, RubyClassDeclarationBlock *codeBlock)
bool	forceDoc ()
virtual void	loadChildTextBlocksFromNode (QDomElement &root)
void	resetTextBlocks ()
Protected Member Functions inherited from ClassifierCodeDocument
void	declareClassFields (CodeClassFieldList &list, CodeGenObjectWithTextBlocks *parent)
TextBlock *	findCodeClassFieldTextBlockByTag (const QString &tag)
void	loadClassFieldsFromXMI (QDomElement &childElem)
virtual void	setAttributesFromNode (QDomElement &element)
virtual void	setAttributesOnNode (QDomDocument &doc, QDomElement &blockElement)
void	syncClassFields ()
void	syncNamesToParent ()
Protected Member Functions inherited from CodeDocument
void	addChildTagToMap (const QString &tag, TextBlock *tb)
void	removeChildTagFromMap (const QString &tag)
void	updateHeader ()
Protected Member Functions inherited from CodeGenObjectWithTextBlocks
void	setAttributesFromObject (CodeGenObjectWithTextBlocks *obj)

Additional Inherited Members
Public Slots inherited from ClassifierCodeDocument
void	addAssociationClassField (UMLAssociation *assoc, bool syncToParentIfAdded=true)
void	addAttributeClassField (UMLClassifierListItem *at, bool syncToParentIfAdded=true)
void	addOperation (UMLClassifierListItem *obj)
void	removeAssociationClassField (UMLAssociation *assoc)
void	removeAttributeClassField (UMLClassifierListItem *at)
void	removeOperation (UMLClassifierListItem *obj)
void	syncToParent ()
Protected Attributes inherited from CodeGenObjectWithTextBlocks
QMap< QString, TextBlock * >	m_textBlockTagMap
TextBlockList	m_textblockVector

Detailed Description

class RubyClassifierCodeDocument A Ruby UMLClassifier Code Document.

We carve the Ruby document up into sections as follows:

• header
• class declaration
• guts of the class (e.g. accessor methods, operations, dependant classes)

Definition at line 36 of file rubyclassifiercodedocument.h.

Constructor & Destructor Documentation

RubyClassifierCodeDocument::RubyClassifierCodeDocument ( UMLClassifier *  classifier )

explicit

Constructor.

Definition at line 33 of file rubyclassifiercodedocument.cpp.

RubyClassifierCodeDocument::~RubyClassifierCodeDocument ( )

virtual

Empty Destructor.

Definition at line 42 of file rubyclassifiercodedocument.cpp.

Member Function Documentation

bool RubyClassifierCodeDocument::addCodeOperation ( CodeOperation *  op )

virtual

Add a code operation to this ruby classifier code document.

In the vanilla version, we just tack all operations on the end of the document.

Parameters

op	the code operation

Returns

bool which is true IF the code operation was added successfully

Implements ClassifierCodeDocument.

Definition at line 124 of file rubyclassifiercodedocument.cpp.

void RubyClassifierCodeDocument::addOrUpdateCodeClassFieldMethodsInCodeBlock ( CodeClassFieldList &  list, RubyClassDeclarationBlock *  codeBlock  )

protected

bool RubyClassifierCodeDocument::forceDoc ( )

protected

QString RubyClassifierCodeDocument::getPath ( )

virtual

Overwritten by Ruby language implementation to get lowercase path.

Reimplemented from CodeDocument.

Definition at line 69 of file rubyclassifiercodedocument.cpp.

QString RubyClassifierCodeDocument::getRubyClassName

(

const QString &

name

)

Definition at line 87 of file rubyclassifiercodedocument.cpp.

RubyCodeGenerationPolicy * RubyClassifierCodeDocument::getRubyPolicy

(

)

Make it easier on ourselves.

Definition at line 49 of file rubyclassifiercodedocument.cpp.

void RubyClassifierCodeDocument::loadChildTextBlocksFromNode ( QDomElement &  root )

protectedvirtual

Need to overwrite this for ruby since we need to pick up the ruby class declaration block.

Sigh. NOT optimal. The only reason that we need to have this is so we can create the RubyClassDeclarationBlock. would be better if we could create a handler interface that each codeblock used so all we have to do here is add the handler for "rubyclassdeclarationblock".

Reimplemented from CodeGenObjectWithTextBlocks.

Definition at line 166 of file rubyclassifiercodedocument.cpp.

void RubyClassifierCodeDocument::resetTextBlocks ( )

protectedvirtual

Reset/clear our inventory of textblocks in this document.

Reimplemented from CodeDocument.

Definition at line 317 of file rubyclassifiercodedocument.cpp.

void RubyClassifierCodeDocument::updateContent ( )

virtual

Update the content of this code document.

This is where you should lay out your code document structure of textblocks in the inheriting class, should it have any text in it. Vanilla code documents don't have much to do.. override this with a different version for your own documents.

Implements ClassifierCodeDocument.

Definition at line 335 of file rubyclassifiercodedocument.cpp.

---

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

• rubyclassifiercodedocument.h
• rubyclassifiercodedocument.cpp