Modifier and Type | Field and Description |
---|---|
private PropertiesDoc |
_assocEndsDoc |
private PropertiesDoc |
_attributesDoc |
private java.util.List<FigureDoc> |
_diagramDocs |
private TextDescription |
_extendedDescription |
private static org.apache.log4j.Logger |
_logger |
private PropertiesDoc |
_operationsDoc |
static java.lang.String |
OLDNAME_FMT
At present, used for some 61850 classes only (based on tagged value).
|
ANY_DA_OR_CDC_HEADING_FORMAT, CLASS_TITLE_PREFIX_FMT_CIM, CLASS_TITLE_PREFIX_FMT_IEC61850, CONDITIONS_TEXT, LN_HEADING_FORMAT, NO_ALIAS_HEADING_FORMAT, OTHER_WITH_ALIAS_HEADING_FORMAT, PRIM_DA_HEADING_FORMAT
Constructor and Description |
---|
ClassDocImpl(DocgenConfig docgenCfg,
UmlClass c,
int headingOffset)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
private static PropertiesDoc |
createAssocEndsDoc(DocgenConfig docgenCfg,
UmlClass c) |
private static PropertiesDoc |
createAttributesDoc(DocgenConfig docgenCfg,
UmlClass c) |
private static java.util.List<FigureDoc> |
createFiguresDoc(DocgenConfig docgenCfg,
UmlClass c) |
private static OperationsDoc |
createOperationsDoc(DocgenConfig docgenCfg,
UmlClass c) |
private static java.lang.String |
deduceHeadingText(UmlClass c) |
PropertiesDoc |
getAssocEndsDoc()
Returns the documentation for all the association ends on the 'other' side of this class,
suitable to be printed as a table.
|
PropertiesDoc |
getAttributesDoc()
Returns the documentation for all the attributes of this class, suitable to be printed as a
table.
|
TextDescription |
getDescription()
This default implementation returns what has been explicitly initialised in the call to the
constructor.
|
java.util.List<FigureDoc> |
getDiagramDocs()
Returns the documentation for all the diagrams of this class.
|
PropertiesDoc |
getOperationsDoc()
Returns the documentation for all the operations of this class, suitable to be printed as a
table.
|
private static boolean |
isNonDaWithinPackages(UmlClass c,
java.util.Collection<java.lang.String> pckNames) |
private TextDescription |
prependOldNameAndDeducePresenceConditionsAdditionalText(UmlClass c)
This is for 61850 presence conditions with non-machine-processable condID.
|
copyCell, copyNonEmptyCell, createDocId, filterClasses, getCell, getCells, getDocgenCfg, getHeadingText, hasKey, log, putCell, putCellNonEmpty, toSkip, toString, useHtml
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getDocgenCfg, getHeadingText
copyCell, copyNonEmptyCell, getCell, getCells, hasKey, putCell, putCellNonEmpty
private static final org.apache.log4j.Logger _logger
public static final java.lang.String OLDNAME_FMT
private final TextDescription _extendedDescription
private final PropertiesDoc _attributesDoc
private final PropertiesDoc _assocEndsDoc
private final PropertiesDoc _operationsDoc
private final java.util.List<FigureDoc> _diagramDocs
public ClassDocImpl(DocgenConfig docgenCfg, UmlClass c, int headingOffset)
docgenCfg
- c
- headingOffset
- private static java.lang.String deduceHeadingText(UmlClass c)
private TextDescription prependOldNameAndDeducePresenceConditionsAdditionalText(UmlClass c)
private static PropertiesDoc createAttributesDoc(DocgenConfig docgenCfg, UmlClass c)
private static boolean isNonDaWithinPackages(UmlClass c, java.util.Collection<java.lang.String> pckNames)
private static PropertiesDoc createAssocEndsDoc(DocgenConfig docgenCfg, UmlClass c)
private static OperationsDoc createOperationsDoc(DocgenConfig docgenCfg, UmlClass c)
private static java.util.List<FigureDoc> createFiguresDoc(DocgenConfig docgenCfg, UmlClass c)
public PropertiesDoc getAttributesDoc()
ClassDoc
PropertiesDoc.notEmpty()
to see whether there is anything to print.getAttributesDoc
in interface ClassDoc
public PropertiesDoc getAssocEndsDoc()
ClassDoc
PropertiesDoc.notEmpty()
to see whether there
is anything to print.getAssocEndsDoc
in interface ClassDoc
public PropertiesDoc getOperationsDoc()
ClassDoc
PropertiesDoc.notEmpty()
to see whether there is anything to print.getOperationsDoc
in interface ClassDoc
public java.util.List<FigureDoc> getDiagramDocs()
ClassDoc
getDiagramDocs
in interface ClassDoc
public TextDescription getDescription()
AbstractObjectDoc
getDescription
in interface ObjectDoc
getDescription
in class AbstractObjectDoc
Copyright 2009-2015 Tatjana (Tanja) Kostic