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 |
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 | 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 |
---|---|
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.
|
class |
EntryDocImpl
Single property entry (row with values).
|
class |
FigureDocImpl
Data required for documentation of diagrams.
|
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 all)
Fills
outRawData with value for the key
"deducedTypeText" and, if enabled (
all=true ) and where they exist, values for keys
"type" and
"typeKind". |
protected void |
Attributes61850Doc.deduceTypeTextForDataIndex(UmlClass mmType,
RawData outRawData)
Similar to
Attributes61850Doc.deduceTypeText(UmlClass, RawData, boolean, boolean) , with third argument
set to false , and taking care of the transient CDC attributes when writing data
index for LNs. |
protected static void |
Attributes61850Doc.fillPresenceConditionAndArgs(RawData entry,
PresenceCondition pc,
boolean isInherited,
java.lang.String context)
Fills appropriately raw data
WAX.A_presCond , WAX.A_presCondArgs ,
WAX.A_presCondArgsID and WAX.A_cond . |
protected static void |
Attributes61850Doc.fillPresenceConditionAndArgs(RawData entry,
PresenceCondition pc,
boolean isInherited,
java.lang.String context,
boolean isDerivedStats)
Fills appropriately raw data
WAX.A_presCond , WAX.A_presCondArgs ,
WAX.A_presCondArgsID and WAX.A_cond if isDerivedStats=false ,
otherwise WAX.A_dsPresCond , WAX.A_dsPresCondArgs ,
WAX.A_dsPresCondArgsID and WAX.A_dsCond . |
Copyright 2009-2016 Tatjana (Tanja) Kostic