com.nomagic.magicdraw.magicreport.tools

Class ExportTool2

java.lang.Object

java.util.Observable

com.nomagic.magicreport.engine.Tool

com.nomagic.magicreport.engine.ConcurrentTool

com.nomagic.magicdraw.magicreport.tools.ExportTool2

All Implemented Interfaces:

com.nomagic.magicreport.engine.ITool, com.nomagic.magicreport.IVariable, java.io.Serializable, java.lang.Cloneable

@OpenApiAll
public class ExportTool2
extends com.nomagic.magicreport.engine.ConcurrentTool

This class allow report to export element in other file format including tree folder.

Since:

Mar 14, 2012

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.nomagic.magicreport.engine.ConcurrentTool

com.nomagic.magicreport.engine.ConcurrentTool.ConsumeObject

Nested classes/interfaces inherited from interface com.nomagic.magicreport.engine.ITool

com.nomagic.magicreport.engine.ITool.HTMLString, com.nomagic.magicreport.engine.ITool.RetainedString, com.nomagic.magicreport.engine.ITool.Void

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTEXT_NAME Contains a context name.
(package private) java.util.Collection<Element>	elementScope
static java.lang.String	FILE_PROTOCOL
(package private) java.util.Collection<Package>	packageScope

Fields inherited from class com.nomagic.magicreport.engine.Tool

context, properties

Fields inherited from interface com.nomagic.magicreport.engine.ITool

VOID

Constructor Summary

Constructors

Constructor and Description
ExportTool2() Create an export tool.
ExportTool2(java.util.Observer observer) Create an export tool with observer.

Method Summary

Modifier and Type	Method and Description
void	consume(com.nomagic.magicreport.engine.ConcurrentTool.ConsumeObject consumeObject) Consume a object.
protected org.w3c.dom.Element	createAndExportElement(org.w3c.dom.Document document, Element exportingElement, boolean exportResources, boolean exportLinkedFile, com.nomagic.magicdraw.ui.ElementFilter filter) Create XML element represents the exportingElement and export the element into file.
protected org.w3c.dom.Element	createAndExportElement(org.w3c.dom.Document document, Element exportingElement, boolean exportResources, boolean exportLinkedFile, com.nomagic.magicdraw.ui.ElementFilter filter, boolean isSmart) Create XML element represents the exportingElement and export the element into file.
protected org.w3c.dom.Element	createAndExportSmartElement(org.w3c.dom.Document document, Element exportingElement, boolean exportResources, boolean exportLinkedFile, com.nomagic.magicdraw.ui.ElementFilter filter) Create XML element represents the exportingElement and export the element into file.
protected java.io.File	createResourcesDir(java.lang.String resourcesLocation) Create a resource directory.
void	destroy() Called by the engine to inform this tool is no longer use and that it should destroy any resources that it has allocated.
java.lang.String	exportAll(boolean exportResources, boolean exportLinkedFile) Export current opened project into file.
protected java.lang.String	exportCustomImageHolder(BaseElement exportingElement) Export the image for the element.
com.nomagic.magicreport.engine.ITool.Void	exportElement(java.io.File exportingFile, Element exportingElement, boolean exportResources) Export element to XML file.
com.nomagic.magicreport.engine.ITool.Void	exportElement(java.io.File exportingFile, Element exportingElement, boolean exportResources, boolean exportLinkedFile) Export element to XML file.
com.nomagic.magicreport.engine.ITool.Void	exportElement(java.io.File exportingFile, Element exportingElement, boolean exportResources, boolean exportLinkedFile, com.nomagic.magicdraw.ui.ElementFilter filter)
com.nomagic.magicreport.engine.ITool.Void	exportElementForTree(java.io.File exportingNodeFile, Element exportingElement, boolean exportResources, com.nomagic.magicdraw.ui.ElementFilter filter) Export element to XML file which is used for create tree.
protected java.lang.String	exportIcon(BaseElement exportingElement) Export the icon for element.
protected java.lang.String	getElementType(Element element) Return String representing element type.
static java.lang.String	getHumanName(java.lang.String propertyName, java.util.Map<java.lang.String,java.lang.String> nameMap) Get human name of given property name.
protected java.lang.String	getResourcesLocation() Return location of resources directory.
void	setRecursive(boolean isRecursive)

Methods inherited from class com.nomagic.magicreport.engine.ConcurrentTool

isRunning, offer

Methods inherited from class com.nomagic.magicreport.engine.Tool

clone, getContext, getProperties, getProperty, getProperty, notifyObservers, setContext, setProperties

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTEXT_NAME

public static final java.lang.String CONTEXT_NAME

Contains a context name.

See Also:

Constant Field Values

FILE_PROTOCOL

public static final java.lang.String FILE_PROTOCOL

See Also:

Constant Field Values

packageScope

java.util.Collection<Package> packageScope

elementScope

java.util.Collection<Element> elementScope

Constructor Detail

ExportTool2

public ExportTool2()

Create an export tool.

ExportTool2

public ExportTool2(java.util.Observer observer)

Create an export tool with observer.

Parameters:

observer - Observer

Method Detail

setRecursive

public void setRecursive(boolean isRecursive)

consume

public void consume(com.nomagic.magicreport.engine.ConcurrentTool.ConsumeObject consumeObject)

Consume a object.

Specified by:

consume in class com.nomagic.magicreport.engine.ConcurrentTool

Parameters:

consumeObject - consume object.

See Also:

ConcurrentTool.consume(com.nomagic.magicreport.engine.ConcurrentTool.ConsumeObject)

exportElement

public com.nomagic.magicreport.engine.ITool.Void exportElement(java.io.File exportingFile,
                                                               Element exportingElement,
                                                               boolean exportResources)

