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.word |
Classes specific to writing MS documents.
|
org.tanjakostic.jcleancim.docgen.writer.xml |
Classes specific to writing IEC 61850 name space definition files.
|
Modifier and Type | Field and Description |
---|---|
private java.util.Map<Nature,java.util.Map<NamespaceInfo,java.util.Map<java.lang.String,PackageDoc>>> |
FixedFormDocumentation._nsPackageDocs |
private java.util.Map<java.lang.String,PackageDoc> |
FreeFormDocumentation._packageDocs |
Modifier and Type | Method and Description |
---|---|
PackageDoc |
FreeFormDocumentation.getPackageDoc(java.lang.String name) |
Modifier and Type | Method and Description |
---|---|
java.util.List<PackageDoc> |
PackageDoc.getChildPackageDocs()
Returns documentation for all the child packages of this package.
|
java.util.Map<Nature,java.util.Map<NamespaceInfo,java.util.Map<java.lang.String,PackageDoc>>> |
FixedFormDocumentation.getNsPackageDocs()
Returns retained scoped package docs per nature and per name space.
|
java.util.Map<java.lang.String,PackageDoc> |
FreeFormDocumentation.getPackageDocs() |
Modifier and Type | Method and Description |
---|---|
void |
DocCollector.addToFlattened(PackageDoc packageDoc)
Must be called by every newly created
PackageDoc that need not be skipped. |
void |
DocCollector.addToScoped(PackageDoc packageDoc)
Must be called by every newly created
PackageDoc that need not be skipped, if
owner is in scope and it needs to be included in the name space: adds the
packageDoc under appropriate nature and name space, no-op otherwise. |
Constructor and Description |
---|
FixedFormDocumentation(java.util.Map<Nature,java.util.Map<NamespaceInfo,java.util.Map<java.lang.String,PackageDoc>>> nsPackageDocs)
Constructor.
|
FreeFormDocumentation(ModelFinder modelFinder,
java.util.Map<java.lang.String,PackageDoc> packageDocs)
Constructor.
|
Modifier and Type | Class and Description |
---|---|
(package private) class |
PackageDocImpl
Data required for documentation of packages.
|
Modifier and Type | Field and Description |
---|---|
private java.util.List<PackageDoc> |
PackageDocImpl._childPackageDocs |
private java.util.Map<java.lang.String,PackageDoc> |
DocCollectorImpl._modelPackageDocs
Model package docs are indexed, the individual package docs contain their children
recursively; we use this map for logging only.
|
private java.util.Map<Nature,java.util.Map<NamespaceInfo,java.util.Map<java.lang.String,java.util.List<PackageDoc>>>> |
DocCollectorImpl._nonSkippedNsPackageDocs
"Categorised" docs for all retained packages.
|
private java.util.Map<java.lang.String,java.util.List<PackageDoc>> |
DocCollectorImpl._nonSkippedPackageDocs
"Flattenned" docs for all retained packages.
|
Modifier and Type | Method and Description |
---|---|
private java.util.Map<java.lang.String,PackageDoc> |
DocCollectorImpl.buildPackageDocs(DocgenConfig docgenCfg,
java.util.Collection<UmlPackage> modelPackages)
Builds recursively package docs for
modelPackages ; every instance will add
itself with DocCollectorImpl.addToFlattened(PackageDoc) method to flattened map, and with
DocCollectorImpl.addToScoped(PackageDoc) to scoped mapd of retained packages. |
java.util.List<PackageDoc> |
PackageDocImpl.getChildPackageDocs() |
(package private) java.util.Map<java.lang.String,PackageDoc> |
DocCollectorImpl.getModelPackageDocs()
Returns package docs for all
UmlPackage.Kind.MODEL
packages from the UML model, indexed by the
UmlPackage.Kind.MODEL package name. |
(package private) java.util.Map<Nature,java.util.Map<NamespaceInfo,java.util.Map<java.lang.String,java.util.List<PackageDoc>>>> |
DocCollectorImpl.getNonSkippedNsPackageDocs() |
(package private) java.util.Map<java.lang.String,java.util.List<PackageDoc>> |
DocCollectorImpl.getNonSkippedPackageDocs() |
private java.util.Map<Nature,java.util.Map<NamespaceInfo,java.util.Map<java.lang.String,PackageDoc>>> |
DocCollectorImpl.removeNsDuplicates() |
private static java.util.Map<java.lang.String,PackageDoc> |
DocCollectorImpl.selectWithoutDuplicates(java.util.Map<java.lang.String,java.util.List<PackageDoc>> all)
This is one final result, where the
DocCollectorImpl._nonSkippedPackageDocs is filtered by retaining
only one package doc per name. |
Modifier and Type | Method and Description |
---|---|
void |
DocCollectorImpl.addToFlattened(PackageDoc packageDoc) |
void |
DocCollectorImpl.addToScoped(PackageDoc packageDoc) |
Modifier and Type | Method and Description |
---|---|
private static java.util.Map<java.lang.String,PackageDoc> |
DocCollectorImpl.selectWithoutDuplicates(java.util.Map<java.lang.String,java.util.List<PackageDoc>> all)
This is one final result, where the
DocCollectorImpl._nonSkippedPackageDocs is filtered by retaining
only one package doc per name. |
Modifier and Type | Field and Description |
---|---|
private java.util.Map<java.lang.String,PackageDoc> |
WordWriterInput._packageDocs |
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,PackageDoc> |
WordWriterInput.getPackageDocs()
Returns "flattened" map of package documentation instances, with package name as key (to
allow to quickly find the package name from what is read in the placeholder).
|
Modifier and Type | Method and Description |
---|---|
Cursor<O> |
WordWriter.writeAbbrTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writeAbbrTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
WordWriter.writeDataIndex(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writeDataIndex(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
WordWriter.writeFcTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writeFcTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
WordWriter.writeLnMapPackage(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writeLnMapPackage(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
WordWriter.writePackage(Cursor<O> initCursor,
PackageDoc doc,
boolean isRoot)
Writes all related to a package.
|
Cursor<O> |
AbstractWordWriter.writePackage(Cursor<O> initCursor,
PackageDoc doc,
boolean isRoot) |
Cursor<O> |
WordWriter.writePresCondTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writePresCondTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
WordWriter.writeSclEnum(Cursor<O> cursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writeSclEnum(Cursor<O> cursor,
PackageDoc packageDoc) |
Cursor<O> |
WordWriter.writeTrgOpTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writeTrgOpTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Constructor and Description |
---|
WordWriterInput(Config cfg,
java.lang.String appVersion,
boolean skipTiming,
java.lang.String modelFileName,
java.util.Map<java.lang.String,PackageDoc> packageDocs,
ModelFinder finder,
java.lang.String inTemplatePath,
java.lang.String outFilePath,
boolean useBinaryDoc,
boolean introToFigureBefore,
int saveRecloseEvery,
boolean isDeep) |
WordWriterInput(java.lang.String appVersion,
java.lang.String modelFileName,
boolean skipTiming,
java.util.Map<java.lang.String,PackageDoc> packageDocs,
ModelFinder finder,
java.lang.String inTemplatePath,
java.lang.String outFilePath,
boolean useBinaryDoc,
boolean introToFigureBefore,
int saveRecloseEvery,
boolean isDeep)
Constructor, useful to create an instance if you don't have configuration.
|
Modifier and Type | Method and Description |
---|---|
(package private) org.w3c.dom.Element |
WAXWriter.addPackage(org.w3c.dom.Element sel,
org.w3c.dom.Element del,
PackageDoc pDoc)
Adds package element with all its contents, recursively, to
sel and returns the
new element. |
private org.w3c.dom.Element |
WAXWriter.addPackage61850(org.w3c.dom.Element sel,
org.w3c.dom.Element del,
PackageDoc pDoc)
Adds 61850-specific package element to
sel and returns the new element. |
private org.w3c.dom.Element |
WAXWriter.addPackageCommon(org.w3c.dom.Element sel,
org.w3c.dom.Element del,
PackageDoc pDoc)
Adds UML package commons element to
sel and returns the package element. |
Modifier and Type | Method and Description |
---|---|
private void |
WAXWriter.addCimNamespaces(java.util.Map<NamespaceInfo,java.util.Map<java.lang.String,PackageDoc>> namespaces) |
private void |
WAXWriter.addIec61850Namespaces(java.util.Map<NamespaceInfo,java.util.Map<java.lang.String,PackageDoc>> namespaces) |
Copyright 2009-2015 Tatjana (Tanja) Kostic