com.arcway.cockpit.docgen.provider.interfaces

Interface IPlan

All Superinterfaces:

ICockpitData, ICustomPropertiesAccess, IGraphic

public interface IPlan
extends IGraphic

IPlan allows to read attribute values of a plan/diagram.

Item type constant: "plan"

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends IFolder>	getAllFolders() Returns all folders and subfolders for this plan starting at the root.
java.util.List<? extends IModelElement>	getAllModelElements() Returns all model elements on this plan sorted by their type and element names.
java.util.List<java.lang.String>	getDescription() Returns the description of the plan/diagram.
java.lang.String	getEMFFileWithPresentationRule(IPlanPresentationRule planPresentationRule) Creates a emf+ version of the plan with a configurable appearance, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
IFolder	getFolder() Returns the folder where this plan can be found.
java.lang.String	getImage(boolean withMetaInformation, boolean withComments) Creates an image version of the plan with meta information (e.g.
java.lang.String	getImage(java.util.Map<java.lang.String,ILink> linkMap, java.util.Map<java.lang.String,IElementPresentationRule> presentationMap) Deprecated. it is recommeded to use getImageWithPresentationRule(IPlanPresentationRule) instead
java.lang.String	getImageFileWithMetaInformation() Creates an image version of the plan with meta information (e.g.
java.lang.String	getImageFileWithMetaInformation(java.util.Map<java.lang.String,ILink> linkMap) Deprecated. it is recommeded to use getImageWithPresentationRule(IPlanPresentationRule) instead
java.lang.String	getImageFileWithMetaInformation(java.util.Map<java.lang.String,ILink> linkMap, java.util.Map<java.lang.String,IElementPresentationRule> presentationMap) Deprecated. it is recommeded to use getImageWithPresentationRule(IPlanPresentationRule) instead
java.lang.String	getImageFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID) Creates a image version of the plan.
java.lang.String	getImageFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID, java.util.Map<java.lang.String,ILink> linkMap) Deprecated. it is recommeded to use getImageWithPresentationRule(IPlanPresentationRule) instead
java.lang.String	getImageFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID, java.util.Map<java.lang.String,ILink> linkMap, java.util.Map<java.lang.String,IElementPresentationRule> presentationMap) Deprecated. it is recommeded to use getImageWithPresentationRule(IPlanPresentationRule) instead
IPlanInfo	getImageInfo(IPlanPresentationRule planPresentationRule) Returns information about a plan corresponding to getImageWithPresentationRule(IPlanPresentationRule).
java.lang.String	getImageWithPresentationRule(IPlanPresentationRule planPresentationRule) Creates an image version of the plan with a configurable appearance in the file format preferred by the selected document output format (e.g. word: wmf, HTML: png, DocBOOK: svg), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
java.util.List<? extends IModelElement>	getLeafModelElementsOfCausalityRelationship() Returns all model elements on this plan, which are leaf elements of the causality relationship, i.e. which are not causally preceding any other model element.
java.util.List<? extends IModelElement>	getLeafModelElementsOfContainmentRelationship() Returns all model elements on this plan, which are leaf elements of the containment relationship, i.e. which do not contain any other model element.
java.lang.String	getLinkForShow(IPlanPresentationRule planPresentationRule) Creates a link to show this plan in ARCWAY COCKPIT.
java.lang.String	getName() Returns the name of the plan.
java.lang.String	getPlanType() Returns the internal type name of the plan.
java.lang.String	getPNGFile(boolean withMetaInformation, boolean withComments) Creates a png version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
java.lang.String	getPNGFileWithMetaInformation() Creates a png version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
java.lang.String	getPNGFileWithPresentationRule(IPlanPresentationRule planPresentationRule) Creates a png version of the plan with a configurable appearance, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
java.lang.String	getPNGFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID) Creates a png version of the plan.
java.util.List<? extends IModelElement>	getRootModelElementsOfCausalityRelationship() Returns all model elements on this plan, which are root elements of the causality relationship, i.e. for which no causally preceding model element exists.
java.util.List<? extends IModelElement>	getRootModelElementsOfContainmentRelationship() Returns all model elements on this plan, which are root elements of the containment relationship, i.e. which are not contained in any other model element.
java.lang.String	getSVGFile(boolean withMetaInformation, boolean withComments) Creates a svg version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
java.lang.String	getSVGFile(java.util.Map<java.lang.String,ILink> linkMap, java.util.Map<java.lang.String,IElementPresentationRule> presentationMap) Deprecated. it is recommeded to use getSVGFileWithPresentationRule(IPlanPresentationRule) instead
java.lang.String	getSVGFileWithMetaInformation() Creates a svg version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
java.lang.String	getSVGFileWithMetaInformation(java.util.Map<java.lang.String,ILink> linkMap) Deprecated. it is recommeded to use getSVGFileWithPresentationRule(IPlanPresentationRule) instead
java.lang.String	getSVGFileWithMetaInformation(java.util.Map<java.lang.String,ILink> linkMap, java.util.Map<java.lang.String,IElementPresentationRule> presentationMap) Deprecated. it is recommeded to use getSVGFileWithPresentationRule(IPlanPresentationRule) instead
java.lang.String	getSVGFileWithPresentationRule(IPlanPresentationRule planPresentationRule) Creates a svg version of the plan with a configurable appearance, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
java.lang.String	getSVGFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID) Creates a svg version of the plan.
java.lang.String	getSVGFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID, java.util.Map<java.lang.String,ILink> linkMap) Deprecated. it is recommeded to use getSVGFileWithPresentationRule(IPlanPresentationRule) instead
java.lang.String	getSVGFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID, java.util.Map<java.lang.String,ILink> linkMap, java.util.Map<java.lang.String,IElementPresentationRule> presentationMap) Deprecated. it is recommeded to use getSVGFileWithPresentationRule(IPlanPresentationRule) instead
java.lang.String	getUniqueIdentifier() Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
java.lang.String	getWMFFile(boolean withMetaInformation, boolean withComments) Creates a wmf version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
java.lang.String	getWMFFileWithMetaInformation() Creates a wmf version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
java.lang.String	getWMFFileWithPresentationRule(IPlanPresentationRule planPresentationRule) Creates a wmf version of the plan with a configurable appearance, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file.
java.lang.String	getWMFFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID) Creates a wmf version of the plan.
void	open() Opens this plan in the current client.
void	openWithPresentationRule(IPlanPresentationRule planPresentationRule) Opens this plan in the current client (see {@link #open()).
IRecord	toRecord() Converts this generic module data into a record.

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic

getEMFFile, getImage, getPNGFile, getSVGFile, getWMFFile

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

getCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFileProperty

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

getCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getLinkForShow, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

Method Detail

getUniqueIdentifier

java.lang.String getUniqueIdentifier()

Returns a unique identifier that uniquely identifies this object within the COCKPIT project.

Example from report template:

#set($plan_uid = ${plan.getUniqueIdentifier()})

Specified by:

getUniqueIdentifier in interface ICockpitData

Returns:

unique identifier

getName

java.lang.String getName()

Returns the name of the plan.

The name is already HTML encoded so that it can be inserted into the document without further tranformations.

Example from report template:

Plan name: ${plan.getName()}

Returns:

name of the plan (!= null)

getDescription

java.util.List<java.lang.String> getDescription()

Returns the description of the plan/diagram. If the description consists of multiple lines (ENTER), each line is represented by an element in the String array.

The description text is already HTML encoded so that it can be inserted into the document without further tranformations.

Example from report template:

#foreach( $text in ${plan.getDescription()})
$text
#end

Returns:

Description text of the plan, splitted into multiple strings, one for each line. (!= null)

getPlanType

java.lang.String getPlanType()

Returns the internal type name of the plan.

The possible values depend on the Cockpit modules that have been installed and thus may change.

Currently possible values are: fmc.bd, fmc.pn, fmc.er, bpre.epc, bpre.o, bpmn.bpd, uml.cd, uml.sd, acm.pd, gui

Example from report template:

#if ($plan.getPlanType().equals("bpmn.bpd"))
This is a plan of type BPMN
#end

Returns:

Internal type name of the plan. E.g. fmc.bd, bpmn.bpd, gui, ... (!= null)

getFolder

IFolder getFolder()

Returns the folder where this plan can be found.

Returns:

folder where the plan is stored.

getAllFolders

java.util.List<? extends IFolder> getAllFolders()

Returns all folders and subfolders for this plan starting at the root.

Returns:

list of folders

getAllModelElements

java.util.List<? extends IModelElement> getAllModelElements()

Returns all model elements on this plan sorted by their type and element names.

Returns:

a list of all model elements (!=null)

getRootModelElementsOfContainmentRelationship

java.util.List<? extends IModelElement> getRootModelElementsOfContainmentRelationship()

Returns all model elements on this plan, which are root elements of the containment relationship, i.e. which are not contained in any other model element. The model elements are returned sorted by their type and element names.

Returns:

a list of all model elements on this plan, which are root elements of the containment relationship (!=null)

getRootModelElementsOfCausalityRelationship

java.util.List<? extends IModelElement> getRootModelElementsOfCausalityRelationship()

Returns all model elements on this plan, which are root elements of the causality relationship, i.e. for which no causally preceding model element exists. The model elements are returned sorted by their type and element names.

Returns:

a list of all model elements on this plan, which are root elements of the causality relationship (!=null)

getLeafModelElementsOfContainmentRelationship

java.util.List<? extends IModelElement> getLeafModelElementsOfContainmentRelationship()

Returns all model elements on this plan, which are leaf elements of the containment relationship, i.e. which do not contain any other model element. The model elements are returned sorted by their type and element names.

Returns:

a list of all model elements on this plan, which are leaf elements of the containment relationship (!=null)

getLeafModelElementsOfCausalityRelationship

java.util.List<? extends IModelElement> getLeafModelElementsOfCausalityRelationship()

Returns all model elements on this plan, which are leaf elements of the causality relationship, i.e. which are not causally preceding any other model element. The model elements are returned sorted by their type and element names.

Returns:

a list of all model elements on this plan, which are leaf elements of the causality relationship (!=null)

getImage

@Deprecated
java.lang.String getImage(java.util.Map<java.lang.String,ILink> linkMap,
                                      java.util.Map<java.lang.String,IElementPresentationRule> presentationMap)

Deprecated. it is recommeded to use getImageWithPresentationRule(IPlanPresentationRule) instead

Creates an image version of the plan in the file format preffered by the selected document output format (e.g. word: wmf, HTML: png, DocBOOK: svg), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.) If the file format preferred supports links, this method creates hyperlinks on objects that are presented in the graphic.

Parameters:

linkMap - A map containing the object's UID and the link for this object. Use IProjectDataProvider.createLink(String, String, String, String) to create link objects and use ArrayHelper.createHashSet() to create a map to put the link objects in.

presentationMap - A map containing the object's UID and the presentation rule for this object. Use IProjectDataProvider.createElementPresentationRule() to create presentation rule object and use ArrayHelper.createHashSet() to create a map to put the presentation rule objects into.

Returns:

XML elements for doc book file

getSVGFile

@Deprecated
java.lang.String getSVGFile(java.util.Map<java.lang.String,ILink> linkMap,
                                        java.util.Map<java.lang.String,IElementPresentationRule> presentationMap)

Deprecated. it is recommeded to use getSVGFileWithPresentationRule(IPlanPresentationRule) instead

Creates a svg version of the plan, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.) Creates an SVG file an creates hyperlinks on objects that are presented in the graphic.

