public class EANotesLinkConverter
extends java.lang.Object
org.eclipse.uml2.uml.Comment#getBody()
.
The result is the raw HTML text with the EA specific links.
Instances of this class are intended to convert HTML texts produced by EA with convertLinks(String)
into
HTML texts which can be understood by the targeted tool (e.g. a Browser). By default, all links are removed except
file links which are preserved unmodified, and web site links for which the HTTP protocol is used. Subclasses should
override the methods listed in the following table to adjust the conversion of links:
The method buildLink(String, String)
can be used to instantiate a new link for a given destination and text.
The following listing shows an example HTML text produced by EA:
Attribute: <a href="$feature://{A729AEA1-3E70-4199-83DC-5BE43721019F}"><font color="#0000ff"><u>attribute</u></font></a> Browse for file: <a href="$path=C:\kostal-sweng\tools\eclipse-committers-oxygen-2-win32-x86_64"><font color="#0000ff"><u>browseForFile</u></font></a> Diagram: <a href="$diagram://{143D4036-F381-4543-AC95-57C31A1504DA}"><font color="#0000ff"><u>diagram</u></font></a> Diagram image: <a href="$diagramimg://{143D4036-F381-4543-AC95-57C31A1504DA}"><font color="#0000ff"><u>diagramImag</u></font></a>e EA command: <a href="$uicmd=ActivateTechnology;param1=MEEP"><font color="#0000ff"><u>eaCommand</u></font></a> Element: <a href="$element://{9BDC1FEA-3BD5-4195-8330-1DA53F813826}"><font color="#0000ff"><u>element</u></font></a> Element image: <a href="$elementimg://"><font color="#0000ff"><u>elementImage</u></font></a> File: <a href="C:\Test.html"><font color="#0000ff"><u>file</u></font></a> Help: <a href="$help://www.google.de"><font color="#0000ff"><u>help</u></font></a> Image Manager: <a href="$imageman://id=1083648271;mdg=Global;name=DoorsLink.png;type=Bitmap;"><font color="#0000ff"><u>imageManager</u></font></a> Learning Center: <a href="$learning://{13C58F9E-501B-4fbc-B527-5488B2D0CBDE}"><font color="#0000ff"><u>learningCenter</u></font></a> Matrix: <a href="$matrix://"><font color="#0000ff"><u>matrix</u></font></a> Operation: <a href="$feature://{8FFB4DAC-5782-4a74-AAA9-2FA84F004FB8}"><font color="#0000ff"><u>operation</u></font></a> Package: <a href="$package://{3F883307-D07B-4462-95AC-C3238BD63E6D}"><font color="#0000ff"><u>package</u></font></a> Search: <a href="$search://Name=Simple;Term=test;"><font color="#0000ff"><u>search</u></font></a> Team review: <a href="$forum://"><font color="#0000ff"><u>teamReview</u></font></a> web site: <a href="$inet://www.google.de"><font color="#0000ff"><u>webSite</u></font></a>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTRIBUTE_OR_OPERATION_PREFIX |
static java.lang.String |
BROWSE_FOR_FILE_PREFIX |
static java.lang.String |
DIAGRAM_IMAGE_PREFIX |
static java.lang.String |
DIAGRAM_PREFIX |
static java.lang.String |
EA_COMAMND_PREFIX |
static java.lang.String |
EA_LINK_START_TAG_PREFIX |
static java.lang.String |
EA_PREFIX_SIGN |
static java.lang.String |
ELEMENT_IMAGE_PREFIX |
static java.lang.String |
ELEMENT_PREFIX |
static java.lang.String |
HELP_PREFIX |
static java.lang.String |
HTTP_PROTOCOL |
static java.lang.String |
IMAGE_MANAGER_PREFIX |
static java.lang.String |
LEARNING_CENTER_PREFIX |
static java.lang.String |
LINK_END_TAG |
static java.lang.String |
LINK_START_TAG_PREFIX |
static java.lang.String |
LINK_START_TAG_SUFFIX |
static java.lang.String |
MATRIX_PREFIX |
static java.lang.String |
PACKAGE_PREFIX |
static java.lang.String |
SEARCH_PREFIX |
static java.lang.String |
TEAM_REVIEW_PREFIX |
static java.lang.String |
WEB_SITE_PREFIX |
Constructor and Description |
---|
EANotesLinkConverter() |
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
buildLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertAttributeOrOperationLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertBrowseFileLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertDiagramImageLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertDiagramLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertEACommandLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertElementImageLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertElementLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertHelpLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertImageManagerLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertLearningCenterLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertLink(java.lang.String destinationWithEAPrefix,
java.lang.String linkText) |
java.lang.String |
convertLinks(java.lang.String text) |
protected java.lang.String |
convertMatrixLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertPackageLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertSearchLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertTeamReviewLink(java.lang.String destination,
java.lang.String linkText) |
protected java.lang.String |
convertUnsupportedEALink(java.lang.String destinationWithEAPrefix,
java.lang.String linkText) |
protected java.lang.String |
convertWebSiteLink(java.lang.String destination,
java.lang.String linkText) |
public static final java.lang.String LINK_START_TAG_PREFIX
public static final java.lang.String EA_PREFIX_SIGN
public static final java.lang.String EA_LINK_START_TAG_PREFIX
public static final java.lang.String LINK_START_TAG_SUFFIX
public static final java.lang.String LINK_END_TAG
public static final java.lang.String ATTRIBUTE_OR_OPERATION_PREFIX
public static final java.lang.String BROWSE_FOR_FILE_PREFIX
public static final java.lang.String DIAGRAM_PREFIX
public static final java.lang.String DIAGRAM_IMAGE_PREFIX
public static final java.lang.String EA_COMAMND_PREFIX
public static final java.lang.String ELEMENT_PREFIX
public static final java.lang.String ELEMENT_IMAGE_PREFIX
public static final java.lang.String HELP_PREFIX
public static final java.lang.String IMAGE_MANAGER_PREFIX
public static final java.lang.String LEARNING_CENTER_PREFIX
public static final java.lang.String MATRIX_PREFIX
public static final java.lang.String PACKAGE_PREFIX
public static final java.lang.String SEARCH_PREFIX
public static final java.lang.String TEAM_REVIEW_PREFIX
public static final java.lang.String WEB_SITE_PREFIX
public static final java.lang.String HTTP_PROTOCOL
public java.lang.String convertLinks(java.lang.String text)
protected java.lang.String convertLink(java.lang.String destinationWithEAPrefix, java.lang.String linkText)
protected java.lang.String convertAttributeOrOperationLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertBrowseFileLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertDiagramLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertDiagramImageLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertEACommandLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertElementLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertElementImageLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertHelpLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertImageManagerLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertLearningCenterLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertMatrixLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertPackageLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertSearchLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertTeamReviewLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertWebSiteLink(java.lang.String destination, java.lang.String linkText)
protected java.lang.String convertUnsupportedEALink(java.lang.String destinationWithEAPrefix, java.lang.String linkText)
protected java.lang.String buildLink(java.lang.String destination, java.lang.String linkText)
Copyright (c) 2015 itemis AG, and others. All rights reserved.