class PackageDocImpl extends AbstractObjectDoc implements PackageDoc
PackageDoc
.Modifier and Type | Field and Description |
---|---|
private PropertiesDoc |
_abbrPackageDoc |
private java.util.List<PackageDoc> |
_childPackageDocs |
private java.util.List<ClassDoc> |
_classDocs |
private PropertiesDoc |
_dataIndexDoc |
private PackageScl |
_enumsPackageScl |
private PropertiesDoc |
_fcPackageDoc |
private java.util.List<FigureDoc> |
_figureDocs |
private java.lang.String |
_genHeadingText |
private PropertiesDoc |
_lnMapPackageDoc |
private static org.apache.log4j.Logger |
_logger |
private java.lang.String |
_modelName |
private Nature |
_nature |
private NamespaceInfo |
_nsInfo |
private java.lang.String |
_packageName |
private PropertiesDoc |
_presCondPackageDoc |
private PropertiesDoc |
_trgOpPackageDoc |
static java.lang.String |
LNPKG_HEADING_FORMAT |
private static boolean |
NEW_SIMPLE_LNPCK_NAME |
HANGING_PARA_TITLE
Modifier | Constructor and Description |
---|---|
(package private) |
PackageDocImpl(DocgenConfig docgenCfg,
UmlPackage pckage,
DocCollector collector)
Constructor, to be called on model package.
|
private |
PackageDocImpl(DocgenConfig docgenCfg,
UmlPackage pckage,
DocCollector collector,
java.lang.String modelName,
int headingOffset) |
Modifier and Type | Method and Description |
---|---|
PropertiesDoc |
createAbbrPackageDoc(UmlPackage pckage) |
PropertiesDoc |
createDataIndexDoc(UmlPackage pckage) |
PackageScl |
createEnumsPackageScl(UmlPackage pckage) |
PropertiesDoc |
createFcPackageDoc(UmlPackage pckage) |
static java.lang.String |
createHeadingText(DocgenConfig docgenCfg,
UmlPackage pckage) |
PropertiesDoc |
createLnMapDoc(UmlPackage pckage) |
PropertiesDoc |
createPresCondPackageDoc(UmlPackage pckage) |
PropertiesDoc |
createTrgOpPackageDoc(UmlPackage pckage) |
private static java.lang.String |
deduce61850PackageKind(DocgenConfig docgenCfg,
UmlPackage pckage) |
PropertiesDoc |
getAbbrPackageDoc() |
java.util.List<PackageDoc> |
getChildPackageDocs()
Returns documentation for all the child packages of this package.
|
java.util.List<ClassDoc> |
getClassDocs()
Returns documentation for all the classes in this package.
|
PropertiesDoc |
getDataIndexDoc() |
PackageScl |
getEnumsPackageScl() |
PropertiesDoc |
getFcPackageDoc() |
java.util.List<FigureDoc> |
getFigureDocs()
Returns documentation for all the figures in this package.
|
java.lang.String |
getGenHeadingText()
To avoid hanging paragraphs (i.e., those with some text but without title), ensure to include
a "general" heading and print the doc and diagrams of the package under it.
|
PropertiesDoc |
getLnMapPackageDoc() |
java.lang.String |
getModelName()
Returns name of the model package (the one with nature) to which it belongs.
|
NamespaceInfo |
getNamespaceInfo()
Returns name space information if it is defined for the package, null otherwise.
|
Nature |
getNature()
Returns nature of the package.
|
java.lang.String |
getPackageName()
Returns the name of the package.
|
PropertiesDoc |
getPresCondPackageDoc() |
PropertiesDoc |
getTrgOpPackageDoc() |
private NamespaceInfo |
initNamespace(DocgenConfig docgenCfg,
UmlPackage pckage) |
copyCell, copyNonEmptyCell, createDocId, filterClasses, getCell, getCells, getDescription, getDocgenCfg, getHeadingText, hasKey, log, putCell, putCellNonEmpty, toSkip, toString, useHtml
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getDescription, getDocgenCfg, getHeadingText
copyCell, copyNonEmptyCell, getCell, getCells, hasKey, putCell, putCellNonEmpty
private static final org.apache.log4j.Logger _logger
private final java.lang.String _packageName
private final NamespaceInfo _nsInfo
private final java.lang.String _modelName
private final Nature _nature
private final java.lang.String _genHeadingText
private final java.util.List<FigureDoc> _figureDocs
private final java.util.List<ClassDoc> _classDocs
private final java.util.List<PackageDoc> _childPackageDocs
private final PropertiesDoc _dataIndexDoc
private final PropertiesDoc _lnMapPackageDoc
private final PropertiesDoc _presCondPackageDoc
private final PropertiesDoc _fcPackageDoc
private final PropertiesDoc _trgOpPackageDoc
private final PropertiesDoc _abbrPackageDoc
private final PackageScl _enumsPackageScl
private static final boolean NEW_SIMPLE_LNPCK_NAME
public static java.lang.String LNPKG_HEADING_FORMAT
PackageDocImpl(DocgenConfig docgenCfg, UmlPackage pckage, DocCollector collector)
docgenCfg
- pckage
- collector
- private PackageDocImpl(DocgenConfig docgenCfg, UmlPackage pckage, DocCollector collector, java.lang.String modelName, int headingOffset)
private NamespaceInfo initNamespace(DocgenConfig docgenCfg, UmlPackage pckage)
private static java.lang.String deduce61850PackageKind(DocgenConfig docgenCfg, UmlPackage pckage)
public static java.lang.String createHeadingText(DocgenConfig docgenCfg, UmlPackage pckage)
public PropertiesDoc createDataIndexDoc(UmlPackage pckage)
public PropertiesDoc createFcPackageDoc(UmlPackage pckage)
public PropertiesDoc createTrgOpPackageDoc(UmlPackage pckage)
public PropertiesDoc createPresCondPackageDoc(UmlPackage pckage)
public PropertiesDoc createAbbrPackageDoc(UmlPackage pckage)
public PropertiesDoc createLnMapDoc(UmlPackage pckage)
public PackageScl createEnumsPackageScl(UmlPackage pckage)
public java.lang.String getPackageName()
PackageDoc
getPackageName
in interface PackageDoc
public NamespaceInfo getNamespaceInfo()
PackageDoc
getNamespaceInfo
in interface PackageDoc
public java.lang.String getModelName()
PackageDoc
getModelName
in interface PackageDoc
public Nature getNature()
PackageDoc
getNature
in interface PackageDoc
public java.lang.String getGenHeadingText()
PackageDoc
getGenHeadingText
in interface PackageDoc
public java.util.List<FigureDoc> getFigureDocs()
PackageDoc
getFigureDocs
in interface PackageDoc
public java.util.List<ClassDoc> getClassDocs()
PackageDoc
getClassDocs
in interface PackageDoc
public java.util.List<PackageDoc> getChildPackageDocs()
PackageDoc
getChildPackageDocs
in interface PackageDoc
public PropertiesDoc getDataIndexDoc()
getDataIndexDoc
in interface PackageDoc
public PropertiesDoc getLnMapPackageDoc()
getLnMapPackageDoc
in interface PackageDoc
public PropertiesDoc getPresCondPackageDoc()
getPresCondPackageDoc
in interface PackageDoc
public PropertiesDoc getFcPackageDoc()
getFcPackageDoc
in interface PackageDoc
public PropertiesDoc getTrgOpPackageDoc()
getTrgOpPackageDoc
in interface PackageDoc
public PropertiesDoc getAbbrPackageDoc()
getAbbrPackageDoc
in interface PackageDoc
public PackageScl getEnumsPackageScl()
getEnumsPackageScl
in interface PackageDoc
Copyright 2009-2015 Tatjana (Tanja) Kostic