Parameters:

linkMap - A map containing the object's UID and the link for this object. Use IProjectDataProvider.createLink(String, String, String, String) to create link objects and use ArrayHelper.createHashSet() to create a map to put the link objects in.

presentationMap - A map containing the object's UID and the presentation rule for this object. Use IProjectDataProvider.createElementPresentationRule() to create presentation rule object and use ArrayHelper.createHashSet() to create a map to put the presentation rule objects into.

Returns:

XML elements for doc book file

getPNGFileWithMetaInformation

java.lang.String getPNGFileWithMetaInformation()

Creates a png version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Returns:

XML elements for doc book file

getSVGFileWithMetaInformation

java.lang.String getSVGFileWithMetaInformation()

Creates a svg version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Returns:

XML elements for doc book file

getSVGFileWithMetaInformation

@Deprecated
java.lang.String getSVGFileWithMetaInformation(java.util.Map<java.lang.String,ILink> linkMap)

Deprecated. it is recommeded to use getSVGFileWithPresentationRule(IPlanPresentationRule) instead

Creates a svg version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.) Creates an SVG file an creates hyperlinks on objects that are presented in the graphic.

Parameters:

linkMap - A map containing the object's UID and the link for this object. Use IProjectDataProvider.createLink(String, String, String, String) to create link objects and use ArrayHelper.createHashSet() to create a map to put the link objects in.

