Package | Description |
---|---|
org.tanjakostic.jcleancim |
jCleanCim is an open source tool for validation and documentation generation from Enterprise
Architect CIM and IEC61850 UML models.
|
org.tanjakostic.jcleancim.builder | |
org.tanjakostic.jcleancim.builder.ea |
Classes responsible for building in-memory UML model from EA repository (.eap model file).
|
org.tanjakostic.jcleancim.builder.ea.db | |
org.tanjakostic.jcleancim.builder.ea.japi | |
org.tanjakostic.jcleancim.builder.ea.sqlxml | |
org.tanjakostic.jcleancim.common |
Classes commonly used by several packages.
|
org.tanjakostic.jcleancim.docgen | |
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.util | |
org.tanjakostic.jcleancim.validation |
Classes responsible for validating the model and the rules to apply.
|
Modifier and Type | Method and Description |
---|---|
UmlModel |
JCleanCim.buildFromEA()
Builds the model from EA file given in configuration or on command line.
|
UmlModel |
JCleanCim.buildFromProfiles()
Builds the model from all profiles found under the /input/profiles directory.
|
UmlModel |
JCleanCim.createEmptyModel()
Creates empty model.
|
void |
JCleanCim.generateDoc(UmlModel model)
Generates documentation for the model in the format specified in configuration through output
file extension.
|
static void |
JCleanCim.main(java.lang.String[] args)
This command-line application first populates its model from full .eap file and/or profiles
(to allow for different kinds of analysis afterwards), then selectively runs validation,
statistics, profile-model cross-checking and MS Word document generation.
|
Constructor and Description |
---|
JCleanCim(java.lang.String[] args)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
UmlModel |
ModelBuilder.build()
Builds the in-memory model.
|
abstract UmlModel |
AbstractModelBuilder.build() |
private static java.io.File |
AbstractXMIExporter.createOutputFileWithBackup(java.lang.String fileName) |
void |
XMIExporter.exportToXMIs(java.lang.String rootUuid)
Actually performs export for all the configured dialects.
|
void |
AbstractXMIExporter.exportToXMIs(java.lang.String rootUuid) |
protected abstract void |
AbstractXMIExporter.toXmi(java.lang.String rootUuid,
XMIDialect dialect,
boolean exportDiagrams,
java.io.File file,
java.lang.String detail)
Actual export to XMI.
|
Modifier and Type | Method and Description |
---|---|
protected static void |
EaModelBuilder.assertModelNotEmptyWarnIfMultipleRoots(int count) |
UmlModel |
EaModelBuilder.build()
Builds the in-memory model.
|
protected abstract void |
EaModelBuilder.bulkLoad() |
private void |
EaModelBuilder.closeModel() |
protected abstract void |
EaModelBuilder.closeRepo() |
protected abstract P |
EaModelBuilder.getFirstRoot() |
private void |
EaModelBuilder.openModel() |
protected abstract void |
EaModelBuilder.openRepo(java.lang.String modelFileAbsPath) |
private java.lang.String |
EaModelBuilder.populateBuilders()
Creates the in-memory builders with the data from EA repository and returns the UUID of the
model root (needed for XMI export, if enabled by configuration).
|
java.util.List<java.util.Map<java.lang.String,java.lang.String>> |
EaSelector.select(java.lang.String tableName,
java.lang.String[] columnNames,
boolean skipTiming)
Select
columnNames from tableName . |
Constructor and Description |
---|
EaTables(EaSelector selector,
boolean skipTiming)
Constructor; loads all the relevant content from the repository into simple data structures
(maps).
|
Modifier and Type | Method and Description |
---|---|
protected void |
DbModelBuilder.bulkLoad() |
void |
DbRepo.close() |
protected void |
DbModelBuilder.closeRepo() |
protected java.util.Map<java.lang.String,java.lang.String> |
DbModelBuilder.getFirstRoot() |
com.healthmarketscience.jackcess.Table |
DbRepo.getTable(java.lang.String tableName) |
void |
DbRepo.open(java.lang.String modelFileAbsPath) |
protected void |
DbModelBuilder.openRepo(java.lang.String modelFileAbsPath) |
java.util.List<java.util.Map<java.lang.String,java.lang.String>> |
DbSelector.select(java.lang.String tableName,
java.lang.String[] columnNames,
boolean skipTiming) |
Modifier and Type | Method and Description |
---|---|
void |
JapiRepo.close() |
protected void |
JapiModelBuilder.closeRepo() |
protected org.sparx.Package |
JapiModelBuilder.getFirstRoot() |
Modifier and Type | Method and Description |
---|---|
protected void |
SqlXmlModelBuilder.bulkLoad() |
protected void |
SqlXmlModelBuilder.closeRepo() |
protected java.util.Map<java.lang.String,java.lang.String> |
SqlXmlModelBuilder.getFirstRoot() |
Modifier and Type | Method and Description |
---|---|
private java.lang.String |
Config.initBlankPngFileAbsPath(java.lang.String blankPngFileName) |
private static java.lang.String |
Config.initInFileAbsPath(java.lang.String inFileName,
java.lang.String detail) |
private java.lang.String |
Config.initModelFileAbsPath(java.lang.String modelFilename,
java.lang.String propertyKey)
Initialises model file name trying first the argument
modelFilename , then the
one in propertyKey . |
private static java.io.File |
Config.initOutFile(java.lang.String outDirName,
java.lang.String outFileName,
java.lang.String detail) |
Constructor and Description |
---|
Config(java.util.Properties props,
java.lang.String modelFilename)
Constructor; useful for testing.
|
Config(java.lang.String propsFilename,
java.lang.String modelFilename)
Constructor.
|
Config(java.lang.String propsFilename,
java.lang.String modelFilename,
java.util.Properties props) |
Modifier and Type | Class and Description |
---|---|
class |
UnsupportedInputFormatException
Used when the format for input document is a non-supported one.
|
class |
UnsupportedOutputFormatException
Used when the format for output document is a non-supported one.
|
Modifier and Type | Method and Description |
---|---|
private static void |
DocWordWriter.pasteFromClipboard(com.jacob.com.Dispatch range) |
private static void |
DocWordWriter.pasteHtmlFromClipboard(com.jacob.com.Dispatch range) |
Modifier and Type | Method and Description |
---|---|
static void |
Util.clearClipboard()
Clears system clipboard.
|
static java.lang.String |
Util.fetchTextFromClipboard()
Returns text contained in the clipboard (text could be plain or markup), null if clipboard is
empty.
|
private static java.io.File |
Util.findResource(java.lang.String resourceName,
java.lang.String detail) |
static java.io.File |
Util.getOutputFileRenameIfExists(java.lang.String outDirName,
java.lang.String outFileName)
|
static java.lang.String |
Util.getResourceAbsPath(java.lang.String resourceName,
java.lang.String detail)
Returns absolute path of the resource found on the classpath.
|
Modifier and Type | Method and Description |
---|---|
(package private) java.io.File |
ModelValidator.deduceReportFilepath(Config cfg) |
Copyright 2009-2015 Tatjana (Tanja) Kostic