Export element to XML file.

Parameters:

exportingFile - exporting file

exportingElement - exporting element

exportResources - true if you want to export resources of this element

Returns:

nothing

exportElement

public com.nomagic.magicreport.engine.ITool.Void exportElement(java.io.File exportingFile,
                                                               Element exportingElement,
                                                               boolean exportResources,
                                                               boolean exportLinkedFile)

Export element to XML file.

Parameters:

exportingFile - exporting file

exportingElement - exporting element

exportResources - true if you want to export resources of this element

exportLinkedFile - true if you want to include linked files.

Returns:

nothing

exportElement

public com.nomagic.magicreport.engine.ITool.Void exportElement(java.io.File exportingFile,
                                                               Element exportingElement,
                                                               boolean exportResources,
                                                               boolean exportLinkedFile,
                                                               @CheckForNull
                                                               com.nomagic.magicdraw.ui.ElementFilter filter)

exportElementForTree

public com.nomagic.magicreport.engine.ITool.Void exportElementForTree(java.io.File exportingNodeFile,
                                                                      Element exportingElement,
                                                                      boolean exportResources,
                                                                      com.nomagic.magicdraw.ui.ElementFilter filter)

Export element to XML file which is used for create tree.

Parameters:

exportingNodeFile - exporting file

exportingElement - export element

exportResources - true if you want to export resources of this element

filter - element filter

Returns:

nothing

getResourcesLocation

protected java.lang.String getResourcesLocation()

Return location of resources directory.

Returns:

a path to resources directory.

createResourcesDir

protected java.io.File createResourcesDir(java.lang.String resourcesLocation)
                                   throws java.io.IOException

Create a resource directory.

Parameters:

resourcesLocation - resources location

Returns:

a File pointed to resources directory

Throws:

java.io.IOException - if IO error occurs.

exportIcon

protected java.lang.String exportIcon(BaseElement exportingElement)
                               throws java.io.IOException

Export the icon for element. This method should not perform graphic renderer by itself. The icon exporting process should be enqueue by method offer(ConsumeObject).

Parameters:

exportingElement - target element

Returns:

path to icon

Throws:

java.io.IOException - if IO error occurs

exportCustomImageHolder

protected java.lang.String exportCustomImageHolder(BaseElement exportingElement)
                                            throws java.io.IOException

Export the image for the element. Image for the element will be exported from strereotype CustomImageHolder.

Parameters:

exportingElement - target element

Returns:

path to icon

Throws:

java.io.IOException - if IO error occurs

createAndExportElement

protected org.w3c.dom.Element createAndExportElement(org.w3c.dom.Document document,
                                                     Element exportingElement,
                                                     boolean exportResources,
                                                     boolean exportLinkedFile,
                                                     @CheckForNull
                                                     com.nomagic.magicdraw.ui.ElementFilter filter)
                                              throws java.io.IOException

Create XML element represents the exportingElement and export the element into file. Return null to cancel this element exporting.

Parameters:

document - XML document

exportingElement - exporting element

exportResources - true if you want to export resources of this element

exportLinkedFile - true if you want to include linked files.

filter - element filter.

Returns:

XML element for creating containment tree.

Throws:

java.io.IOException - when IO error occured.

createAndExportSmartElement

protected org.w3c.dom.Element createAndExportSmartElement(org.w3c.dom.Document document,
                                                          Element exportingElement,
                                                          boolean exportResources,
                                                          boolean exportLinkedFile,
                                                          @CheckForNull
                                                          com.nomagic.magicdraw.ui.ElementFilter filter)
                                                   throws java.io.IOException

Create XML element represents the exportingElement and export the element into file. Return null to cancel this element exporting.

Parameters:

document - XML document

exportingElement - exporting element

exportResources - true if you want to export resources of this element

exportLinkedFile - true if you want to include linked files.

filter - element filter.

Returns:

XML element for creating containment tree.

Throws:

java.io.IOException - when IO error occured.

createAndExportElement

protected org.w3c.dom.Element createAndExportElement(org.w3c.dom.Document document,
                                                     Element exportingElement,
                                                     boolean exportResources,
                                                     boolean exportLinkedFile,
                                                     @CheckForNull
                                                     com.nomagic.magicdraw.ui.ElementFilter filter,
                                                     boolean isSmart)
                                              throws java.io.IOException

Create XML element represents the exportingElement and export the element into file. Return null to cancel this element exporting.

Parameters:

document - XML document

exportingElement - exporting element

exportResources - true if you want to export resources of this element

exportLinkedFile - true if you want to include linked files.

filter - element filter.

Returns:

XML element for creating containment tree.

Throws:

java.io.IOException - when IO error occured.

getElementType

protected java.lang.String getElementType(Element element)

Return String representing element type.

Parameters:

element - element

Returns:

a String representing element type.

exportAll

public java.lang.String exportAll(boolean exportResources,
                                  boolean exportLinkedFile)

Export current opened project into file.

Parameters:

exportResources - true if you want to export resources.

exportLinkedFile - true if you want to include linked files.

Returns:

nothing

destroy

public void destroy()

Called by the engine to inform this tool is no longer use and that it should destroy any resources that it has allocated.

Overrides:

destroy in class com.nomagic.magicreport.engine.ConcurrentTool

See Also:

ConcurrentTool.destroy()

getHumanName

public static java.lang.String getHumanName(java.lang.String propertyName,
                                            java.util.Map<java.lang.String,java.lang.String> nameMap)

Get human name of given property name. If nameMap is used, human name will be resolved by nameMap then resource string.

Parameters:

propertyName - a property name

nameMap - optional provides new name map from DSLManager.getPropertyNameMap(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element) to resolve property name from <<metaType>>

Returns:

human name