Returns:

XML elements for doc book file

getSVGFileWithMetaInformation

@Deprecated
java.lang.String getSVGFileWithMetaInformation(java.util.Map<java.lang.String,ILink> linkMap,
                                                           java.util.Map<java.lang.String,IElementPresentationRule> presentationMap)

Deprecated. it is recommeded to use getSVGFileWithPresentationRule(IPlanPresentationRule) instead

Creates a svg version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.) Creates an SVG file an creates hyperlinks on objects that are presented in the graphic.

Parameters:

linkMap - A map containing the object's UID and the link for this object. Use IProjectDataProvider.createLink(String, String, String, String) to create link objects and use ArrayHelper.createHashSet() to create a map to put the link objects into.

presentationMap - A map containing the object's UID and the presentation rule for this object. Use IProjectDataProvider.createElementPresentationRule() to create presentation rule object and use ArrayHelper.createHashSet() to create a map to put the presentation rule objects into.

Returns:

XML elements for doc book file

getWMFFileWithMetaInformation

java.lang.String getWMFFileWithMetaInformation()

Creates a wmf version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Returns:

XML elements for doc book file

getImageFileWithMetaInformation

java.lang.String getImageFileWithMetaInformation()

Creates an image version of the plan with meta information (e.g. frame and text legend) in the file format preferred by the selected document output format (e.g. word: wmf, HTML: png, DocBOOK: svg), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Returns:

