public class PlaceholderSpec
extends java.lang.Object
FreeFormDocumentation
, templates for doc generation have to use labels to
indicate where to insert the documentation of what element of the UML model into the output
document. Currently needed and recognised labels to be used in the input templates are in the
following format:
startUmlDiagram.{packageName}.{diagramName}.endUml startUmlDiagNote.{packageName}.{diagramName}.endUml startUmlAttribute.{className}.{attributeName}.endUml startUmlIec61850NsName.{className}.endUml (IEC 61850-7-*, for name space name) startUmlFile..endUml startUmlPresenceConditions.{packageName}.endUml (IEC 61850-7-3, for presence conditions table) startUmlFCs.{packageName}.endUml (IEC 61850-7-3 and IEC 61850-7-2, for FC table) startUmlTrgOps.{packageName}.endUml (IEC 61850-7-2, for TrgOp table) startUmlAbbreviations.{packageName}.endUml (IEC 61850-7-4, for DO abbreviations table) startUmlSclEnums.{packageName}.endUml (IEC 61850-7-4, 7-3, for enums as XML) startUmlPackage.{packageName}.endUml startUmlClass.{packageName}.{className}.endUml startUmlDataIndex.{packageName}.endUml (for IEC 61850-7-4,3, for data semantics tables) startUmlLNMapPackage.{packageName}.endUml (for IEC 61850-7-4, for function/LN map tables)The tokens enlosed in curly braces are the names of UML elements designating what needs to be inserted in place of the whole above string.
This format avoids us the need to define bookmarks in the input document (tedious and error-prone) and makes it simple to sequentially search the input document and insert the text and diagrams as they come.
Usage
Instance of kind PlaceholderSpec.Kind.UNSUPPORTED
always returns non-null error that you may want to use
to replace the placeholder to indicate failure. Instances of kind PlaceholderSpec.Kind.FILE
are the
simplest as they need not parse anything, so no errors and no saved tokens.
The instances of other kinds do need to parse the placeholder and will have tokens set as follows:
PlaceholderSpec.Kind.PRES_CONDITIONS
, PlaceholderSpec.Kind.ABBREVIATIONS
, PlaceholderSpec.Kind.SCL_ENUMS
, PlaceholderSpec.Kind.PACKAGE
, PlaceholderSpec.Kind.LNMAP_PACKAGE
, PlaceholderSpec.Kind.DATA_INDEX
, PlaceholderSpec.Kind.FCS
,
PlaceholderSpec.Kind.TRGOPS
) or
PlaceholderSpec.Kind.ATTRIBUTE
, PlaceholderSpec.Kind.DIAGRAM
, PlaceholderSpec.Kind.DIAG_NOTE
,
PlaceholderSpec.Kind.CLASS
).
Important: To have correct headings and paragraph formats, ensure you use the following placeholders in a heading paragraph:
Modifier and Type | Class and Description |
---|---|
static class |
PlaceholderSpec.Kind |
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
END_UML |
static java.lang.String |
HL_MS_PATTERN |
static java.lang.String |
MS_PATTERN |
protected static java.lang.String |
PH_LETTERS |
static java.lang.String |
SEPARATOR |
protected static java.lang.String |
START_UML |
protected static java.lang.String |
WILDCARD |
Constructor and Description |
---|
PlaceholderSpec(java.lang.String text) |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
constructAbbrPackagePlaceholderText(java.lang.String pckName) |
static java.lang.String |
constructAttributePlaceholderText(java.lang.String className,
java.lang.String attrName) |
static java.lang.String |
constructClassPlaceholderText(java.lang.String pckName,
java.lang.String className) |
static java.lang.String |
constructDataIndexPlaceholderText(java.lang.String pckName) |
static java.lang.String |
constructDiagNotePlaceholderText(java.lang.String containerName,
java.lang.String diagName) |
static java.lang.String |
constructDiagramPlaceholderText(java.lang.String containerName,
java.lang.String diagName) |
static java.lang.String |
constructEnumPackagePlaceholderText(java.lang.String pckName) |
static java.lang.String |
constructFcsPackagePlaceholderText(java.lang.String pckName) |
static java.lang.String |
constructFilePlaceholderText() |
static java.lang.String |
constructIec61850NsNamePlaceholderText(java.lang.String className) |
static java.lang.String |
constructInternalHyperlinkPlaceholderText(java.lang.String umlObjectName,
java.lang.String bookmarkID) |
static java.lang.String |
constructLNMapPackagePlaceholderText(java.lang.String pckName) |
static java.lang.String |
constructPackagePlaceholderText(java.lang.String pckName) |
static java.lang.String |
constructPresConditionsPackagePlaceholderText(java.lang.String pckName) |
static java.lang.String |
constructTrgOpsPackagePlaceholderText(java.lang.String pckName) |
java.lang.String |
getErrorText()
Returns null if there are no parsing errors, the error message otherwise.
|
java.lang.String |
getFirstToken() |
PlaceholderSpec.Kind |
getKind() |
java.lang.String |
getSecondToken() |
static java.util.List<java.lang.String> |
getSupportedFormats() |
java.lang.String |
getText()
Returns the placeholder text.
|
java.lang.String |
toString() |
void |
updateModelErrorText()
Use this setter when finder could not find valid tokens in the model (e.g., format of the
placeholder is ok, but the names do not match elements in the model).
|
protected static final java.lang.String START_UML
protected static final java.lang.String END_UML
public static final java.lang.String SEPARATOR
protected static final java.lang.String WILDCARD
protected static final java.lang.String PH_LETTERS
public static final java.lang.String MS_PATTERN
public static final java.lang.String HL_MS_PATTERN
public static java.lang.String constructFilePlaceholderText()
public static java.lang.String constructDiagramPlaceholderText(java.lang.String containerName, java.lang.String diagName)
public static java.lang.String constructDiagNotePlaceholderText(java.lang.String containerName, java.lang.String diagName)
public static java.lang.String constructAttributePlaceholderText(java.lang.String className, java.lang.String attrName)
public static java.lang.String constructIec61850NsNamePlaceholderText(java.lang.String className)
public static java.lang.String constructPresConditionsPackagePlaceholderText(java.lang.String pckName)
public static java.lang.String constructFcsPackagePlaceholderText(java.lang.String pckName)
public static java.lang.String constructTrgOpsPackagePlaceholderText(java.lang.String pckName)
public static java.lang.String constructAbbrPackagePlaceholderText(java.lang.String pckName)
public static java.lang.String constructEnumPackagePlaceholderText(java.lang.String pckName)
public static java.lang.String constructPackagePlaceholderText(java.lang.String pckName)
public static java.lang.String constructClassPlaceholderText(java.lang.String pckName, java.lang.String className)
public static java.lang.String constructLNMapPackagePlaceholderText(java.lang.String pckName)
public static java.lang.String constructDataIndexPlaceholderText(java.lang.String pckName)
public static java.lang.String constructInternalHyperlinkPlaceholderText(java.lang.String umlObjectName, java.lang.String bookmarkID)
public static java.util.List<java.lang.String> getSupportedFormats()
public java.lang.String getText()
public PlaceholderSpec.Kind getKind()
public java.lang.String getFirstToken()
public java.lang.String getSecondToken()
public java.lang.String getErrorText()
public void updateModelErrorText()
public java.lang.String toString()
toString
in class java.lang.Object
Copyright 2009-2016 Tatjana (Tanja) Kostic