public interface Info extends Comparable<Info>
Modifier and Type | Method and Description |
---|---|
String |
aliasName()
Alias of the model element, typically a human readable name.
|
String[] |
dataCaptureStatements()
Data capture statements for collecting data for this model element.
|
String |
definition()
Definition of the model element.
|
String |
derivedDocumentation(String template,
String novalue) |
String |
description()
Supplementary description of the model element providing additional
information intended to assist the understanding or use of the model
element.
|
Descriptors |
descriptors()
Retrieves available values for all descriptors as defined by the
configuration.
|
String |
documentation()
Full text documentation of the model element, in EA the notes field.
|
String |
encodingRule(String platform)
Identifies the encoding rule relevant on the element, given the platform.
|
String[] |
examples()
Examples of the use of the model element.
|
String |
fullName()
Fully qualified UML name (Package1::...
|
String |
fullNameInSchema()
Fully qualified UML name (Package1::...
|
String |
globalIdentifier() |
String |
id()
Return unique id of model element (unique within the model).
|
String |
language()
The primary language used in the information about the model element.
|
String |
legalBasis()
Specification of the legal basis that is the basis for collecting this
model element.
|
boolean |
matches(String rule)
Check whether a requirement or conversion rule applies for this model
element.
|
Model |
model() |
String |
name()
Obtain the name of the model element.
|
Options |
options() |
void |
postprocessAfterLoadingAndValidate()
1.
|
String |
primaryCode()
Short code of the model element.
|
void |
removeTaggedValue(String tag) |
ShapeChangeResult |
result() |
boolean |
stereotype(String stereotype)
Test whether the model element carries a certain stereotype.
|
Stereotypes |
stereotypes()
Retrieves a copy of all (normalized) stereotypes of this model element.
|
String |
taggedValue(String tag)
Retrieves a selected tagged value of the model element.
|
String |
taggedValueInLanguage(String tag,
String language)
Retrieves a selected tagged value of the model element, if it is
associated with the requested language.
|
Map<String,String> |
taggedValues()
Deprecated.
With UML 2, there may be multiple values per tag. Use
taggedValuesMult() instead. |
Map<String,String> |
taggedValues(String tagList)
Deprecated.
With UML 2, there may be multiple values per tag. Use
taggedValuesMult(tagList) instead. |
TaggedValues |
taggedValuesAll()
Retrieves all tagged values of the model element.
|
String[] |
taggedValuesForTag(String tag)
Retrieves all tagged values of the model element with the specified tag.
|
List<LangString> |
taggedValuesForTagAsLangStrings(String tag)
Retrieves all tagged values of the model element with the specified tag.
|
TaggedValues |
taggedValuesForTagList(String tagList)
Retrieves selected tagged values of the model element.
|
String[] |
taggedValuesInLanguage(String tag,
String language)
Retrieves all tagged values of the model element with the specified tag
and if it is associated with the requested language.
|
void |
validateStereotypesCache() |
void |
validateTaggedValuesCache()
Create cache of stereotypes and tagged values
|
compareTo
Options options()
ShapeChangeResult result()
Model model()
String globalIdentifier()
null
if such an identifier
is not availableDescriptors descriptors()
null
String id()
String name()
String fullName()
String fullNameInSchema()
String language()
null
if no language
information is provided in the schema.String primaryCode()
null
String documentation()
null
String derivedDocumentation(String template, String novalue)
template
- The text to use as a template for the documentation. The
placeholders [[descriptor]] will be replaced by the value of
the descriptor. I.e. '[[definition]]' will be replaced by the
definition of the model elementnovalue
- The value that will be used, if the descriptor is empty or
nullString aliasName()
null
String definition()
null
String description()
null
String[] examples()
null
String legalBasis()
null
String[] dataCaptureStatements()
null
Stereotypes stereotypes()
NOTE: The returned object is a copy; modifications to that copy do NOT change the stereotypes of this Info object.
boolean stereotype(String stereotype)
stereotype
- a normalized stereotypetrue
, if the element carries the stereotype,
false
otherwiseString taggedValue(String tag)
taggedValuesForTag(String tag)
instead.the
- normalized tag name of the tagged value to look upnull
if the
tagged value is missing. If there are multiple values with the
tag only the first is provided.List<LangString> taggedValuesForTagAsLangStrings(String tag)
the
- normalized tag name of the tagged value to look upnull
.String[] taggedValuesForTag(String tag)
the
- normalized tag name of the tagged value to look upString taggedValueInLanguage(String tag, String language)
the
- normalized tag name of the tagged value to look uplanguage
- the language to use, use codes from IETF RFC 5646, e.g. "en".null
if the tagged value is missing. If there are
multiple values with the tag only the first (in the given
language) is provided.String[] taggedValuesInLanguage(String tag, String language)
the
- normalized tag name of the tagged value to look uplanguage
- the language to use, use codes from IETF RFC 5646, e.g. "en".TaggedValues taggedValuesForTagList(String tagList)
tagList
- name(s) of the tagged values to look up. If multiple tags are
provided, tags are assumed to be separated by commas.null
. The result is a copy of the tagged values of
this Info object - thus modifications to the result won't affect
the tagged values of this Info object.TaggedValues taggedValuesAll()
null
.void removeTaggedValue(String tag)
@Deprecated Map<String,String> taggedValues()
taggedValuesMult()
instead.null
. If there are multiple values
for a tag only the first is provided.@Deprecated Map<String,String> taggedValues(String tagList)
taggedValuesMult(tagList)
instead.null
. If there are multiple values
for a tag only the first is provided.void validateTaggedValuesCache()
void validateStereotypesCache()
String encodingRule(String platform)
platform
- boolean matches(String rule)
void postprocessAfterLoadingAndValidate()
Copyright © 2017. All rights reserved.