XML elements for doc book file

getImageFileWithMetaInformation

@Deprecated
java.lang.String getImageFileWithMetaInformation(java.util.Map<java.lang.String,ILink> linkMap)

Deprecated. it is recommeded to use getImageWithPresentationRule(IPlanPresentationRule) instead

Creates an image version of the plan with meta information (e.g. frame and text legend) in the file format preferred by the selected document output format (e.g. word: wmf, HTML: png, DocBOOK: svg), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.) When supported by the preferred file format, hyperlinks are created on objects that are presented in the graphic.

Parameters:

linkMap - A map containing the object's UID and the link for this object. Use IProjectDataProvider.createLink(String, String, String, String) to create link objects and use ArrayHelper.createHashSet() to create a map to put the link objects in.

Returns:

XML elements for doc book file

getImageFileWithMetaInformation

@Deprecated
java.lang.String getImageFileWithMetaInformation(java.util.Map<java.lang.String,ILink> linkMap,
                                                             java.util.Map<java.lang.String,IElementPresentationRule> presentationMap)

Deprecated. it is recommeded to use getImageWithPresentationRule(IPlanPresentationRule) instead

Creates an image version of the plan with meta information (e.g. frame and text legend) in the file format preferred by the selected document output format (e.g. word: wmf, HTML: png, DocBOOK: svg), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.) When supported by the preferred file format, hyperlinks are created on objects that are presented in the graphic.

Parameters:

linkMap - A map containing the object's UID and the link for this object. Use IProjectDataProvider.createLink(String, String, String, String) to create link objects and use ArrayHelper.createHashSet() to create a map to put the link objects in.

