public class Config
extends java.lang.Object
Files
Input files are mainly expected to be available in any place that is on the classpath. By
convention, we configure the directory input
under the project root to be on the
classpath (implementation note: we simply search for input files as resources that must be on the
classpath, and we set the classpath to include directory input
; this eliminates the
need for absolute paths). The application never modifies anything under input
directory. Files searched on the classpath are for instance model file
"model.filename", XML schema for document
generation (defined only as default: "IECDomain.xsd"), or MS Word
templace file KEY_DOCGEN_WORD_IN_TEMPLATE
.
Output files are created in a separate directory, "output", under the
current execution path obtained with the Java system property
"user.dir". If such a directory is not available,
like in case of a fresh installation, it gets automatically created (implementation note: using
the Java system property "user.dir" ensures that
the "home" for "output" directory will be under the project root directory when
you run jCleanCim application, and under test
directory when you run tests).
The constructor of this class completes all the tricks related to files, both input and output, and once it completed successfully, it is sure that all the file absolute paths are valid: if there is any problem related to resources, we will fail fast, before starting potentially lengthy operations. Furthermore, if an output file (to be produced by the current run of jCleanCim) already exists in the "output" directory, it will be renamed already in the constructor to ensure that it does not get overwritten later on.
Other properties
Several available properties allow you to configure how to run jCleanCim: which main functions to run or not (validation, statistics, document generation), and to fine tune their execution. At present, this is the most comfortable way to configure a run of jCleanCim.
Because this is a java application, every property found in the "config.properties"
file can be overwritten when launching the application by providing one or more
-D<propertyName>=<propertyValue>
statements immediately after the
java
command, but if there are many properties to configure, it is simpler to do it
in the "config.properties" file.
Implementation note: The values obtained from properties have been validated and stored in appropriate format in the constructor. For instance, "true" is read as string and stored as boolean; comma-separated string read from file is stored as a list of strings; absolute file paths are produced from the simple file names. These are then made available through methods to the application.
Follows the description of individual properties.
Controlling some aspect of the overall application
As of release 01v09, there is one such property:
Top-level properties, to select the functionality to execute
You control what gets executed by enabling ("true") or disabling ("false" = value, "" = value omitted, null = whole property absent) one or more of the top level options. The values are shown below enclosed in "" to denote some text, but they should be typed in the properties file without "":
Model-related properties
These properties specify the UML or other model to work with:
-m <myModel.eap>
command line argument. The value specified with this property is useful if you always use the
same configuration file, so you need not type command line argument.
A valid UML repository is required for every scenario, except:
ModelBuilderKind.sqlxml
. This implementation is based on SQL queries for reading the
model .eap file (and replaces model.useSql=true
option of 01v07). It is almost order
of magnitude faster than the regular API calls (option ModelBuilderKind.japi
). Since
01v08, we have a rocket-fast implementation, with ModelBuilderKind.db
in case you don't
need to export diagrams or XMI. Note that both non-API options work properly for the .eap file
based on Acess RDBMS only.WGs
owning the profiles. These names are important as they are the only simple means to determine
which WG owns the profile without requiring other configuration by the user. For all of the
validation of cross-referencing and document generation, we are building an in-memory model with
profiles as packages, and therefore we have to assign them the owning WG the same way we do when
building the in-memory model from a UML repository. Any number of further subdirectories is
allowed, as all the files below the selected subdirectory get scanned. If the value is left
empty, profile files of all WGs found under the default profiles directory
DEFAULT_PROFILES_RELPATH
supported profile extension "xsd" will be picked
and processed.XMI export properties
This set of properties controls XMI export functionality, and are relevant only if "xmiexport.on"="true".
dialects
to export.Common validation properties
This set of properties controls validation functionality, and are relevant only if "validation.on"="true".
WG
owning the top-level package. Note that the whole of
the model must be read in order to determine the scope of associations and explicit UML
dependencies, as well as inheritance among classes from different packages. The scope is then
used for validation and statistics, but NOT for doc generation purposes. This filter is useful
for model editors who want to do validation and see statistics for their field of concern only.
However, before releasing any updated model, it is recommended to do the full validation, i.e.,
to leave this value empty.IEC61850-specific validation properties
While CIM UML uses UML as its meta-model, and we generate the documentation for any CIM package and its elements the same way, IEC61850 has a pretty complex structure and the underlying meta-model. Almost every element of the IEC61850 concrete model needs different treatment in both UML and for document generation at present (in the future, still more to come for SCL modelling!). Consequently, validation of IEC61850 UML model and document generation from that model requires many special "hints" for the application to produce the desired format (and allow us to not hard-code these in the source code). The properties relevant for IEC61850 only, explicitly contain in their names "IEC61850". Strictly speaking, most of these options are mainly required for document generation only. However, the document gets generated from the UML model, and we want to ensure that we have performed validation of the model before generating documentation. Therefore, the majority of IEC61850-specific properties are applicable to both validation (if "validation.on" ="true") and document generation (if "docgen.on"="true"). The values provided in the default "config.properties" file need not be modified, except if the packages get renamed in the UML model of IEC61850, or if WG10 decides to generate doc differently.
Statistics properties
These options control the displaying of statistics and are applicable only if value in property "statistics.on" is set to "true".
At present, there are only two boolean options, both applicable to CIM only: "statistics.cim.ignoreIdObjectInheritance" and "statistics.cim.ignoreDomainClassAttributes". In CIM, almost every class inherits from IEC61970::Core::IdentifiedObject, and most of attributes have as a type some class from IEC61970::Domain package. These two options allow, when set to "true", to skip displaying these obvious cross-WG dependencies and avoid unnecessary noise in the output.
Document generation properties (both MS Word and XML)
These options specify and control the generation of MS Word or XML document when property "docgen.on" is set to "true". Depending on the value in "profiles.docgen.on", the document will be generated from the UML model as default (if "profiles.docgen.on"="false", "", null), or from multiple profiles (if "profiles.docgen.on"="true"; note that at present, this functionality is not implemented, but is planned for the next release).
Because MS Word document generation takes very long, we apply several optimisations depending on the value of "docgen.on". For instance, if it not enabled, we don't export diagrams from the UML model (reading model is almost twice faster without exporting diagrams).
Several document generation properties are in fact used when collecting the content from the in-memory UML model, before outputing anything to files. Here are general document generation properties:
MS Word document generation properties
XML document generation properties
Starting with release 01v06, we started implementing support for printing UML model content to two XML files: so-called XML spec and XML doc. The first one is for all the content that is technically speaking specification (used for implementation), and the second one contains all the strings from the UML element description, special heading, caption or other titles, i.e., everything that needs translation. This decision has been taken in order to facilitate editing and translating process by IEC editors (once we move completely to web-based access and away from MS Word).
WG
owning the top-level package, in IEC
61850 lingo, so-called name spaces. In contrast to MS Word documentation, we do not have any
input template, so this is the means to select one or more namespaces, per WG. In CIM, we do not
have name spaces, but we fabricate one per top level package (from the existing version class).
CIM-profile document generation properties
Currently, there are no properties for this use case, except for the top-property "profiles.docgen.on"; note that at present, this functionality is not implemented.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_BLANK_PNG_FILENAME
Empty image, used when not storing diagrams into files.
|
static java.lang.String |
DEFAULT_OUT_XML_DOC_FILENAME
Default file name for XML doc output document (generated from a model).
|
static java.lang.String |
DEFAULT_OUT_XML_SPEC_FILENAME
Default file name for XML spec output document (generated from a model).
|
static java.lang.String |
DEFAULT_PROFILES_RELPATH
Default value for
|
static java.lang.String |
DEFAULT_PROPS_FILE_NAME
Application configuration properties, to be edited by the user.
|
static java.lang.String |
DEFAULT_VERSION_PROP_NAME
Project version property name (for use by ant script), and if not available through the jar
manifest, available through .
|
static java.lang.String |
DEFAULT_WEBACCESS_SCHEMA_FILENAME
Searched on classpath.
|
static java.lang.String |
DEFAULT_WORD_IN_TEMPLATE_FILENAME
Default file name for MS Word input template.
|
static java.lang.String |
DEFAULT_WORD_OUT_DOCUMENT_FILENAME
Default file name for MS Word output document (generated from input template and a model).
|
static java.lang.String |
IEC61850_PROPS_FILE_NAME
IEC 61850-specific application configuration properties, to be edited by the user.
|
static java.lang.String |
INPUT_DIR_NAME
Default input directory, set to be on the classpath.
|
static java.lang.String |
KEY_APP_SKIP_TIMING
App configuration: Skip logging ellapsed time = "true" (default = "false", "", null).
|
static java.lang.String |
KEY_DOCGEN_IEC61850_INCLUDE_METAMODEL_INHERITANCE
Write inheritance from IEC61850 UML meta-model
KEY_VALIDATION_IEC61850_PACKAGE_META_MODEL = "true" (default = "false", "", null). |
static java.lang.String |
KEY_DOCGEN_IEC61850_WRITE_UML_TYPES
Write types with their real names, as they are in IEC61850 UML = "true" (default = "false",
"", null).
|
static java.lang.String |
KEY_DOCGEN_INCLUDE_INFORMATIVE
Include informative UML model elements in the generated document = "true" (default = "false",
"", null).
|
static java.lang.String |
KEY_DOCGEN_INCLUDE_NON_PUBLIC
Include non-public UML model elements in the generated document = "true" (default = "false",
"", null).
|
static java.lang.String |
KEY_DOCGEN_ON
Top-level functionality: Enable document generation = "true" (default = "false", "", null).
|
static java.lang.String |
KEY_DOCGEN_PRINT_HTML
Enable formatted documentation of UML model elements be formatted same in any generated
document = "true" (default = "false", "", null).
|
static java.lang.String |
KEY_DOCGEN_WORD_ANALYSE_PLACEHOLDERS
Enable dry run of MS Word document generation = "true" (default = "false", "", null).
|
static java.lang.String |
KEY_DOCGEN_WORD_IN_TEMPLATE
File name of the (input) MS Word document template, expected to be found on the classpath.
|
static java.lang.String |
KEY_DOCGEN_WORD_INTRO_TO_FIGURE_BEFORE
Preserves original way of printing introduction to figures first in MS Word document
generation = "true" (default = "false", "", null), as opposed to referring to the figure
caption below the figure and its caption.
|
static java.lang.String |
KEY_DOCGEN_WORD_OUT_DOCUMENT
File name of the (output) MS Word generated document; will be created in
"output" from template "docgen.word.inTemplate" and the UML,
profile or in-memory model.
|
static java.lang.String |
KEY_DOCGEN_WORD_SAVE_REOPEN_EVERY
The number of tables (and table captions) to write before closing and reopening the document.
|
static java.lang.String |
KEY_DOCGEN_WORD_USE_DOC_FORMAT
Force MS Word COM (.doc) document generation = "true" (default = "false", "", null), as
opposed to the Open XML (.docx) format.
|
static java.lang.String |
KEY_DOCGEN_WORD_USE_HYPERLINKS
Enable hyperlinking of UML model elements in the generated MS Word document = "true" (default
= "false", "", null).
|
static java.lang.String |
KEY_DOCGEN_XML_OUT_DOC
File name of the (output) XML generated documentation (translatable) document; will be
created in "output" from the UML, profile or in-memory model.
|
static java.lang.String |
KEY_DOCGEN_XML_OUT_SPEC
File name of the (output) XML generated specification document; will be created in
"output" from the UML, profile or in-memory model.
|
static java.lang.String |
KEY_DOCGEN_XML_SCOPE
Comma-separated list of values corresponding to literals in
OwningWg ; empty value
(default) takes them all. |
static java.lang.String |
KEY_MODEL_BUILDER
One of enumeration literals in
ModelBuilderKind (def = ModelBuilderKind.db ). |
static java.lang.String |
KEY_MODEL_FILENAME
File name of a UML repository (model), expected to be found on the classpath.
|
static java.lang.String |
KEY_MODEL_NATURE_IEC61850
Comma-separated list of model packages (directly below the root) that are IEC61850, or derive
from it.
|
static java.lang.String |
KEY_PROFILES_CROSSCHECK_ON
Top-level functionality: Enable crosscheck between the UML model and a set of profiles =
"true" (default = "false", "", null).
|
static java.lang.String |
KEY_PROFILES_DIRNAMES
Comma-separated list of values corresponding to literals in
OwningWg ; empty value
(default) takes them all. |
static java.lang.String |
KEY_PROFILES_DOCGEN_ON
Top-level functionality: Enable document generation for profiles = "true" (default = "false",
"", null), if also "docgen.on"="true".
|
static java.lang.String |
KEY_PROFILES_RELPATH
Relative path of directory storing profiles; default is
DEFAULT_PROFILES_RELPATH . |
static java.lang.String |
KEY_STATISTICS_CIM_IGNORE_DOMAIN_CLASS_ATTRIBUTES
(if "statistics.on"="true"): Skip logging to console dependencies through usage
of types from CIM Domain package in attributes = "true" (default = "false", "", null).
|
static java.lang.String |
KEY_STATISTICS_CIM_IGNORE_ID_OBJECT_INHERITANCE
(if "statistics.on"="true"): Skip logging to console dependencies through
inheritance from CIM IdentifiedObject = "true" (default = "false", "", null).
|
static java.lang.String |
KEY_STATISTICS_ON
Top-level functionality: Enable statistics = "true" (default = "false", "", null).
|
static java.lang.String |
KEY_VALIDATION_ASSOCIATIONS_OFF
Skip all validation rules for associations and thier ends = "true" (default = "false", "",
null).
|
static java.lang.String |
KEY_VALIDATION_ATTRIBUTES_OFF
Skip all validation rules for attributes = "true" (default = "false", "", null).
|
static java.lang.String |
KEY_VALIDATION_CLASSES_OFF
Skip all validation rules for classes = "true" (default = "false", "", null).
|
static java.lang.String |
KEY_VALIDATION_DEPENDENCIES_OFF
Skip all validation rules for (hand-drawn UML) dependencies = "true" (default = "false", "",
null).
|
static java.lang.String |
KEY_VALIDATION_DIAGRAMS_OFF
Skip all validation rules for diagrams = "true" (default = "false", "", null).
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGE_FC
Name of the UML package where the functional constraints of IEC61850 are defined.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGE_LN_MAPS
Name of the UML package where the requirements specification for logical nodes (IEC61850-5)
is defined.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGE_META_MODEL
Name of the UML package where the meta-model of IEC61850 is defined.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGE_PRES_COND
Name of the UML package where the presence conditions of IEC61850 are defined.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGE_TRGOP
Name of the UML package where the trigger options of IEC61850 are defined.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGE72_TOP
Name of the UML package where the meta-model of IEC61850 is defined.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGES_BASIC
Comma-separated list of package names whose all deep-child elements (both sub-packages and
classes) should contain a human-readable name and may need special table formatting in
IEC61850-7-2.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGES_CDC
Comma-separated list of package names whose all deep-child elements (both sub-packages and
classes) should contain a human-readable name and apply special formatting for headings in
IEC61850-7-3.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGES_DA
Comma-separated list of package names whose all deep-child elements (both sub-packages and
classes) should contain a human-readable name and may need special table formatting in
IEC61850-7-3.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGES_DO_ABBR
Name of the UML package where the abbreviations for data object names in IEC61850 are
defined.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGES_ENUMS_XML
Comma-separated list of package names containing enumerations that must be printed as XML (in
addition to tables) in IEC61850-7-3 and IEC61850-7-4.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGES_LN
Comma-separated list of package names whose all deep-child elements (both sub-packages and
classes) should contain a human-readable name and apply special formatting for headings in
IEC61850-7-4.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGES72
Comma-separated list of package names required for generation of main clauses in
IEC61850-7-2.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGES73
Comma-separated list of package names required for generation of main clauses in
IEC61850-7-3.
|
static java.lang.String |
KEY_VALIDATION_IEC61850_PACKAGES74
Comma-separated list of package names required for generation of main clauses in
IEC61850-7-4.
|
static java.lang.String |
KEY_VALIDATION_LOGGING_VERBOSE
Log to console also validation steps with no errors = "true" (default = "false", "", null).
|
static java.lang.String |
KEY_VALIDATION_ON
Top-level functionality: Enable validation = "true" (default = "false", "", null).
|
static java.lang.String |
KEY_VALIDATION_OPERATIONS_OFF
Skip all validation rules for operations and their parameters = "true" (default = "false",
"", null).
|
static java.lang.String |
KEY_VALIDATION_PACKAGES_DATA_INDEX
Comma-separated list of package names required for building data index from all the
attributes on classes from the given package and below, recursively.
|
static java.lang.String |
KEY_VALIDATION_PACKAGES_OFF
Skip all validation rules for packages = "true" (default = "false", "", null).
|
static java.lang.String |
KEY_VALIDATION_RULES_OFF
Comma-separated list of individual rule class names to be skipped during validation.
|
static java.lang.String |
KEY_VALIDATION_SCOPE
Comma-separated list of values corresponding to literals in
OwningWg ; empty value
(default) takes them all. |
static java.lang.String |
KEY_XMIEXPORT_DIALECTS
Comma-separated list of values corresponding to literals in
XMIDialect ; empty value
(default) takes them all. |
static java.lang.String |
KEY_XMIEXPORT_ON
Top-level functionality: Enable XMI export = "true" (default = "false", "", null).
|
static java.lang.String |
MODEL_PICS_RELPATH
Directory path for exported diagram images.
|
static java.lang.String |
OUTPUT_DIR_NAME
Directory into which to create output files.
|
static java.lang.String |
PICS_DIR_NAME
Directory name for exported diagram images.
|
static java.lang.String |
PROFILES_DIR_NAME
Directory under classpath below which to search for profile files.
|
static java.lang.String |
VERSION_PROPS_FILENAME
Build properties (for use by ant script), containing also the version information.
|
static java.lang.String |
XSD_EXT
Supported profile format (file extension).
|
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.
|
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
deduceAppVersion() |
java.lang.String |
getAppVersion()
Returns application version deduced from manifest (if running with a jar), or read from
VERSION_PROPS_FILENAME file otherwise. |
java.lang.String |
getBlankPngFileAbsPath()
Returns absolute path of the default image file, to be used as replacement when the "real"
image is not available.
|
java.lang.String |
getDocgenWordInTemplateFileAbsPath()
Returns absolute path of input Word template file, null if doc generation disabled or output
files are given in another format.
|
java.lang.String |
getDocgenWordOutDocumentFileAbsPath()
Returns absolute path of output Word document file, null if doc generation disabled or output
files are given in another format.
|
int |
getDocgenWordSaveReopenEvery()
In case an integer cannot be parsed, returns -1; otherwise, an absolute value of
"docgen.word.saveReopenEvery".
|
java.lang.String |
getDocgenXmlOutDocFileAbsPath()
Returns absolute path of output XML doc file, null if doc generation disabled or output files
are given in another format.
|
java.lang.String |
getDocgenXmlOutSpecFileAbsPath()
Returns absolute path of output XML spec file, null if doc generation disabled or output
files are given in another format.
|
java.util.EnumSet<OwningWg> |
getDocgenXmlScope()
Returns the owners of packages that determine the scope of XML generation.
|
java.lang.String |
getDocgenXsdInWebaccessFileAbsPath()
Returns absolute path of XML web access schema file, null if doc generation disabled or
output files are given in another format.
|
java.lang.String |
getDocgenXsdOutWebaccessFileAbsPath()
Returns absolute path of where to copy the XML web access schema, null if doc generation
disabled or output files are given in another format.
|
java.util.List<java.lang.String> |
getIec61850NaturePackages()
Comma-separated list of names of model packages (below the root) with non-CIM nature.
|
ModelBuilderKind |
getModelBuilder()
Returns whether to use SQL to build model.
|
java.lang.String |
getModelFileAbsPath()
Returns absolute path of the UML model file.
|
java.lang.String |
getPicsDirAbsPath()
Returns absolute path string for directory where to export images from the model.
|
java.util.Map<OwningWg,java.util.List<java.io.File>> |
getProfileFiles() |
java.lang.String |
getProfilesRelpath() |
java.lang.String |
getValidationIec61850Package72Top() |
java.lang.String |
getValidationIec61850PackageFc() |
java.lang.String |
getValidationIec61850PackageLnMaps() |
java.lang.String |
getValidationIec61850PackageMetaModel() |
java.lang.String |
getValidationIec61850PackagePresCond() |
java.util.Collection<java.lang.String> |
getValidationIec61850Packages72() |
java.util.Collection<java.lang.String> |
getValidationIec61850Packages73() |
java.util.Collection<java.lang.String> |
getValidationIec61850Packages74() |
java.util.Collection<java.lang.String> |
getValidationIec61850PackagesBasic() |
java.util.Collection<java.lang.String> |
getValidationIec61850PackagesCdc() |
java.util.Collection<java.lang.String> |
getValidationIec61850PackagesDa() |
java.util.Collection<java.lang.String> |
getValidationIec61850PackagesDoAbbr() |
java.util.Collection<java.lang.String> |
getValidationIec61850PackagesDocgen()
Returns the union of
getValidationIec61850Packages72() ,
getValidationIec61850Packages73() and getValidationIec61850Packages74() . |
java.util.Collection<java.lang.String> |
getValidationIec61850PackagesEnumsXml() |
java.util.Collection<java.lang.String> |
getValidationIec61850PackagesExtTitle()
Returns the union of
getValidationIec61850PackagesLn() ,
getValidationIec61850PackagesCdc() and . |
java.util.Collection<java.lang.String> |
getValidationIec61850PackagesLn() |
java.lang.String |
getValidationIec61850PackageTrgOp() |
java.util.Collection<java.lang.String> |
getValidationPackagesDataIndex() |
java.util.Collection<java.lang.String> |
getValidationRulesOff() |
java.util.EnumSet<OwningWg> |
getValidationScope()
Returns the owners of packages that determine the scope of validation and statistics.
|
java.util.EnumSet<XMIDialect> |
getXmiexportDialects()
Returns the configured XMI dialects to be used for export.
|
boolean |
hasUmlModel()
Returns true when EA file is specified in configuration.
|
boolean |
isAppSkipTiming()
Returns whether to skip logging ellapsed time.
|
boolean |
isDocgenIec61850IncludeMetamodelInheritance() |
boolean |
isDocgenIec61850WriteUmlTypes() |
boolean |
isDocgenIncludeInformative() |
boolean |
isDocgenIncludeNonPublic() |
boolean |
isDocgenModelOn()
Returns true if only docgen from EA is enabled (but not profile docgen).
|
boolean |
isDocgenOn() |
boolean |
isDocgenPrintHtml()
Returns whether to respect markup (present in UML descriptions) in output document.
|
boolean |
isDocgenWordAnalysePlaceholders()
Returns whether to only analyse placeholders in output MS Word document, without replacing
them with the full content.
|
boolean |
isDocgenWordIntroToFigureBefore() |
boolean |
isDocgenWordUseDocFormat() |
boolean |
isDocgenWordUseHyperlinks()
Returns whether to use hyperlinks in output MS Word document.
|
boolean |
isProfilesCrosscheckOn() |
boolean |
isProfilesDocgenOn()
Returns true if both general and profile docgen are enabled.
|
boolean |
isRemovePicsAfterExit()
Returns whether to remove exported diagrams at application exit (true if MS Word output is to
be generated).
|
boolean |
isStatisticsCimIgnoreDomainClassAttributes() |
boolean |
isStatisticsCimIgnoreIdObjectInheritance() |
boolean |
isStatisticsOn() |
boolean |
isValidationAssociationsOn() |
boolean |
isValidationAttributesOn() |
boolean |
isValidationClassesOn() |
boolean |
isValidationDependenciesOn() |
boolean |
isValidationDiagramsOn() |
boolean |
isValidationLoggingVerbose() |
boolean |
isValidationOn() |
boolean |
isValidationOperationsOn() |
boolean |
isValidationPackagesOn() |
boolean |
isXmiexportOn()
Returns whether export to XMI is enabled; applicable only if the source of the model is an
.eap file.
|
java.lang.String |
toString() |
public static final java.lang.String KEY_APP_SKIP_TIMING
public static final java.lang.String KEY_MODEL_FILENAME
public static final java.lang.String KEY_MODEL_NATURE_IEC61850
public static final java.lang.String KEY_MODEL_BUILDER
ModelBuilderKind
(def = ModelBuilderKind.db
).public static final java.lang.String KEY_PROFILES_RELPATH
DEFAULT_PROFILES_RELPATH
.public static final java.lang.String KEY_PROFILES_DIRNAMES
OwningWg
; empty value
(default) takes them all. These correspond to profile subdirectories, under
"profiles.relpath", below which the profile files are located. The file extension
that is recognised is "xsd" .public static final java.lang.String KEY_XMIEXPORT_ON
public static final java.lang.String KEY_XMIEXPORT_DIALECTS
XMIDialect
; empty value
(default) takes them all.public static final java.lang.String KEY_VALIDATION_ON
public static final java.lang.String KEY_VALIDATION_SCOPE
OwningWg
; empty value
(default) takes them all.public static final java.lang.String KEY_VALIDATION_PACKAGES_OFF
public static final java.lang.String KEY_VALIDATION_CLASSES_OFF
public static final java.lang.String KEY_VALIDATION_ASSOCIATIONS_OFF
public static final java.lang.String KEY_VALIDATION_ATTRIBUTES_OFF
public static final java.lang.String KEY_VALIDATION_OPERATIONS_OFF
public static final java.lang.String KEY_VALIDATION_DEPENDENCIES_OFF
public static final java.lang.String KEY_VALIDATION_DIAGRAMS_OFF
public static final java.lang.String KEY_VALIDATION_RULES_OFF
public static final java.lang.String KEY_VALIDATION_LOGGING_VERBOSE
public static final java.lang.String KEY_VALIDATION_PACKAGES_DATA_INDEX
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGES72
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGES73
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGES74
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGE_META_MODEL
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGE72_TOP
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGES_ENUMS_XML
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGES_LN
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGES_CDC
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGES_DA
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGES_BASIC
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGE_PRES_COND
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGE_FC
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGE_TRGOP
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGES_DO_ABBR
public static final java.lang.String KEY_VALIDATION_IEC61850_PACKAGE_LN_MAPS
public static final java.lang.String KEY_STATISTICS_ON
public static final java.lang.String KEY_STATISTICS_CIM_IGNORE_ID_OBJECT_INHERITANCE
public static final java.lang.String KEY_STATISTICS_CIM_IGNORE_DOMAIN_CLASS_ATTRIBUTES
public static final java.lang.String KEY_PROFILES_CROSSCHECK_ON
public static final java.lang.String KEY_DOCGEN_ON
public static final java.lang.String KEY_DOCGEN_WORD_IN_TEMPLATE
DEFAULT_WORD_IN_TEMPLATE_FILENAME
is used.public static final java.lang.String KEY_DOCGEN_WORD_OUT_DOCUMENT
DEFAULT_WORD_OUT_DOCUMENT_FILENAME
is used.public static final java.lang.String KEY_DOCGEN_XML_SCOPE
OwningWg
; empty value
(default) takes them all.public static final java.lang.String KEY_DOCGEN_XML_OUT_SPEC
DEFAULT_OUT_XML_SPEC_FILENAME
is used.public static final java.lang.String KEY_DOCGEN_XML_OUT_DOC
DEFAULT_OUT_XML_DOC_FILENAME
is used.public static final java.lang.String KEY_DOCGEN_WORD_USE_DOC_FORMAT
public static final java.lang.String KEY_DOCGEN_WORD_INTRO_TO_FIGURE_BEFORE
public static final java.lang.String KEY_DOCGEN_WORD_SAVE_REOPEN_EVERY
public static final java.lang.String KEY_DOCGEN_WORD_ANALYSE_PLACEHOLDERS
public static final java.lang.String KEY_DOCGEN_PRINT_HTML
public static final java.lang.String KEY_DOCGEN_WORD_USE_HYPERLINKS
public static final java.lang.String KEY_DOCGEN_INCLUDE_INFORMATIVE
public static final java.lang.String KEY_DOCGEN_INCLUDE_NON_PUBLIC
public static final java.lang.String KEY_DOCGEN_IEC61850_INCLUDE_METAMODEL_INHERITANCE
KEY_VALIDATION_IEC61850_PACKAGE_META_MODEL
= "true" (default = "false", "", null).public static final java.lang.String KEY_DOCGEN_IEC61850_WRITE_UML_TYPES
public static final java.lang.String KEY_PROFILES_DOCGEN_ON
public static final java.lang.String INPUT_DIR_NAME
public static final java.lang.String PROFILES_DIR_NAME
public static final java.lang.String DEFAULT_PROFILES_RELPATH
public static final java.lang.String OUTPUT_DIR_NAME
public static final java.lang.String PICS_DIR_NAME
public static final java.lang.String MODEL_PICS_RELPATH
public static final java.lang.String DEFAULT_PROPS_FILE_NAME
public static final java.lang.String IEC61850_PROPS_FILE_NAME
public static final java.lang.String VERSION_PROPS_FILENAME
public static final java.lang.String DEFAULT_WEBACCESS_SCHEMA_FILENAME
public static final java.lang.String DEFAULT_VERSION_PROP_NAME
public static final java.lang.String DEFAULT_WORD_IN_TEMPLATE_FILENAME
public static final java.lang.String DEFAULT_WORD_OUT_DOCUMENT_FILENAME
public static final java.lang.String DEFAULT_OUT_XML_SPEC_FILENAME
public static final java.lang.String DEFAULT_OUT_XML_DOC_FILENAME
public static final java.lang.String DEFAULT_BLANK_PNG_FILENAME
public static final java.lang.String XSD_EXT
public Config(java.lang.String propsFilename, java.lang.String modelFilename) throws ApplicationException
propsFilename
- non-empty name of properties file; if null, default will be used. If no such a
file can be found on the classpath, empty properties set is created.modelFilename
- non-empty name of model file, that will override the value in property
"model.filename"; if null, the value in property
"model.filename" is used; if that one is also null, no model file will
be read.ApplicationException
public Config(java.util.Properties props, java.lang.String modelFilename) throws ApplicationException
props
- properties initialised from code instead of from file.modelFilename
- non-empty name of model file, that will override the value in property
"model.filename"; if null, the value in property
"model.filename" is used; if that one is also null, no model file will
be read.ApplicationException
public static java.lang.String deduceAppVersion()
public java.lang.String getAppVersion()
VERSION_PROPS_FILENAME
file otherwise.public boolean isAppSkipTiming()
public ModelBuilderKind getModelBuilder()
public java.lang.String getModelFileAbsPath()
public boolean hasUmlModel()
public java.util.List<java.lang.String> getIec61850NaturePackages()
public java.lang.String getBlankPngFileAbsPath()
public boolean isXmiexportOn()
public java.util.EnumSet<XMIDialect> getXmiexportDialects()
public boolean isValidationOn()
public java.util.EnumSet<OwningWg> getValidationScope()
public boolean isValidationPackagesOn()
public boolean isValidationClassesOn()
public boolean isValidationAssociationsOn()
public boolean isValidationAttributesOn()
public boolean isValidationOperationsOn()
public boolean isValidationDependenciesOn()
public boolean isValidationDiagramsOn()
public java.util.Collection<java.lang.String> getValidationRulesOff()
public boolean isValidationLoggingVerbose()
public java.util.Collection<java.lang.String> getValidationPackagesDataIndex()
public java.util.Collection<java.lang.String> getValidationIec61850Packages72()
public java.util.Collection<java.lang.String> getValidationIec61850Packages73()
public java.util.Collection<java.lang.String> getValidationIec61850Packages74()
public java.lang.String getValidationIec61850PackageMetaModel()
public java.lang.String getValidationIec61850Package72Top()
public java.util.Collection<java.lang.String> getValidationIec61850PackagesEnumsXml()
public java.util.Collection<java.lang.String> getValidationIec61850PackagesLn()
public java.util.Collection<java.lang.String> getValidationIec61850PackagesCdc()
public java.util.Collection<java.lang.String> getValidationIec61850PackagesDa()
public java.util.Collection<java.lang.String> getValidationIec61850PackagesBasic()
public java.util.Collection<java.lang.String> getValidationIec61850PackagesExtTitle()
getValidationIec61850PackagesLn()
,
getValidationIec61850PackagesCdc()
and .public java.util.Collection<java.lang.String> getValidationIec61850PackagesDocgen()
getValidationIec61850Packages72()
,
getValidationIec61850Packages73()
and getValidationIec61850Packages74()
.public java.lang.String getValidationIec61850PackagePresCond()
public java.lang.String getValidationIec61850PackageFc()
public java.lang.String getValidationIec61850PackageTrgOp()
public java.util.Collection<java.lang.String> getValidationIec61850PackagesDoAbbr()
public java.lang.String getValidationIec61850PackageLnMaps()
public boolean isStatisticsOn()
public boolean isStatisticsCimIgnoreIdObjectInheritance()
public boolean isStatisticsCimIgnoreDomainClassAttributes()
public boolean isProfilesCrosscheckOn()
public boolean isDocgenOn()
public boolean isDocgenWordUseDocFormat()
public boolean isDocgenWordIntroToFigureBefore()
public int getDocgenWordSaveReopenEvery()
public boolean isDocgenWordAnalysePlaceholders()
public boolean isDocgenPrintHtml()
public boolean isDocgenWordUseHyperlinks()
public java.lang.String getDocgenWordInTemplateFileAbsPath()
public java.lang.String getDocgenWordOutDocumentFileAbsPath()
public java.lang.String getDocgenXsdInWebaccessFileAbsPath()
public java.lang.String getDocgenXmlOutSpecFileAbsPath()
public java.lang.String getDocgenXmlOutDocFileAbsPath()
public java.lang.String getDocgenXsdOutWebaccessFileAbsPath()
public boolean isRemovePicsAfterExit()
public java.util.EnumSet<OwningWg> getDocgenXmlScope()
public boolean isDocgenIncludeInformative()
public boolean isDocgenIncludeNonPublic()
public boolean isDocgenIec61850IncludeMetamodelInheritance()
public boolean isDocgenIec61850WriteUmlTypes()
public boolean isProfilesDocgenOn()
public boolean isDocgenModelOn()
public java.lang.String getPicsDirAbsPath()
public java.lang.String getProfilesRelpath()
public java.util.Map<OwningWg,java.util.List<java.io.File>> getProfileFiles()
public java.lang.String toString()
toString
in class java.lang.Object
Copyright 2009-2016 Tatjana (Tanja) Kostic