Package | Description |
---|---|
org.tanjakostic.jcleancim.docgen.collector |
This package defines interfaces and classes responsible for collecting documentation and figures
from the UML model, or freely initialised through the API without any UML model.
|
org.tanjakostic.jcleancim.docgen.collector.impl | |
org.tanjakostic.jcleancim.docgen.writer.xml |
Classes specific to writing IEC 61850 name space definition files.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ClassDoc
Data required for documentation of classes.
|
interface |
EntryDoc
Record (table row) representation of an object.
|
interface |
FigureDoc
Data required for documentation of figures.
|
interface |
ObjectDoc
Interface common to most kinds of documentation for the model.
|
interface |
PackageDoc
Data required for documentation of packages; documentation includes classes and sub-packages.
|
interface |
PropertiesDoc
Set of methods to allow table generation for constituents.
|
Modifier and Type | Class and Description |
---|---|
class |
AGSpec
Specific to IEC 61850 tables for logical nodes and common data classes, this simple data
structure holds definition for a valid group.
|
class |
ColumnSpec
Column specification.
|
class |
RawDataImpl
Default implementation.
|
Modifier and Type | Field and Description |
---|---|
private RawData |
ColumnSpec._rawData |
private RawData |
AGSpec._rawData |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
RawDataImpl.copyCell(RawData src,
java.lang.String key) |
java.lang.String |
RawData.copyCell(RawData src,
java.lang.String key)
Copies value for
key existing in src , into this provider; no-op if
src does not contain the key . |
java.lang.String |
ColumnSpec.copyCell(RawData src,
java.lang.String key) |
java.lang.String |
AGSpec.copyCell(RawData src,
java.lang.String key) |
java.lang.String |
RawDataImpl.copyNonEmptyCell(RawData src,
java.lang.String key) |
java.lang.String |
RawData.copyNonEmptyCell(RawData src,
java.lang.String key)
Copies non-empty value for
key existing in src , into this provider;
no-op if src does not contain the key , or if it contains the
key but the value for that key is empty. |
java.lang.String |
ColumnSpec.copyNonEmptyCell(RawData src,
java.lang.String key) |
java.lang.String |
AGSpec.copyNonEmptyCell(RawData src,
java.lang.String key) |
Modifier and Type | Class and Description |
---|---|
(package private) class |
AbbrPackageDoc
Data required for documentation of abbreviations for IEC61850-7-4.
|
class |
AbstractObjectDoc
Common implementation for any kind of object documentation.
|
class |
AbstractPropertiesDoc
Common implementation for properties documentation (table).
|
class |
Attributes61850Doc
Holds the utility method to filter groups which may stay with no members after applying
configuration filters (e.g., a class actually inherits from another class, but another class is
informative, and we don't want informative stuff printed), and some common formatting.
|
(package private) class |
CdcAttributesDoc
Data required for documentation of common data class attributes, for IEC61850-7-3.
|
(package private) class |
ClassDocImpl
Data required for documentation of classes.
|
(package private) class |
CustomAssocEndsDoc
Data required for documentation of IEC 61850 association ends of the class with the other end
class; applicable to meta-model classes only.
|
(package private) class |
CustomLiteralsDoc
Data required for documentation of enumeration literals in custom format, as used for literals
with integer values in tables in IEC61850-7-4 and IEC61850-7-3.
|
(package private) class |
DaAttributesDoc
Data required for documentation of constructed data attributes, for IEC61850-7-3.
|
(package private) class |
DataIndexDoc
Data required for documentation of all attributes of a package as a data index (required for
IEC61850, but can be used for CIM as well).
|
(package private) class |
DefaultAssocEndsDoc
Data required for documentation of association ends of the class with the other end class.
|
(package private) class |
DefaultAttributesDoc
Documentation for attributes in simple format.
|
(package private) class |
DefaultLiteralsDoc
Data required for documentation of enumeration literals with the middle column for codes, as used
for CIM.
|
class |
EntryDocImpl
Single property entry (row with values).
|
(package private) class |
FcPackageDoc
Data required for documentation of functional constraints for IEC61850-7-2 and IEC61850-7-3.
|
class |
FigureDocImpl
Data required for documentation of diagrams.
|
(package private) class |
LnAttributesDoc
Data required for documentation of logical node attributes, for IEC61850-7-4.
|
(package private) class |
LnMapPackageDoc
Data required for documentation of all attributes of a package as a data index (used for IEC61850
only).
|
(package private) class |
OperationsDoc
Data required for documentation of operations.
|
(package private) class |
PackageDocImpl
Data required for documentation of packages.
|
(package private) class |
PresCondPackageDoc
Data required for documentation of presence conditions for IEC61850-7-3.
|
(package private) class |
TrgOpPackageDoc
Data required for documentation of trigger options for IEC61850-7-2.
|
Modifier and Type | Field and Description |
---|---|
private RawData |
EntryDocImpl._rawData |
private RawData |
AbstractObjectDoc._rawData |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
EntryDocImpl.copyCell(RawData src,
java.lang.String key) |
java.lang.String |
AbstractObjectDoc.copyCell(RawData src,
java.lang.String key) |
java.lang.String |
EntryDocImpl.copyNonEmptyCell(RawData src,
java.lang.String key) |
java.lang.String |
AbstractObjectDoc.copyNonEmptyCell(RawData src,
java.lang.String key) |
protected void |
Attributes61850Doc.deduceTypeText(UmlClass mmType,
RawData outRawData,
boolean showTorENUM,
boolean trimPrimitivePrefix,
boolean all)
Fills
outRawData with value for
"deducedTypeText"; and
"type" and
"typeKind" keys if enabled (
all=true ) and where they exist. |
protected static void |
Attributes61850Doc.fillPresenceConditionAndArgs(RawData entry,
PresenceCondition pc,
boolean isInherited,
java.lang.String context)
Fills appropriately raw data 'presCond', 'presCondArgs', 'presCondArgsID' and 'cond'.
|
protected static void |
Attributes61850Doc.fillPresenceConditionAndArgs(RawData entry,
PresenceCondition pc,
boolean isInherited,
java.lang.String context,
boolean isDerivedStats)
Fills appropriately raw data 'presCond', 'presCondArgs', 'presCondArgsID' and 'cond' if
isDerivedStats=false , otherwise 'dsPresCond', 'dsPresCondArgs',
'dsPresCondArgsID' and 'dsCond'. |
private static void |
DaAttributesDoc.initBdaRawData(EntryDocImpl entry,
UmlAttribute a,
boolean isInherited,
RawData values,
PresenceCondition pc,
java.lang.String context) |
private static void |
LnAttributesDoc.initDoRawData(RawData entry,
RawData values,
PresenceCondition pc,
boolean isInherited,
PresenceCondition dsPc,
java.lang.String context) |
private static void |
CdcAttributesDoc.initFcdaRawData(RawData entry,
UmlAttribute a,
boolean isInherited,
RawData src,
PresenceCondition pc) |
private void |
LnAttributesDoc.initRawFromSplitTypeName(RawData values,
UmlAttribute attr)
Sets value for keys "name", "trans",
"typeText"; and if applicable, for
"transient",
"type", and those as potentially set
by
Attributes61850Doc.deduceTypeText(UmlClass, RawData, boolean, boolean, boolean) . |
private void |
CdcAttributesDoc.initValuesFromSplitTypeName(RawData values,
UmlAttribute a)
|
Modifier and Type | Method and Description |
---|---|
private org.w3c.dom.Element |
WAXWriter.addAssociationEndCommon(org.w3c.dom.Element sel,
org.w3c.dom.Element del,
RawData eDoc) |
(package private) static org.w3c.dom.Element |
WAXWriter.addAttr(org.w3c.dom.Element par,
java.lang.String tag,
RawData data)
Adds to
el new attribute with tag used as key for value in data . |
private org.w3c.dom.Element |
WAXWriter.addAttribute(org.w3c.dom.Element sel,
org.w3c.dom.Element del,
RawData eDoc) |
(package private) static org.w3c.dom.Element |
WAXWriter.addAttrOpt(org.w3c.dom.Element par,
java.lang.String tag,
RawData data)
|
(package private) org.w3c.dom.Element |
WAXWriter.addAttrWithElemInDoc(org.w3c.dom.Element par,
java.lang.String tag,
RawData data,
org.w3c.dom.Element del,
java.lang.String docValueKey)
Adds to
par a new attribute with tag and its value from data , and
to del the corresponding doc element (value is the translatable doc, obtained
from data with docValueKey as key). |
(package private) org.w3c.dom.Element |
WAXWriter.addAttrWithElemInDocOpt(org.w3c.dom.Element par,
java.lang.String tag,
RawData data,
org.w3c.dom.Element del,
java.lang.String docValueKey)
If the value in
data for key docValueKey has content (translatable
documentation), calls
WAXWriter.addAttrWithElemInDoc(Element, String, RawData, Element, String) , otherwise no-op. |
(package private) org.w3c.dom.Element |
WAXWriter.addDiagram(org.w3c.dom.Element sel,
org.w3c.dom.Element del,
RawData dDoc)
Returns new diagram element.
|
private org.w3c.dom.Element |
WAXWriter.addTable(org.w3c.dom.Element sel,
org.w3c.dom.Element del,
RawData ppDoc,
java.lang.String tagName) |
(package private) org.w3c.dom.Element |
WAXWriter.addUmlObject(org.w3c.dom.Element par,
org.w3c.dom.Element del,
RawData oDoc) |
(package private) static org.w3c.dom.Element |
WAXWriter.addXAttrIfTrue(org.w3c.dom.Element par,
java.lang.String tag,
RawData data)
Calls
WAXWriter.addAttr(Element, String, RawData) if value obtained from data
with tag as key is true , otherwise no-op. |
Copyright 2009-2015 Tatjana (Tanja) Kostic