presentationMap - A map containing the object's UID and the presentation rule for this object. Use IProjectDataProvider.createElementPresentationRule() to create presentation rule object and use ArrayHelper.createHashSet() to create a map to put the presentation rule objects into.

Returns:

XML elements for doc book file

getPNGFile

java.lang.String getPNGFile(boolean withMetaInformation,
                            boolean withComments)

Creates a png version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

withMetaInformation - Whether or not meta information should be included in the plan image

withComments - Whether or not "Comment" Plan Elements should be included in the plan image

Returns:

XML elements for doc book file

getSVGFile

java.lang.String getSVGFile(boolean withMetaInformation,
                            boolean withComments)

Creates a svg version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

withMetaInformation - Whether or not meta information should be included in the plan image

withComments - Whether or not "Comment" Plan Elements should be included in the plan image

Returns:

XML elements for doc book file

getWMFFile

java.lang.String getWMFFile(boolean withMetaInformation,
                            boolean withComments)

Creates a wmf version of the plan with meta information (e.g. frame and text legend), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

withMetaInformation - Whether or not meta information should be included in the plan image

withComments - Whether or not "Comment" Plan Elements should be included in the plan image

Returns:

XML elements for doc book file

getImage

java.lang.String getImage(boolean withMetaInformation,
                          boolean withComments)

Creates an image version of the plan with meta information (e.g. frame and text legend) in the file format preferred by the selected document output format (e.g. word: wmf, HTML: png, DocBOOK: svg), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

withMetaInformation - Whether or not meta information should be included in the plan image

withComments - Whether or not "Comment" Plan Elements should be included in the plan image

Returns:

XML elements for doc book file

getPNGFileWithReplacedPlanElementName

java.lang.String getPNGFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID)

Creates a png version of the plan.

The plan element names of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element. This attribute must be a single line text.

Stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

globalElementPropertyID - the property id

Returns:

XML elements for doc book file

getSVGFileWithReplacedPlanElementName

java.lang.String getSVGFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID)

Creates a svg version of the plan.

The plan element names of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element. This attribute must be a single line text.

Stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

globalElementPropertyID - the property id

Returns:

XML elements for doc book file

getSVGFileWithReplacedPlanElementName

@Deprecated
java.lang.String getSVGFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID,
                                                                   java.util.Map<java.lang.String,ILink> linkMap)

Deprecated. it is recommeded to use getSVGFileWithPresentationRule(IPlanPresentationRule) instead

Creates a svg version of the plan.

The plan element names of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element. This attribute must be a single line text.

Stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

globalElementPropertyID - the property id Creates an SVG file an creates hyperlinks on objects that are presented in the graphic.

linkMap - A map containing the object's UID and the link for this object. Use IProjectDataProvider.createLink(String, String, String, String) to create link objects and use ArrayHelper.createHashSet() to create a map to put the link objects in.

Returns:

XML elements for doc book file

getSVGFileWithReplacedPlanElementName

@Deprecated
java.lang.String getSVGFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID,
                                                                   java.util.Map<java.lang.String,ILink> linkMap,
                                                                   java.util.Map<java.lang.String,IElementPresentationRule> presentationMap)

Deprecated. it is recommeded to use getSVGFileWithPresentationRule(IPlanPresentationRule) instead

Creates a svg version of the plan.

The plan element names of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element. This attribute must be a single line text.

Stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

globalElementPropertyID - the property id Creates an SVG file an creates hyperlinks on objects that are presented in the graphic.

linkMap - A map containing the object's UID and the link for this object. Use IProjectDataProvider.createLink(String, String, String, String) to create link objects and use ArrayHelper.createHashSet() to create a map to put the link objects in.

presentationMap - A map containing the object's UID and the presentation rule for this object. Use IProjectDataProvider.createElementPresentationRule() to create presentation rule object and use ArrayHelper.createHashSet() to create a map to put the presentation rule objects into.

Returns:

XML elements for doc book file

getWMFFileWithReplacedPlanElementName

java.lang.String getWMFFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID)

Creates a wmf version of the plan.

The plan element names of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element. This attribute must be a single line text.

Stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

globalElementPropertyID - the property id

