Package | Description |
---|---|
org.tanjakostic.jcleancim.builder | |
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.model |
Classes being created by a builder or with the API (code) to hold the in-memory UML model.
|
org.tanjakostic.jcleancim.statistics |
Classes responsible for tracking and reporting model statistics.
|
org.tanjakostic.jcleancim.validation |
Classes responsible for validating the model and the rules to apply.
|
Modifier and Type | Interface and Description |
---|---|
interface |
UmlObjectBuilder<T extends UmlObject>
To avoid interface bloat, we follow the design pattern of Java collections API: to provide
"optional" methods and let implementations select which one they implement.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
BookmarkRegistry.findID(UmlObject o) |
java.lang.String |
BookmarkRegistry.getOrCreateBookmarkID(UmlObject o)
Returns the existing or the newly created bookmark ID for key
o . |
Modifier and Type | Method and Description |
---|---|
protected static java.lang.String |
AbstractObjectDoc.createDocId(UmlObject obj,
java.lang.String ending) |
protected static java.lang.String |
AbstractObjectDoc.deduceBookmark(BookmarkRegistry bmRegistry,
UmlObject obj) |
protected AbstractPropertiesDoc.CellText |
AbstractPropertiesDoc.deduceCellText(java.lang.String prefix,
TextDescription raw,
TextDescription html,
UmlObject o) |
protected AbstractPropertiesDoc.CellText |
AbstractPropertiesDoc.deduceCellText(java.lang.String prefix,
UmlObject o)
Selects the description to retain, according to configuration.
|
protected static java.lang.String |
AbstractObjectDoc.deduceQualifiersPrefix(UmlObject o,
java.util.Map<Nature,java.util.Set<java.lang.String>> builtIns,
boolean withCustomStereotypes,
java.lang.String fmt)
Invokes
AbstractObjectDoc.deduceQualifiersPrefix(UmlObject, Map, List, boolean, UmlObject, String)
without moreTokens and parent . |
protected static java.lang.String |
AbstractObjectDoc.deduceQualifiersPrefix(UmlObject o,
java.util.Map<Nature,java.util.Set<java.lang.String>> builtIns,
boolean withCustomStereotypes,
UmlObject parent,
java.lang.String fmt)
Invokes
AbstractObjectDoc.deduceQualifiersPrefix(UmlObject, Map, List, boolean, UmlObject, String)
without moreTokens . |
protected static java.lang.String |
AbstractObjectDoc.deduceQualifiersPrefix(UmlObject o,
java.util.Map<Nature,java.util.Set<java.lang.String>> builtIns,
java.util.List<java.lang.String> moreTokens,
boolean withCustomStereotypes,
java.lang.String fmt)
Invokes {link
AbstractObjectDoc.deduceQualifiersPrefix(UmlObject, Map, List, boolean, UmlObject, String) without
parent . |
protected static java.lang.String |
AbstractObjectDoc.deduceQualifiersPrefix(UmlObject o,
java.util.Map<Nature,java.util.Set<java.lang.String>> builtIns,
java.util.List<java.lang.String> moreTokens,
boolean withCustomStereotypes,
UmlObject parent,
java.lang.String fmt)
Returns deduced string formatted according to
fmt , from deprecated and
informative status, potentially more qualifiers, and potentially custom stereotypes. |
protected static java.lang.String |
AbstractPropertiesDoc.getDeprecatedTextAsPrefix(UmlObject o)
Returns empty string if property is not deprecated, otherwise formatted text ending with
white space.
|
protected void |
AbstractPropertiesDoc.initRawData(EntryDoc entry,
UmlObject property)
Initialises raw data for a native property (tag, name, alias+ID, desc+ID, informative,
deprecated, inheritedFrom).
|
protected void |
AbstractPropertiesDoc.initRawData(EntryDoc entry,
UmlObject property,
java.lang.String baseTypeName)
Initialises raw data for an inherited property (tag, name, alias+ID, desc+ID, informative,
deprecated, inheritedFrom).
|
protected java.lang.String |
AbstractObjectDoc.prepareForHyperlink(UmlObject targetObj)
If hyperlink option is enabled, creates a hyperlink placeholder for
targetObj
whose text will be written instead of name, to be replaced by a hyperlink in additional pass. |
protected java.lang.String |
AbstractObjectDoc.prepareForHyperlinkAdjustedName(UmlObject targetObj,
java.lang.String nameToDisplay)
Same as
AbstractObjectDoc.prepareForHyperlink(UmlObject) except that it creates the hyperlink
placeholder with |
protected boolean |
AbstractObjectDoc.toSkip(UmlObject o)
Returns whether to skip object
o , according to configuration. |
protected boolean |
AbstractPropertiesDoc.toSkipInherited(UmlObject o)
Returns whether inherited object
o needs to be skipped, according to
configuration. |
Constructor and Description |
---|
AbstractObjectDoc(DocgenConfig docgenCfg,
UmlObject o,
java.lang.String what,
TextDescription description,
TextDescription htmlDescription,
boolean ignoreDesc,
java.lang.String headingText,
java.lang.String bookmarkID,
BookmarkRegistry bmRegistry)
"Centralised" constructor, allowing for instantiation both with and without a UML object, and
with and without descriptions, as follows:
|
AbstractPropertiesDoc(DocgenConfig docgenCfg,
UmlObject object,
java.lang.String what,
java.lang.String introText,
java.lang.String captionText,
TableSpec colSpec,
java.lang.String tableName,
BookmarkRegistry bmRegistry)
Creates an instance with a
EntryDoc.Kind.tableName entry (if
tableName is not null) and
EntryDoc.Kind.columnLabels entry (from
colSpec ) in the list of entries; use when you want to add
EntryDoc.Kind.data (and optionally,
EntryDoc.Kind.groupSubhead ) entries one by
one, after some complex processing. |
AbstractPropertiesDoc(DocgenConfig docgenCfg,
UmlObject object,
java.lang.String what,
TextDescription description,
TextDescription htmlDescription,
boolean ignoreDesc,
java.lang.String headingText,
java.lang.String introText,
java.lang.String captionText,
TableSpec colSpec,
java.lang.String tableName,
BookmarkRegistry bmRegistry)
Same as
AbstractPropertiesDoc.AbstractPropertiesDoc(DocgenConfig, UmlObject, String, String, String, TableSpec, String, BookmarkRegistry)
, but with explicit text and html documentation parameters; this is to support chained
construction for the needs of testing where we don't have UML objects but want to print
descriptions. |
Attributes61850Doc(DocgenConfig docgenCfg,
UmlObject object,
java.lang.String what,
java.lang.String headingText,
java.lang.String introText,
java.lang.String captionText,
TableSpec colSpec,
java.lang.String tableName,
BookmarkRegistry bmRegistry)
Constructor.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractUmlObject
Common implementation of several methods and static utility methods for manipulating collections
of
UmlObject -s. |
class |
UmlAssociation
UML association, with its two ends (UML classes).
|
class |
UmlAssociationEnd
UML association end.
|
class |
UmlAttribute
UML attribute or enumeration literal.
|
class |
UmlClass
UML class, interface or enumerated type.
|
class |
UmlConstraint
UML constraint.
|
class |
UmlDependency
Explicit (hand-drawn) UML dependency between either two structures (packages or classes).
|
class |
UmlDiagram
Diagram from the UML model, assigned to either a class or a package.
|
class |
UmlOperation
UML operation.
|
class |
UmlPackage
UML package and its sub-packages hold the content of the model.
|
class |
UmlParameter
Operation parameter.
|
class |
UmlSkipped
UML element or connector that we ignore, but track for validation purposes.
|
class |
UmlStructure
Common implementation for collections contained by packages and classes.
|
Modifier and Type | Method and Description |
---|---|
static <T extends UmlObject> |
AbstractUmlObject.classifyPerScope(java.util.Collection<T> objects,
java.util.EnumSet<OwningWg> scope)
Returns map of objects indexed per
scope ; skips null objects. |
static <T extends UmlObject> |
AbstractUmlObject.classifyPerScopePerTag(java.util.Map<java.lang.String,java.util.Set<T>> tags,
java.util.EnumSet<OwningWg> scope)
Returns map of objects indexed per
scope , then per tag name tags ;
skips null objects. |
static <T extends UmlObject> |
AbstractUmlObject.classifyPerTag(java.util.Map<java.lang.String,java.util.Set<T>> tags,
java.util.EnumSet<OwningWg> scope)
Returns restricted map with objects that have given scope.
|
static <T extends UmlObject> |
AbstractUmlObject.collectDuplicateDescriptions(java.util.Collection<T> objects)
Returns those
objects that have the same description (trimmed), indexed by that
description; skips null objects. |
static <T extends UmlObject> |
AbstractUmlObject.collectDuplicateNames(java.util.Collection<T> objects)
Returns those
objects that have the same name, indexed by name; skips null
objects. |
static <T extends UmlObject> |
AbstractUmlObject.collectForScope(java.util.Collection<T> objects,
java.util.EnumSet<OwningWg> scope)
Returns list of objects that belong to a
scope ; skips null objects. |
static <T extends UmlObject> |
AbstractUmlObject.collectNames(java.util.Collection<T> objects)
Returns list of names.
|
static <T extends UmlObject> |
AbstractUmlObject.collectQNames(java.util.Collection<T> objects,
boolean includeOwner)
Returns list of qualified names, with prepended owner if
includeOwner=true . |
static <T extends UmlObject> |
AbstractUmlObject.findAllForName(java.util.Collection<T> objects,
java.lang.String name)
Returns set of objects with given name; skips null objects.
|
static <T extends UmlObject> |
AbstractUmlObject.findWithSameUuidAndLog(org.apache.log4j.Level level,
UmlObject asker,
java.util.Collection<T> objects,
java.lang.String uuid)
Returns the object with
uuid found in objects and logs the message
with level ; returns null otherwise. |
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,java.util.Set<UmlObject>> |
UmlModel.getTags() |
Modifier and Type | Method and Description |
---|---|
static java.util.List<java.lang.String> |
AbstractUmlObject.addDeprecAndInf(UmlObject o)
Returns potentially empty list of deprecation and informative qualifiers for
o
from its deprecation and informative status, not from its stereotypes. |
static void |
AbstractUmlObject.appendRemainingCustomStereotypes(java.util.List<java.lang.String> tokens,
UmlObject o,
java.util.Map<Nature,java.util.Set<java.lang.String>> builtins)
Extends
tokens with custom (=non-built-in) stereotypes that are not already
contained in |
static <T extends UmlObject> |
AbstractUmlObject.findWithSameUuidAndLog(org.apache.log4j.Level level,
UmlObject asker,
java.util.Collection<T> objects,
java.lang.String uuid)
Returns the object with
uuid found in objects and logs the message
with level ; returns null otherwise. |
static void |
AbstractUmlObject.saveTags(UmlObject o,
java.util.Map<java.lang.String,java.util.Set<UmlObject>> destination)
Stores object indexed by all of its tag names.
|
Modifier and Type | Method and Description |
---|---|
static void |
AbstractUmlObject.saveTags(UmlObject o,
java.util.Map<java.lang.String,java.util.Set<UmlObject>> destination)
Stores object indexed by all of its tag names.
|
Constructor and Description |
---|
UmlObjectData(UmlObject o)
Copy constructor.
|
Modifier and Type | Method and Description |
---|---|
java.util.Map<OwningWg,java.util.Map<java.lang.String,java.util.Set<UmlObject>>> |
ModelStats.getScopedTags() |
java.util.Map<java.lang.String,java.util.Set<UmlObject>> |
StatsPerOwner.getTags() |
Modifier and Type | Class and Description |
---|---|
static class |
AbstractRule.AbstractRuleWithSubobjectsAndSkips<T extends UmlObject>
Common superclass where a rule applies to multiple UML object types (e.g., package and
association) and their sub-objects (e.g., association ends) .
|
static class |
AbstractRule.UmlObjectsMissingDoc<T extends UmlObject> |
static class |
AbstractRule.UmlObjectsWithBadCharacterInName<T extends UmlObject> |
static class |
AbstractRule.UmlObjectsWithBadDocEnd<T extends UmlObject> |
static class |
AbstractRule.UmlObjectsWithBadDocStart<T extends UmlObject> |
static class |
AbstractRule.UmlObjectsWithUnallowedStereotype<T extends UmlObject> |
static class |
AbstractRule.UmlObjectsWithUnallowedTagNames<T extends UmlObject> |
class |
AbstractValidator<T extends UmlObject>
Common implementation for all UML object validators (package, class, etc.).
|
interface |
CrossRule<T extends UmlObject>
|
interface |
SimpleRule<T extends UmlObject>
Rule that applies to a single
UmlObject . |
Modifier and Type | Method and Description |
---|---|
java.util.Collection<? extends UmlObject> |
CrossRule.getObjsToTestAgainst()
Returns list of objects against which
CrossRule.validate(List, ModelIssues) works. |
java.util.Collection<? extends UmlObject> |
ClassValidator.CimClassesNeverUsedAsTypeForAttribute.getObjsToTestAgainst() |
java.util.Collection<? extends UmlObject> |
AttributeValidator.Iec61850DOAbbreviationLiteralsNeverUsedInDOName.getObjsToTestAgainst() |
java.util.Collection<UmlObject> |
ModelIssues.getSubjectsWithProblem(java.lang.String ruleName) |
protected java.util.List<UmlObject> |
AbstractRule.AbstractRuleWithSubobjectsAndSkips.getSubObjects(T o)
Used for validation of "sub-objects" (such as association ends and operation parameters)
that do not have their own validators, but get validated through their container.
|
protected java.util.List<UmlObject> |
AssociationValidator.AssociationEndsWithUnallowedStereotype.getSubObjects(UmlAssociation o) |
protected java.util.List<UmlObject> |
AssociationValidator.AssociationEndsMissingDoc.getSubObjects(UmlAssociation assoc) |
protected java.util.List<UmlObject> |
AssociationValidator.AssociationEndsWithBadDocStart.getSubObjects(UmlAssociation assoc) |
protected java.util.List<UmlObject> |
AssociationValidator.AssociationEndsWithBadDocEnd.getSubObjects(UmlAssociation assoc) |
protected java.util.List<UmlObject> |
AssociationValidator.AssociationEndsWithBadCharacterInName.getSubObjects(UmlAssociation assoc) |
protected java.util.List<UmlObject> |
OperationValidator.OperationParametersWithUnallowedStereotype.getSubObjects(UmlOperation op) |
protected java.util.List<UmlObject> |
OperationValidator.OperationParametersWithUnallowedTagNames.getSubObjects(UmlOperation op) |
protected java.util.List<UmlObject> |
OperationValidator.OperationParametersMissingDoc.getSubObjects(UmlOperation op) |
protected java.util.List<UmlObject> |
OperationValidator.OperationParametersWithBadDocStart.getSubObjects(UmlOperation op) |
protected java.util.List<UmlObject> |
OperationValidator.OperationParametersWithBadDocEnd.getSubObjects(UmlOperation op) |
protected java.util.List<UmlObject> |
OperationValidator.OperationParametersWithBadCharacterInName.getSubObjects(UmlOperation op) |
Modifier and Type | Method and Description |
---|---|
void |
ModelIssues.add(UmlObject subject,
ModelIssue issue) |
protected ModelIssue |
AbstractRule.createIssue(UmlObject subject) |
protected ModelIssue |
AbstractRule.createIssue(UmlObject subject,
java.lang.String evidence) |
protected ModelIssue |
AbstractRule.createIssue(UmlObject subject,
java.lang.String evidence,
java.lang.String subjectDescription,
java.lang.String groupTag) |
protected abstract void |
AbstractRule.AbstractRuleWithSubobjectsAndSkips.doValidate(UmlObject o,
ModelIssues issues) |
protected void |
AbstractRule.UmlObjectsWithUnallowedStereotype.doValidate(UmlObject o,
ModelIssues issues) |
protected void |
AbstractRule.UmlObjectsWithUnallowedTagNames.doValidate(UmlObject o,
ModelIssues issues) |
protected void |
AbstractRule.UmlObjectsMissingDoc.doValidate(UmlObject o,
ModelIssues issues) |
protected void |
AbstractRule.UmlObjectsWithBadDocStart.doValidate(UmlObject o,
ModelIssues issues) |
protected void |
AbstractRule.UmlObjectsWithBadDocEnd.doValidate(UmlObject o,
ModelIssues issues) |
protected void |
AbstractRule.UmlObjectsWithBadCharacterInName.doValidate(UmlObject o,
ModelIssues issues) |
protected InvalidCharactersFinder |
PackageValidator.PackagesWithBadCharacterInName.getInvalidCharacterFinder(UmlObject o) |
protected InvalidCharactersFinder |
OperationValidator.OperationsWithBadCharacterInName.getInvalidCharacterFinder(UmlObject o) |
protected InvalidCharactersFinder |
OperationValidator.OperationParametersWithBadCharacterInName.getInvalidCharacterFinder(UmlObject o) |
protected InvalidCharactersFinder |
DiagramValidator.DiagramsWithBadCharacterInName.getInvalidCharacterFinder(UmlObject o) |
protected InvalidCharactersFinder |
ClassValidator.ClassesWithBadCharacterInName.getInvalidCharacterFinder(UmlObject o) |
protected InvalidCharactersFinder |
AttributeValidator.CimAttributesWithBadCharacterInName.getInvalidCharacterFinder(UmlObject o) |
protected InvalidCharactersFinder |
AttributeValidator.Iec61850AttributesWithBadCharacterInName.getInvalidCharacterFinder(UmlObject o) |
protected InvalidCharactersFinder |
AssociationValidator.AssociationEndsWithBadCharacterInName.getInvalidCharacterFinder(UmlObject o) |
protected abstract InvalidCharactersFinder |
AbstractRule.UmlObjectsWithBadCharacterInName.getInvalidCharacterFinder(UmlObject o) |
java.util.Collection<ModelIssue> |
ModelIssues.getIssuesFor(UmlObject subject) |
Constructor and Description |
---|
ModelIssue(UmlObject subject,
org.tanjakostic.jcleancim.validation.Rule rule)
Creates an issue without the evidence part and with toShortString() subject description.
|
ModelIssue(UmlObject subject,
org.tanjakostic.jcleancim.validation.Rule rule,
java.lang.String subjectDescription)
Creates an issue without the evidence part.
|
ModelIssue(UmlObject subject,
org.tanjakostic.jcleancim.validation.Rule rule,
java.lang.String subjectDescription,
java.lang.String evidence,
java.lang.String groupTag)
Constructor.
|
Copyright 2009-2016 Tatjana (Tanja) Kostic