public interface IMAFModelService
This interface contains the services methods to retrieve entity model in the local workspace.
We provide a convenience method to retrieve model entity problems.
We provide a convenience method to retrieve references for a RadicalElement.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
copyright |
Modifier and Type | Method and Description |
---|---|
boolean |
closeLocation(java.lang.String locationName) |
AbstractBlockBase |
getAbstractBlockBase(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName)
Returns the concrete Abstract Block Base for this project name, package name and entity name. Or null if not present in local workspace. |
AbstractSegment |
getAbstractSegment(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
CodasylBlockBase |
getCodasylBlockBase(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
DataElement |
getDataElement(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
DataStructure |
getDataStructure(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
Dialog |
getDialog(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
DialogServer |
getDialogServer(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
HierarchicalBlockBase |
getHierarchicalBlockBase(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
InputAid |
getInputAid(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
Library |
getLibrary(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
LogicalView |
getLogicalView(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
Macro |
getMacro(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
MetaDataAggregate |
getMetaDataAggregate(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
MetaEntity |
getMetaEntity(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
MetaEntityType |
getMetaEntityType(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
MonoStructureSegment |
getMonoStructureSegment(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
java.util.List<IProblem> |
getProblems(RadicalElement radicalElement) |
Program |
getProgram(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
RadicalElement |
getRadicalElement(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName,
java.lang.String entityType)
Returns the RadicalElement for this project name, package name, entity name and entity type. Or null if not present in local workspace. |
RadicalElement |
getRadicalElement(java.lang.String projectName,
java.lang.String packageName,
java.lang.String metaEntityName,
java.lang.String entityName,
java.lang.String entityType) |
RelationalBlockBase |
getRelationalBlockBase(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
Report |
getReport(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
Screen |
getScreen(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
Server |
getServer(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
SocrateBlockBase |
getSocrateBlockBase(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
StandardSegment |
getStandardSegment(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
Table |
getTable(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
Text |
getText(java.lang.String projectName,
java.lang.String packageName,
java.lang.String entityName) |
UserEntity |
getUserEntity(java.lang.String projectName,
java.lang.String packageName,
java.lang.String metaEntityName,
java.lang.String entityName) |
boolean |
isLocationOpen(java.lang.String locationName) |
boolean |
openLocation(java.lang.String locationName) |
java.util.List<RadicalElement> |
references(RadicalElement radicalElement,
boolean subReferences) |
java.util.List<RadicalElement> |
search(IMAFSearchPattern searchPattern) |
static final java.lang.String copyright
boolean closeLocation(java.lang.String locationName)
Closes the location. If success returns true.
locationName
- AbstractBlockBase getAbstractBlockBase(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the concrete Abstract Block Base for this project name, package name and entity name. Or null if not present in local workspace.
Can be an instance of RelationBlockBase, HierarchicalBlockBase, CodasyBlockBase or SocrateBlockBase
projectName
- packageName
- entityName
- AbstractSegment getAbstractSegment(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the concrete Abstract Segment for this project name, package name and entity name. Or null if not present in local workspace.
Can be an instance of Segment, Table, LogicalView or MonoStructureSegment
projectName
- packageName
- entityName
- CodasylBlockBase getCodasylBlockBase(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Codeasyl Block Base for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- DataElement getDataElement(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Data Element for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- DataStructure getDataStructure(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Data Structure for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- Dialog getDialog(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Dialog for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- DialogServer getDialogServer(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Dialog Server for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- HierarchicalBlockBase getHierarchicalBlockBase(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Hierarchical Block Base for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- InputAid getInputAid(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the UnputAid for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- Library getLibrary(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Library for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- LogicalView getLogicalView(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Logical View for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- Macro getMacro(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Macro for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- MetaDataAggregate getMetaDataAggregate(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Meta Data Aggregate for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- MetaEntity getMetaEntity(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Meta Entity for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- MetaEntityType getMetaEntityType(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Meta Entity Type for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- MonoStructureSegment getMonoStructureSegment(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Mono Structure Segment for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- java.util.List<IProblem> getProblems(RadicalElement radicalElement)
Returns model problems for this element.
radicalElement
- Program getProgram(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Program for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- RadicalElement getRadicalElement(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName, java.lang.String entityType)
Returns the RadicalElement for this project name, package name, entity name and entity type. Or null if not present in local workspace.
entity type is the model extension of a radical element. For example : dataaggregate for a Segment or Table.
projectName
- packageName
- entityName
- entityType
- RadicalElement getRadicalElement(java.lang.String projectName, java.lang.String packageName, java.lang.String metaEntityName, java.lang.String entityName, java.lang.String entityType)
Returns the RadicalElemenr for this project name, package name, meta entity name, entity name and entity type. Or null if not present in local workspace.
meta entity name is mandatory for UserEntity
entity type is the model extension of a radical element. For example : dataaggregate for a Segment or Table.
projectName
- packageName
- metaEntityName
- entityName
- entityType
- RelationalBlockBase getRelationalBlockBase(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Relational Block Base for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- Report getReport(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Report for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- Screen getScreen(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Screen for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- Server getServer(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Server for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- SocrateBlockBase getSocrateBlockBase(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Socrate Block Base for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- StandardSegment getStandardSegment(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Standard Segment for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- Table getTable(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Table for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- Text getText(java.lang.String projectName, java.lang.String packageName, java.lang.String entityName)
Returns the Text for this project name, package name and entity name. Or null if not present in local workspace.
projectName
- packageName
- entityName
- UserEntity getUserEntity(java.lang.String projectName, java.lang.String packageName, java.lang.String metaEntityName, java.lang.String entityName)
Returns the User Entity for this project name, package name, meta entity name and entity name. Or null if not present in local workspace.
projectName
- packageName
- metaEntityName
- entityName
- boolean isLocationOpen(java.lang.String locationName)
Returns true if the location is open.
locationName
- boolean openLocation(java.lang.String locationName)
Opens the location. If success returns true.
locationName
- java.util.List<RadicalElement> references(RadicalElement radicalElement, boolean subReferences)
Returns the references.
if subReferences is true then returns the sub references.
if subReferences is false then returns the super references.
radicalElement
- subReferences
- java.util.List<RadicalElement> search(IMAFSearchPattern searchPattern)
Returns the list of radical elements base on this pattern.
Example :
IMAFModelService mafService = MAFModelService.getInstance();
mafService.openLocation ("MyLocation");
MAFSearchPattern searchPattern = new MAFSearchPattern();
searchPattern.setExpression("PRG*");
searchPattern.getFilteredTypes().add("pacprogram");
searchPattern.setLimitTo(IMAFSearchPattern.NAME);
List results = mafService.search(searchPattern);
mafService.closeLocation( "MyLocation" );
searchPattern
-