Returns:

XML elements for doc book file

getImageFileWithReplacedPlanElementName

java.lang.String getImageFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID)

Creates a image version of the plan.

The plan element names of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element. This attribute must be a single line text.

Stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

globalElementPropertyID - the property id

Returns:

XML elements for doc book file

getImageFileWithReplacedPlanElementName

@Deprecated
java.lang.String getImageFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID,
                                                                     java.util.Map<java.lang.String,ILink> linkMap)

Deprecated. it is recommeded to use getImageWithPresentationRule(IPlanPresentationRule) instead

Creates a image version of the plan.

The plan element names of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element. This attribute must be a single line text.

Stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

globalElementPropertyID - the property id When supported by the preferred file format, hyperlinks are created on objects that are presented in the graphic.

linkMap - A map containing the object's UID and the link for this object. Use IProjectDataProvider.createLink(String, String, String, String) to create link objects and use ArrayHelper.createHashSet() to create a map to put the link objects in.

Returns:

XML elements for doc book file

getImageFileWithReplacedPlanElementName

@Deprecated
java.lang.String getImageFileWithReplacedPlanElementName(java.lang.String globalElementPropertyID,
                                                                     java.util.Map<java.lang.String,ILink> linkMap,
                                                                     java.util.Map<java.lang.String,IElementPresentationRule> presentationMap)

Deprecated. it is recommeded to use getImageWithPresentationRule(IPlanPresentationRule) instead

Creates a image version of the plan.

The plan element names of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element. This attribute must be a single line text.

Stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

globalElementPropertyID - the property id When supported by the preferred file format, hyperlinks are created on objects that are presented in the graphic.

linkMap - A map containing the object's UID and the link for this object. Use IProjectDataProvider.createLink(String, String, String, String) to create link objects and use ArrayHelper.createHashSet() to create a map to put the link objects in.

presentationMap - A map containing the object's UID and the presentation rule for this object. Use IProjectDataProvider.createElementPresentationRule() to create presentation rule object and use ArrayHelper.createHashSet() to create a map to put the presentation rule objects into.

Returns:

XML elements for doc book file

open

void open()

Opens this plan in the current client.

Note: If the plan is already opened, it will be topped. If the plan is currently in edit mode, it will be switched into non-edit mode. If the plan is currently unsaved, the user will be asked for saving - and might discard.

openWithPresentationRule

void openWithPresentationRule(IPlanPresentationRule planPresentationRule)

