public class Placeholder
extends java.lang.Object
startUmlDiagram.{packageName}.{diagramName}.endUml startUmlAttribute.{className}.{attributeName}.endUml 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 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 Placeholder.Kind.UNSUPPORTED
always returns non-null error that you may want to use
to replace the placeholder to indicate failure. Instances of kind Placeholder.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:
Placeholder.Kind.PRES_CONDITIONS
, Placeholder.Kind.ABBREVIATIONS
, Placeholder.Kind.SCL_ENUMS
, Placeholder.Kind.PACKAGE
, Placeholder.Kind.LNMAP_PACKAGE
, Placeholder.Kind.DATA_INDEX
, Placeholder.Kind.FCS
,
Placeholder.Kind.TRGOPS
) or
Placeholder.Kind.ATTRIBUTE
, Placeholder.Kind.DIAGRAM
).
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 |
Placeholder.Kind |
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
_errorText |
private int |
_figureCountBefore |
private java.lang.String |
_firstToken |
private Placeholder.Kind |
_kind |
private int |
_myFigureCount |
private int |
_myTableCount |
private java.lang.String |
_replacedText |
private java.lang.String |
_secondToken |
private int |
_tableCountBefore |
private java.lang.String |
_text |
private static java.lang.String |
END_UML |
static java.lang.String |
MS_PATTERN |
private static java.lang.String |
NOT_IN_MODEL_ERROR_TEXT |
static java.lang.String |
PH_LETTERS |
private static java.lang.String |
PLACEHOLDER_ERROR_TEXT |
private static java.lang.String |
SEPARATOR |
private static java.lang.String |
START_UML |
private static java.lang.String |
TOKEN_ERROR_TEXT |
private static java.lang.String |
UML_ABBREVIATIONS |
private static java.lang.String |
UML_ATTRIBUTE |
private static java.lang.String |
UML_DATA_INDEX |
private static java.lang.String |
UML_DIAGRAM |
private static java.lang.String |
UML_FCS |
private static java.lang.String |
UML_FILE |
private static java.lang.String |
UML_LNMAP_PACKAGE |
private static java.lang.String |
UML_PACKAGE |
private static java.lang.String |
UML_PRES_CONDITIONS |
private static java.lang.String |
UML_SCL_ENUMS |
private static java.lang.String |
UML_TRGOPS |
Constructor and Description |
---|
Placeholder(java.lang.String text) |
Placeholder(java.lang.String text,
int figureCountBefore,
int tableCountBefore) |
Modifier and Type | Method and Description |
---|---|
int |
addFigure()
Returns the index to be used to reference the added figure caption.
|
int |
addTable()
Returns the index to be used to reference the added table caption.
|
(package private) static java.lang.String |
constructAbbrPackagePlaceholderText(java.lang.String pckName) |
(package private) static java.lang.String |
constructAttributePlaceholderText(java.lang.String className,
java.lang.String attrName) |
(package private) static java.lang.String |
constructDataIndexPlaceholderText(java.lang.String pckName) |
(package private) static java.lang.String |
constructDiagramPlaceholderText(java.lang.String pckName,
java.lang.String diagName) |
(package private) static java.lang.String |
constructEnumPackagePlaceholderText(java.lang.String pckName) |
(package private) static java.lang.String |
constructFcsPackagePlaceholderText(java.lang.String pckName) |
(package private) static java.lang.String |
constructFilePlaceholderText() |
(package private) static java.lang.String |
constructLNMapPackagePlaceholderText(java.lang.String pckName) |
(package private) static java.lang.String |
constructPackagePlaceholderText(java.lang.String pckName) |
(package private) static java.lang.String |
constructPresConditionsPackagePlaceholderText(java.lang.String pckName) |
(package private) static java.lang.String |
constructTrgOpsPackagePlaceholderText(java.lang.String pckName) |
private java.lang.String |
formatErrMessage() |
private java.lang.String |
formatErrMessage(java.lang.String errorText) |
private java.lang.String |
formatModelErrMessage() |
private java.lang.String |
formatUnsupportedMessage() |
java.lang.String |
getErrorText()
Returns null if there are no parsing errors, the error message otherwise.
|
int |
getFigureCount()
Returns the last figure caption index by the current end of the range.
|
int |
getFigureCountBefore()
Returns number of figures (i.e., found captions starting with "Figure") before this
placeholder.
|
java.lang.String |
getFirstToken() |
Placeholder.Kind |
getKind() |
java.lang.String |
getReplacedText()
Returns the replacement text, as set by the user with
setReplacedText(String) . |
java.lang.String |
getSecondToken() |
static java.util.List<java.lang.String> |
getSupportedFormats() |
int |
getTableCount()
Returns the last table caption index by the current end of the range.
|
int |
getTableCountBefore()
Returns number of tables (i.e., found captions starting with "Table") before this
placeholder.
|
java.lang.String |
getText()
Returns the placeholder text.
|
void |
incrementFigureBefore()
Increments the number of figures before this placeholder.
|
void |
incrementTableBefore()
Increments the number of tables before this placeholder.
|
private void |
init(Placeholder.Kind kind,
java.lang.String name1,
java.lang.String name2,
java.lang.String error,
java.lang.String replacedText) |
private boolean |
isNullOrEmpty(java.lang.String token) |
private java.lang.String[] |
parseNames() |
void |
setReplacedText(java.lang.String replacedText)
Use this setter to track progress and status of placeholder replacement.
|
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).
|
private static final java.lang.String START_UML
private static final java.lang.String END_UML
private static final java.lang.String SEPARATOR
public static final java.lang.String PH_LETTERS
public static final java.lang.String MS_PATTERN
private static final java.lang.String UML_FILE
private static final java.lang.String UML_DIAGRAM
private static final java.lang.String UML_ATTRIBUTE
private static final java.lang.String UML_PRES_CONDITIONS
private static final java.lang.String UML_FCS
private static final java.lang.String UML_TRGOPS
private static final java.lang.String UML_ABBREVIATIONS
private static final java.lang.String UML_SCL_ENUMS
private static final java.lang.String UML_PACKAGE
private static final java.lang.String UML_LNMAP_PACKAGE
private static final java.lang.String UML_DATA_INDEX
private static final java.lang.String TOKEN_ERROR_TEXT
private static final java.lang.String PLACEHOLDER_ERROR_TEXT
private static final java.lang.String NOT_IN_MODEL_ERROR_TEXT
private final java.lang.String _text
private Placeholder.Kind _kind
private java.lang.String _firstToken
private java.lang.String _secondToken
private java.lang.String _errorText
private java.lang.String _replacedText
private int _figureCountBefore
private int _tableCountBefore
private int _myFigureCount
private int _myTableCount
public Placeholder(java.lang.String text)
public Placeholder(java.lang.String text, int figureCountBefore, int tableCountBefore)
static java.lang.String constructFilePlaceholderText()
static java.lang.String constructDiagramPlaceholderText(java.lang.String pckName, java.lang.String diagName)
static java.lang.String constructAttributePlaceholderText(java.lang.String className, java.lang.String attrName)
static java.lang.String constructPresConditionsPackagePlaceholderText(java.lang.String pckName)
static java.lang.String constructFcsPackagePlaceholderText(java.lang.String pckName)
static java.lang.String constructTrgOpsPackagePlaceholderText(java.lang.String pckName)
static java.lang.String constructAbbrPackagePlaceholderText(java.lang.String pckName)
static java.lang.String constructEnumPackagePlaceholderText(java.lang.String pckName)
static java.lang.String constructPackagePlaceholderText(java.lang.String pckName)
static java.lang.String constructLNMapPackagePlaceholderText(java.lang.String pckName)
static java.lang.String constructDataIndexPlaceholderText(java.lang.String pckName)
public static java.util.List<java.lang.String> getSupportedFormats()
private boolean isNullOrEmpty(java.lang.String token)
private void init(Placeholder.Kind kind, java.lang.String name1, java.lang.String name2, java.lang.String error, java.lang.String replacedText)
private java.lang.String formatErrMessage()
private java.lang.String formatUnsupportedMessage()
private java.lang.String formatErrMessage(java.lang.String errorText)
private java.lang.String formatModelErrMessage()
private java.lang.String[] parseNames()
public java.lang.String getText()
public Placeholder.Kind getKind()
public java.lang.String getFirstToken()
public java.lang.String getSecondToken()
public java.lang.String getErrorText()
public void updateModelErrorText()
public void setReplacedText(java.lang.String replacedText)
public int getFigureCountBefore()
public int getTableCountBefore()
public java.lang.String getReplacedText()
setReplacedText(String)
.
Initial value is null and is never changed by this class itself.public void incrementFigureBefore()
public void incrementTableBefore()
public int addFigure()
public int getFigureCount()
public int addTable()
public int getTableCount()
public java.lang.String toString()
toString
in class java.lang.Object
Copyright 2009-2015 Tatjana (Tanja) Kostic