Interface IModelElement
-
- All Known Subinterfaces:
IAssembly
,IAssemblyDefinition
,IAssemblyInstance
,IChoiceInstance
,IDefinition
,IFeatureFlagContainer<F>
,IFeatureInlinedDefinition<INSTANCE>
,IField
,IFieldDefinition
,IFieldInstance
,IFlag
,IFlagContainer
,IFlagDefinition
,IFlagInstance
,IInstance
,IModelInstance
,INamedInstance
,INamedModelElement
,INamedModelInstance
,IValuedDefinition
- All Known Implementing Classes:
AbstractAssemblyInstance
,AbstractChoiceInstance
,AbstractFieldInstance
,AbstractFlagInstance
,AbstractInstance
,AbstractModelInstance
public interface IModelElement
A marker interface for Metaschema constructs that can be members of a Metaschema definition's model.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IModule
getContainingModule()
Retrieves the Metaschema module that contains the information element's declaration.ModelType
getModelType()
Get the Metaschema model type of the information element.MarkupMultiline
getRemarks()
Retrieve the remarks associated with this information element, if any.String
toCoordinates()
Retrieves a string that uniquely identifies the model element in the overall collection of model elements.
-
-
-
Method Detail
-
getModelType
@NonNull ModelType getModelType()
Get the Metaschema model type of the information element.- Returns:
- the type
-
toCoordinates
@NonNull String toCoordinates()
Retrieves a string that uniquely identifies the model element in the overall collection of model elements. This should the type of element, it's name, and any additional information needed to uniquely identify it.- Returns:
- the coordinates
-
getRemarks
@Nullable MarkupMultiline getRemarks()
Retrieve the remarks associated with this information element, if any.- Returns:
- the remarks or
null
if no remarks are defined
-
getContainingModule
@NonNull IModule getContainingModule()
Retrieves the Metaschema module that contains the information element's declaration.- Returns:
- the Metaschema module
-
-