Opens this plan in the current client (see #open()).

If the current version of the plan is already opened in an existing editor it will be topped (reused) if:

• {@link IPlanPresentationRule#getAttributeIDForReplacedPlanElementName()} returns null and
• {@link IPlanPresentationRule#getIndividualVersionName()} returns null and
• {@link IPlanPresentationRule#getPlanElementUID2individualNameReplacement()} returns null

If at least one of the three attributes is set, an existing plan editor will be topped (reused) if the property values of {@link IPlanPresentationRule#getAttributeIDForReplacedPlanElementName()} and {@link IPlanPresentationRule#getIndividualVersionName()} match.

Some properites of the given plan presentation rules may be ignored:

• {@link IPlanPresentationRule#getZoom()} (always standard)
• {@link IPlanPresentationRule#getOffsetXinMM()} (always standard)
• {@link IPlanPresentationRule#getOffsetYinMM()} (always standard)
• {@link IPlanPresentationRule#getWidthInMM()} (always standard)
• {@link IPlanPresentationRule#getHeightInMM()} (always standard)
• {@link IPlanPresentationRule#getRole()} (irrelevant)
• {@link IPlanPresentationRule#isWithMetaInformation()} (always false)
• {@link IPlanPresentationRule#isWithComments()} (always true)
• {@link IPlanPresentationRule#getLinkMap()} (ignored)
• {@link IPlanPresentationRule#getAngle} (always 0)
• {@link IElementPresentationRule#getRole()} (irrelevant)

Parameters:

planPresentationRule - plan presentation rule

getLinkForShow

java.lang.String getLinkForShow(IPlanPresentationRule planPresentationRule)

Creates a link to show this plan in ARCWAY COCKPIT.

The link opens this plan in the current client (see #open()).

If the current version of the plan is already opened in an existing editor it will be topped (reused) if:

• {@link IPlanPresentationRule#getAttributeIDForReplacedPlanElementName()} returns null and
• {@link IPlanPresentationRule#getIndividualVersionName()} returns null and
• {@link IPlanPresentationRule#getPlanElementUID2individualNameReplacement()} returns null

If at least one of the three attributes is set, an existing plan editor will be topped (reused) if the property values of {@link IPlanPresentationRule#getAttributeIDForReplacedPlanElementName()} and {@link IPlanPresentationRule#getIndividualVersionName()} match.

Some properites of the given plan presentation rules may be ignored:

• {@link IPlanPresentationRule#getZoom()} (always standard)
• {@link IPlanPresentationRule#getOffsetXinMM()} (always standard)
• {@link IPlanPresentationRule#getOffsetYinMM()} (always standard)
• {@link IPlanPresentationRule#getWidthInMM()} (always standard)
• {@link IPlanPresentationRule#getHeightInMM()} (always standard)
• {@link IPlanPresentationRule#getRole()} (irrelevant)
• {@link IPlanPresentationRule#isWithMetaInformation()} (always false)
• {@link IPlanPresentationRule#isWithComments()} (always true)
• {@link IPlanPresentationRule#getLinkMap()} (ignored)
• {@link IPlanPresentationRule#getAngle} (always 0)
• {@link IElementPresentationRule#getRole()} (irrelevant)

Parameters:

planPresentationRule - plan presentation rule

Returns:

link (html encoded, never null)

getImageWithPresentationRule

java.lang.String getImageWithPresentationRule(IPlanPresentationRule planPresentationRule)

Creates an image version of the plan with a configurable appearance in the file format preferred by the selected document output format (e.g. word: wmf, HTML: png, DocBOOK: svg), stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

planPresentationRule - plan presentation rule

Returns:

XML elements for doc book file

getPNGFileWithPresentationRule

java.lang.String getPNGFileWithPresentationRule(IPlanPresentationRule planPresentationRule)

Creates a png version of the plan with a configurable appearance, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

planPresentationRule - plan presentation rule

Returns:

XML elements for doc book file

getSVGFileWithPresentationRule

java.lang.String getSVGFileWithPresentationRule(IPlanPresentationRule planPresentationRule)

Creates a svg version of the plan with a configurable appearance, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

planPresentationRule - plan presentation rule

Returns:

XML elements for doc book file

getWMFFileWithPresentationRule

java.lang.String getWMFFileWithPresentationRule(IPlanPresentationRule planPresentationRule)

Creates a wmf version of the plan with a configurable appearance, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

planPresentationRule - plan presentation rule

Returns:

XML elements for doc book file

getEMFFileWithPresentationRule

java.lang.String getEMFFileWithPresentationRule(IPlanPresentationRule planPresentationRule)

Creates a emf+ version of the plan with a configurable appearance, stores this plan in the temporary directory for report generation and returns one or more XML element/s which can be inserted directly into the DocBook file. The returned XML elements already contain any formatting information used to export the plan into the requested output format (word, html etc.)

Parameters:

planPresentationRule - plan presentation rule

Returns:

XML elements for doc book file

getImageInfo

IPlanInfo getImageInfo(IPlanPresentationRule planPresentationRule)

Returns information about a plan corresponding to getImageWithPresentationRule(IPlanPresentationRule).

Parameters:

planPresentationRule - plan presentation rule

Returns:

plan info (never null)

toRecord

IRecord toRecord()

Converts this generic module data into a record.

In addition to all fields documented at ICustomPropertiesAccess.toRecord(), in the created record, the following fields are filled accoring to the wrapped cockpit data:

• IRecord.NAME_KEY
• IRecord.DESCRIPTION_KEY

Specified by:

toRecord in interface ICockpitData

Specified by:

toRecord in interface ICustomPropertiesAccess

Returns:

converted cockpit project data