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.word.doc |
Classes specific to writing MS documents by means of automation API through Java-COM bridge (Jacob); this implementation is
extremely slow (it requires MS Word application and the COM API is just slow), but it supports
both .doc and .docx MS Word formats.
|
org.tanjakostic.jcleancim.docgen.writer.word.docx |
Classes specific to writing MS documents in OpenXML format; this implementation is fast (it does
not require MS Word application), but it supports only .docx MS Word format.
|
org.tanjakostic.jcleancim.docgen.writer.xml |
Classes specific to writing IEC 61850 name space definition files.
|
Modifier and Type | Method and Description |
---|---|
PropertiesDoc |
PackageDoc.getAbbrPackageDoc() |
PropertiesDoc |
ClassDoc.getAssocEndsDoc()
Returns the documentation for all the association ends on the 'other' side of this class,
suitable to be printed as a table.
|
PropertiesDoc |
ClassDoc.getAttributesDoc()
Returns the documentation for all the attributes of this class, suitable to be printed as a
table.
|
PropertiesDoc |
PackageDoc.getDataIndexDoc() |
PropertiesDoc |
PackageDoc.getFcPackageDoc() |
PropertiesDoc |
PackageDoc.getLnMapPackageDoc() |
PropertiesDoc |
ClassDoc.getOperationsDoc()
Returns the documentation for all the operations of this class, suitable to be printed as a
table.
|
PropertiesDoc |
PackageDoc.getPresCondPackageDoc() |
PropertiesDoc |
PackageDoc.getTrgOpPackageDoc() |
Modifier and Type | Class and Description |
---|---|
(package private) class |
AbbrPackageDoc
Data required for documentation of abbreviations for IEC61850-7-4.
|
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 |
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.
|
(package private) class |
FcPackageDoc
Data required for documentation of functional constraints for IEC61850-7-2 and IEC61850-7-3.
|
(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 |
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 PropertiesDoc |
PackageDocImpl._abbrPackageDoc |
private PropertiesDoc |
ClassDocImpl._assocEndsDoc |
private PropertiesDoc |
ClassDocImpl._attributesDoc |
private PropertiesDoc |
PackageDocImpl._dataIndexDoc |
private PropertiesDoc |
PackageDocImpl._fcPackageDoc |
private PropertiesDoc |
PackageDocImpl._lnMapPackageDoc |
private PropertiesDoc |
ClassDocImpl._operationsDoc |
private PropertiesDoc |
PackageDocImpl._presCondPackageDoc |
private PropertiesDoc |
PackageDocImpl._trgOpPackageDoc |
Modifier and Type | Method and Description |
---|---|
int |
WordHelper.insertTable(Range<O> range,
PropertiesDoc doc,
Style tabhead) |
Cursor<O> |
WordWriter.writeProperties(Cursor<O> initCursor,
PropertiesDoc doc)
Writes a set of properties as a table at the end of range in
cursor . |
Cursor<O> |
AbstractWordWriter.writeProperties(Cursor<O> initCursor,
PropertiesDoc doc) |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
DocWordWriter.asCsv(PropertiesDoc doc,
java.lang.String cellSep) |
private static com.jacob.com.Dispatch |
DocWordWriter.createTable(Range<com.jacob.com.Dispatch> range,
PropertiesDoc doc) |
private int |
DocWordWriter.doInsertTable(Range<com.jacob.com.Dispatch> range,
PropertiesDoc doc,
Style tabhead) |
private void |
DocWordWriter.fillValues(com.jacob.com.Dispatch table,
com.jacob.com.Dispatch app,
PropertiesDoc doc) |
private void |
DocWordWriter.formatTable(com.jacob.com.Dispatch table,
PropertiesDoc doc,
Style tabhead,
org.apache.log4j.Level level) |
int |
DocWordWriter.insertTable(Range<com.jacob.com.Dispatch> range,
PropertiesDoc doc,
Style tabhead) |
Modifier and Type | Method and Description |
---|---|
private int |
DocxWordWriter.doInsertTable(Range<java.lang.Object> range,
PropertiesDoc doc,
Style tabhead) |
int |
DocxWordWriter.insertTable(Range<java.lang.Object> range,
PropertiesDoc doc,
Style tabhead) |
Modifier and Type | Method and Description |
---|---|
private org.w3c.dom.Element |
WAXWriter.add61850SpecialPackageAsTable(org.w3c.dom.Element par,
org.w3c.dom.Element del,
java.lang.String tagName,
PropertiesDoc ppDoc)
Adds package-as-properties table to
par and returns the new element; we have 4
of them with the same structure, only the tag names differ. |
private org.w3c.dom.Element |
WAXWriter.addAssociationEnds(org.w3c.dom.Element sel,
org.w3c.dom.Element del,
PropertiesDoc ppDoc) |
private org.w3c.dom.Element |
WAXWriter.addAssociationEnds61850(org.w3c.dom.Element sel,
org.w3c.dom.Element del,
PropertiesDoc ppDoc) |
private org.w3c.dom.Element |
WAXWriter.addAttributes(org.w3c.dom.Element sel,
org.w3c.dom.Element del,
PropertiesDoc ppDoc) |
private org.w3c.dom.Element |
WAXWriter.addLiterals(org.w3c.dom.Element sel,
org.w3c.dom.Element del,
PropertiesDoc ppDoc) |
private org.w3c.dom.Element |
WAXWriter.addOperations(org.w3c.dom.Element sel,
org.w3c.dom.Element del,
PropertiesDoc ppDoc) |
Copyright 2009-2015 Tatjana (Tanja) Kostic