Class: PHP_UML_Output_Xmi_Exporter

Source Location: /PHP_UML-1.6.1/UML/Output/Xmi/Exporter.php

Class Overview

PHP_UML_Output_Exporter
   |
   --PHP_UML_Output_ExporterAPI
      |
      --PHP_UML_Output_Xmi_Exporter

This class generates the XMI from a UML model (PHP_UML_Metamodel)

Author(s):

Baptiste Autin <ohlesbeauxjours at yahoo.fr>

Child classes:

PHP_UML_Output_Eclipse_Exporter: This class generates a specific XMI file that can be imported into Eclipse

Inherited Variables

Class: PHP_UML_Output_ExporterAPI

PHP_UML_Output_ExporterAPI::$ctx

Class: PHP_UML_Output_Exporter

PHP_UML_Output_Exporter::$structure

Inherited Methods

Class: PHP_UML_Output_ExporterAPI

PHP_UML_Output_ExporterAPI::export()
PHP_UML_Output_ExporterAPI::getContextPackage(): Return the ApiContextPackage currently associated to the rendering
PHP_UML_Output_ExporterAPI::initContextPackage()
PHP_UML_Output_ExporterAPI::setAllImplemented(): Sets the allImplemented/-ing arrays with all the interfaces that a given class implements (including those of the inherited classes)
PHP_UML_Output_ExporterAPI::setAllInherited(): Sets the allInherited/-ing arrays with all the classifiers that a given classifier inherits from
PHP_UML_Output_ExporterAPI::setAllSuperClassifiers(): Recurses into all the packages to build a list of all the generalizations and realizations between elements.

Class: PHP_UML_Output_Exporter

PHP_UML_Output_Exporter::__construct(): Constructor
PHP_UML_Output_Exporter::export(): Export the current model to a particular output format.
PHP_UML_Output_Exporter::getInstance(): Factory method to retrieve an implementation of an exporter, given the "common name" of a format.
PHP_UML_Output_Exporter::setModel(): Setter for the model.

Class Details

[line 26]
This class generates the XMI from a UML model (PHP_UML_Metamodel)

Author: Baptiste Autin <ohlesbeauxjours@yahoo.fr>
License: LGPL License 3

[ Top ]

Class Variables

$componentView = false

[line 71]

A component view is not included in the model by default.

Access: protected

Type:

boolean

[ Top ]

$deploymentView = false

[line 64]

A deployment view is not included in the model by default.

Access: protected

Type:

boolean

[ Top ]

$encoding = 'iso-8859-1'

[line 50]

Default XML encoding of the XMI document.

Access: protected

Type:

string

[ Top ]

$logicalView = true

[line 57]

A logical view is included in the model by default.

Access: protected

Type:

boolean

[ Top ]

$stereotypes = false

[line 78]

Stereotypes are not included in the model by default.

Access: protected

Type:

boolean

[ Top ]

$xmiDocument =

[line 35]

Reference to an XmiDocument object. Such an object is needed by the export() method of Xmi_Exporter and its subclasses (unlike the ExporterAPI implementations, which work on the metamodel directly, and don't need to know anything about XMI).

Access: protected

Type:

PHP_UML_Output_XmiDocument

[ Top ]

$xmiVersion = 2

[line 43]

Default XMI version used for serialization. Note that all XSL-based exporters will generate XMI with the default xmiVersion and encoding.

Access: protected

Type:

float

[ Top ]

Method Detail

export [line 163]

void export(

$outDir)

Access: public

Overrides PHP_UML_Output_ExporterAPI::export() (parent method not documented)

Parameters:

$outDir —

[ Top ]

generateXmi [line 209]

void generateXmi(
)

Serialize the metamodel (contained in the property $structure) into XMI code

It is not necessary to call this method before calling export();

Access: public

[ Top ]

getXmiBuilder [line 221]

PHP_UML_Output_Xmi_Builder getXmiBuilder(
)

Getter for the XMI factory

Return: An XMI builder object
Access: protected

Overridden in child classes as:

PHP_UML_Output_Eclipse_Exporter::getXmiBuilder(): Getter for the XMI factory. Overrides the parent.

[ Top ]

getXmiDocument [line 158]

PHP_UML_Output_XmiDocument getXmiDocument(
)

Getter for the XmiDocument

Access: public

[ Top ]

loadXmi [line 239]

void loadXmi(
string
$filepath)

Read the content of an existing XMI file.

If the file is UML/XMI 1, a conversion to version 2 is automatically applied.

Access: public

Parameters:

string $filepath — Filename

[ Top ]

save [line 191]

void save(
string
$outputFile)

Internal method to save the generated XMI to a file.

Use export() instead if you need to save from outside the Exporter object.

Access: protected

Parameters:

string $outputFile — Filename

[ Top ]

setComponentView [line 126]

void setComponentView(
boolean
$value)

Enables the inclusion of a component view in the serialized model

Access: public

Parameters:

boolean $value — True/False

[ Top ]

setDeploymentView [line 116]

void setDeploymentView(
boolean
$value)

Enables the inclusion of a deployment view in the serialized model

Access: public

Parameters:

boolean $value — True/False

[ Top ]

setEncoding [line 86]

void setEncoding(
string
$encoding)

Setter for the XML encoding

Access: public

Parameters:

string $encoding — Encoding

[ Top ]

setLogicalView [line 106]

void setLogicalView(
boolean
$value)

Enables the inclusion of a logical view in the serialized model

Access: public

Parameters:

boolean $value — True/False

[ Top ]

setStereotypes [line 138]

void setStereotypes(
boolean
$value)

Enables the inclusion of the stereotypes in the serialized model If true, all the stereotypes related to the UML model (currently, these data correspond to the PHP docblocks) will be added to the XMI model.

Access: public

Parameters:

boolean $value — True/False

[ Top ]

setXmiDocument [line 148]

void setXmiDocument(
PHP_UML_Output_XmiDocument
$xmiDocument)

Setter for the XmiDocument

Access: public

Parameters:

PHP_UML_Output_XmiDocument $xmiDocument — XMI Document

[ Top ]

setXmiVersion [line 96]

void setXmiVersion(
float
$version)

Setter for the XMI version

Access: public

Parameters:

float $version — XMI version

[ Top ]