public abstract class InfoImpl extends Object implements Info
Modifier and Type | Field and Description |
---|---|
protected Descriptors |
descriptors |
protected Stereotypes |
stereotypesCache |
protected TaggedValues |
taggedValuesCache |
Constructor and Description |
---|
InfoImpl() |
Modifier and Type | Method and Description |
---|---|
String |
aliasName()
Alias of the model element, typically a human readable name.
|
int |
compareTo(Info i) |
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.
|
protected String |
descriptorSource(Descriptor descriptor) |
protected List<LangString> |
descriptorValues(Descriptor descriptor)
Look up the values for the descriptor, using the source as defined by the
configuration (or the default source, if the configuration does not state
anything regarding the source).
|
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 |
globalIdentifier()
WARNING: This method is intended to be "final", but not actually declared
as such.
|
String |
language()
NOTE: this method is not final since several XXXInfoImpl classes override
it
|
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.
|
void |
postprocessAfterLoadingAndValidate()
1.
|
String |
primaryCode()
Short code of the model element.
|
void |
removeTaggedValue(String tag)
WARNING: This method is intended to be "final", but not actually declared
as such.
|
void |
setDescriptors(Descriptors descriptors) |
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
taggedValuesAll() instead. |
Map<String,String> |
taggedValues(String tagList)
Deprecated.
With UML 2, there may be multiple values per tag. Use
taggedValuesAll(String tagOrTaglist) 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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
fullName, fullNameInSchema, id, model, name, options, result, validateStereotypesCache, validateTaggedValuesCache
protected Descriptors descriptors
protected TaggedValues taggedValuesCache
protected Stereotypes stereotypesCache
public int compareTo(Info i)
compareTo
in interface Comparable<Info>
public Stereotypes stereotypes()
Info
NOTE: The returned object is a copy; modifications to that copy do NOT change the stereotypes of this Info object.
stereotypes
in interface Info
public boolean stereotype(String stereotype)
Info
stereotype
in interface Info
stereotype
- a normalized stereotypetrue
, if the element carries the stereotype,
false
otherwisepublic TaggedValues taggedValuesForTagList(String tagList)
Info
taggedValuesForTagList
in interface Info
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.public TaggedValues taggedValuesAll()
Info
taggedValuesAll
in interface Info
null
.public String taggedValue(String tag)
Info
taggedValuesForTag(String tag)
instead.taggedValue
in interface Info
null
if the
tagged value is missing. If there are multiple values with the
tag only the first is provided.public String[] taggedValuesForTag(String tag)
Info
taggedValuesForTag
in interface Info
public String taggedValueInLanguage(String tag, String language)
Info
taggedValueInLanguage
in interface Info
language
- 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.public String[] taggedValuesInLanguage(String tag, String language)
Info
taggedValuesInLanguage
in interface Info
language
- the language to use, use codes from IETF RFC 5646, e.g. "en".public List<LangString> taggedValuesForTagAsLangStrings(String tag)
Info
taggedValuesForTagAsLangStrings
in interface Info
null
.protected String descriptorSource(Descriptor descriptor)
public Descriptors descriptors()
Info
descriptors
in interface Info
null
public void setDescriptors(Descriptors descriptors)
protected List<LangString> descriptorValues(Descriptor descriptor)
descriptor
- public String primaryCode()
Info
primaryCode
in interface Info
null
public String globalIdentifier()
WARNING: This method is intended to be "final", but not actually declared as such. A depending project can thus extend the method, if absolutely necessary.
globalIdentifier
in interface Info
null
if such an identifier
is not availablepublic String derivedDocumentation(String template, String novalue)
derivedDocumentation
in interface Info
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
nullpublic String documentation()
WARNING: This method is intended to be "final", but not actually declared as such. A depending project can thus extend the method, if absolutely necessary.
documentation
in interface Info
null
public String definition()
WARNING: This method is intended to be "final", but not actually declared as such. A depending project can thus extend the method, if absolutely necessary.
definition
in interface Info
null
public String description()
WARNING: This method is intended to be "final", but not actually declared as such. A depending project can thus extend the method, if absolutely necessary.
description
in interface Info
null
public String legalBasis()
WARNING: This method is intended to be "final", but not actually declared as such. A depending project can thus extend the method, if absolutely necessary.
legalBasis
in interface Info
null
public String language()
public String[] dataCaptureStatements()
WARNING: This method is intended to be "final", but not actually declared as such. A depending project can thus extend the method, if absolutely necessary.
dataCaptureStatements
in interface Info
null
public String[] examples()
WARNING: This method is intended to be "final", but not actually declared as such. A depending project can thus extend the method, if absolutely necessary.
public String aliasName()
WARNING: This method is intended to be "final", but not actually declared as such. A depending project can thus extend the method, if absolutely necessary.
public String encodingRule(String platform)
Info
encodingRule
in interface Info
public boolean matches(String rule)
Info
public void postprocessAfterLoadingAndValidate()
postprocessAfterLoadingAndValidate
in interface Info
@Deprecated public Map<String,String> taggedValues(String tagList)
taggedValuesAll(String tagOrTaglist)
instead.Info
taggedValues
in interface Info
null
. If there are multiple values
for a tag only the first is provided.public void removeTaggedValue(String tag)
WARNING: This method is intended to be "final", but not actually declared as such. A depending project can thus extend the method, if absolutely necessary.
removeTaggedValue
in interface Info
@Deprecated public Map<String,String> taggedValues()
taggedValuesAll()
instead.Info
taggedValues
in interface Info
null
. If there are multiple values
for a tag only the first is provided.Copyright © 2018. All rights reserved.