Package org.eclipse.esmf.metamodel

Interface NamedElement

All Superinterfaces:
ModelElement
All Known Subinterfaces:
AbstractEntity, Aspect, Characteristic, Code, Collection, ComplexType, Constraint, Duration, Either, EncodingConstraint, Entity, EntityInstance, Enumeration, Event, FixedPointConstraint, LanguageConstraint, LengthConstraint, List, LocaleConstraint, Measurement, Operation, Property, Quantifiable, QuantityKind, RangeConstraint, RegularExpressionConstraint, Set, SingleEntity, SortedSet, State, StructuredValue, StructureElement, TimeSeries, Trait, Unit
All Known Implementing Classes:
DefaultAbstractEntity, DefaultAspect, DefaultCharacteristic, DefaultCode, DefaultCollection, DefaultComplexType, DefaultConstraint, DefaultDuration, DefaultEither, DefaultEncodingConstraint, DefaultEntity, DefaultEntityInstance, DefaultEnumeration, DefaultEvent, DefaultFixedPointConstraint, DefaultLanguageConstraint, DefaultLengthConstraint, DefaultList, DefaultLocaleConstraint, DefaultMeasurement, DefaultOperation, DefaultProperty, DefaultPropertyWrapper, DefaultQuantifiable, DefaultQuantityKind, DefaultRangeConstraint, DefaultRegularExpressionConstraint, DefaultSet, DefaultSingleEntity, DefaultSortedSet, DefaultState, DefaultStructuredValue, DefaultTimeSeries, DefaultTrait, DefaultUnit, ModelElementImpl, QuantityKinds
public interface NamedElement extends ModelElement
Represents model elements that have human-readable names and descriptions

  • Method Details

    • getAspectModelUrn

      Optional<org.eclipse.esmf.aspectmodel.urn.AspectModelUrn> getAspectModelUrn()
      Returns:
      the URN which identifies an Aspect Model element.

    • getName

      String getName()
      Returns:
      the name of the Aspect Model element.

    • hasSyntheticName

      default boolean hasSyntheticName()
      Determines whether this model element has a generated name
      Returns:
      true if the name is synthetic (generated at load time), false if it is given in the model

    • getSee

      default List<String> getSee()
      Returns:
      a List of links to an external taxonomy/ontology.

    • getPreferredNames

      default Set<LangString> getPreferredNames()
      Returns:
      a Set containing language specific names for the Aspect Model element.

    • getDescriptions

      default Set<LangString> getDescriptions()
      Returns:
      a Set containing language specific descriptions for the Aspect Model element.

    • getPreferredName

      default String getPreferredName(Locale locale)
      A language specific name for the Element. There may be multiple preferred names.
      Parameters:
      locale - of the specific text
      Returns:
      the language specific text.

    • getDescription

      default String getDescription(Locale locale)
      Gets the description for the Aspect Model element for a specific language, if the language is present. If the language is not present, the description in English is returned. If there is also not description in English, returns null.
      Parameters:
      locale - of the specific text
      Returns:
      the language specific text or null