use of org.osate.ge.businessobjecthandling.GetNameContext in project osate2 by osate.
the class PasteAction method ensureBusinessObjectHasUniqueName.
/**
* If the element is renameable and the name can be validated, then generate a name that passes validation.
* Otherwise, do not change the element's name. Contains special handling for component implementations.
* @param bo
* @param boHandler
*/
private static void ensureBusinessObjectHasUniqueName(final EObject bo, final BusinessObjectHandler boHandler) {
if (supportsRenaming(bo, boHandler) && boHandler.canRename(new CanRenameContext(bo))) {
// Determine the current name of the business object.
final String originalName = boHandler.getNameForRenaming(new GetNameContext(bo));
// contain the component type / component type alias appropriate for the destination package.
if (bo instanceof ComponentImplementation) {
final ComponentImplementation ci = (ComponentImplementation) bo;
final ComponentType ct = ci.getType();
final ClassifierCreationHelper classifierCreationHelper = new ClassifierCreationHelper(ci.eResource().getResourceSet());
final String ciTypeName;
if (ct == null) {
ciTypeName = ci.getTypeName();
} else {
if (!AadlNameUtil.namesAreEqual(ci.getNamespace(), ct.getNamespace())) {
if (!(ci.getNamespace() instanceof PackageSection)) {
throw new RuntimeException("New component implementation is not contained in a package section");
}
final PackageSection section = (PackageSection) ci.getNamespace();
// Import the package if necessary
final AadlPackage typePkg = (AadlPackage) ct.getNamespace().getOwner();
AadlImportsUtil.addImportIfNeeded(section, typePkg);
// Create an alias for the component type
final ClassifierCreationHelper.RenamedTypeDetails aliasDetails = classifierCreationHelper.getRenamedType(section, typePkg, ct.getName());
if (!aliasDetails.exists) {
final ComponentTypeRename ctr = section.createOwnedComponentTypeRename();
ctr.setName(aliasDetails.aliasName);
ctr.setCategory(ct.getCategory());
ctr.setRenamedComponentType(ct);
}
ciTypeName = aliasDetails.aliasName;
} else {
ciTypeName = ct.getName();
}
}
setName(bo, boHandler, ciTypeName + ".osate_ge_temporary_name_00001");
} else {
// Set name to dummy name so that validate name will work as expected. Many implementations
// of validate name check if the name has changed.
setName(bo, boHandler, "");
}
// Determine a new name for the business object
final String baseName = originalName;
String newName = originalName;
int count = 1;
while (true) {
final String result = RenameUtil.checkNewNameValidity(bo, boHandler, newName);
if (result == null) {
break;
}
newName = baseName + "_copy" + (count == 1 ? "" : Integer.toString(count));
count++;
}
// specified value does not include the type name.
if (bo instanceof ComponentImplementation) {
newName = ((ComponentImplementation) bo).getTypeName() + "." + newName;
}
// Update the business object's name
setName(bo, boHandler, newName);
}
}
use of org.osate.ge.businessobjecthandling.GetNameContext in project osate2 by osate.
the class AgeContentOutlinePage method createControl.
@Override
public void createControl(final Composite parent) {
super.createControl(parent);
final TreeViewer viewer = getTreeViewer();
ContextHelpUtil.setHelp(viewer.getControl(), ContextHelpUtil.OUTLINE_VIEW);
// A comparator is set to allow comparing tree elements of different types in a way where they will be equal if the relative reference is equal.
// This is needed so that tree node will be preserved when elements are hidden and shown and the underlying object type changes.
// If link with editor is enabled, selection may not be retained.
viewer.setComparer(new IElementComparer() {
@Override
public int hashCode(final Object element) {
if (element == null) {
return 0;
}
return Objects.hashCode(getRelativeReferenceForElement(element)) + hashCode(getElementParent(element));
}
@Override
public boolean equals(final Object element1, final Object element2) {
final Object ref1 = getRelativeReferenceForElement(element1);
final Object ref2 = getRelativeReferenceForElement(element2);
final boolean referencesAreEqual = Objects.equals(ref1, ref2);
if (!referencesAreEqual) {
return false;
}
if (element1 == null || element2 == null) {
return element1 == element2;
}
return equals(getElementParent(element1), getElementParent(element2));
}
});
viewer.setContentProvider(new ITreeContentProvider() {
@Override
public void dispose() {
}
@Override
public void inputChanged(final Viewer viewer, final Object oldInput, final Object newInput) {
}
@Override
public Object[] getElements(final Object inputElement) {
if (inputElement instanceof InternalDiagramEditor) {
final InternalDiagramEditor editor = (InternalDiagramEditor) inputElement;
return getChildren(editor.getDiagram());
}
return new BusinessObjectContext[0];
}
@Override
public Object[] getChildren(final Object parentElement) {
if (parentElement instanceof BusinessObjectContext) {
final BusinessObjectContext parent = ((BusinessObjectContext) parentElement);
final List<BusinessObjectContext> children = new ArrayList<>();
// DiagramNodes represent elements which are part of the diagram
if (parent instanceof DiagramNode) {
final DiagramNode parentNode = (DiagramNode) parent;
// Add child diagram nodes
parentNode.getChildren().stream().filter((de) -> !Strings.isNullOrEmpty(de.getUserInterfaceName()) || de.getBusinessObject() instanceof EObject).forEach(children::add);
// Add children which are hidden based on user preference
if (showHiddenElementsAction.isChecked()) {
// If the diagram is a contextless diagram, create a business object context which uses the current project as the business object
final BusinessObjectContext parentForRetrieval;
if (parentElement instanceof AgeDiagram && ((AgeDiagram) parentElement).getConfiguration().getContextBoReference() == null) {
parentForRetrieval = new BusinessObjectContext() {
@Override
public Collection<? extends BusinessObjectContext> getChildren() {
return parentNode.getChildren();
}
@Override
public BusinessObjectContext getParent() {
return parent.getParent();
}
@Override
public Object getBusinessObject() {
return projectProvider.getProject();
}
};
} else {
parentForRetrieval = parent;
}
// Add children based on the objects returns by the business object provider for business objects which are not currently in the
// diagram.
getChildContextsFromProvider(parent, parentForRetrieval, childRef -> {
return !children.stream().map(AgeContentOutlinePage.this::getRelativeReferenceForElement).anyMatch(childRef::equals);
}).filter(this::includeHiddenBusinessObjectContext).forEachOrdered(children::add);
}
} else if (parent instanceof BusinessObjectContext) {
// Add children which are hidden based on user preference
if (showHiddenElementsAction.isChecked()) {
getChildContextsFromProvider(parent, parent, childRef -> true).filter(this::includeHiddenBusinessObjectContext).forEachOrdered(children::add);
}
}
return children.toArray();
}
return new BusinessObjectContext[0];
}
/**
* Filter returns whether a hidden business object context should be shown. This is implemented to be consistent with
* handling for diagram elements.
*/
private boolean includeHiddenBusinessObjectContext(final BusinessObjectContext boc) {
final Object bo = boc.getBusinessObject();
if (bo instanceof EObject) {
return true;
}
final BusinessObjectHandler boh = extRegistry.getApplicableBusinessObjectHandler(bo);
return boh != null && !Strings.isNullOrEmpty(boh.getName(new GetNameContext(bo)));
}
/**
* Creates a stream of business object contexts representing the children returned by the business object provider.
* Such contexts do not have a valid isChildren() method.
* @param parent is the context to use as the parent of returned contexts. This should be the DiagramNode if one exists.
* @param parentForRetrieval is the context to use when requesting children from the business object provider
* @param filterPredicate is a filter that can be used to filter results by the relative reference before the context is created
* @return A stream of child business object contexts
*/
private Stream<BusinessObjectContext> getChildContextsFromProvider(final BusinessObjectContext parent, final BusinessObjectContext parentForRetrieval, final Predicate<RelativeBusinessObjectReference> filterPredicate) {
return bopHelper.getChildBusinessObjects(parentForRetrieval).stream().map(childBo -> {
if (childBo instanceof BusinessObjectProxy) {
return ((BusinessObjectProxy) childBo).resolve(referenceService);
} else {
return childBo;
}
}).filter(Objects::nonNull).filter(childBo -> {
final RelativeBusinessObjectReference childRef = referenceService.getRelativeReference(childBo);
return childRef != null && filterPredicate.test(childRef);
}).map(childBo -> new BusinessObjectContext() {
@Override
public Collection<? extends BusinessObjectContext> getChildren() {
// Returns an empty list. Shouldn't be needed. All children are hidden and such children will be provided by the content provider.
return Collections.emptyList();
}
@Override
public BusinessObjectContext getParent() {
return parent;
}
@Override
public Object getBusinessObject() {
return childBo;
}
});
}
@Override
public Object getParent(final Object element) {
return getElementParent(element);
}
@Override
public boolean hasChildren(final Object element) {
if (element instanceof BusinessObjectContext) {
return getChildren(element).length > 0;
}
return false;
}
});
// Create a label provider that will be used by the tree's actual label provider which will be a StyledCellLabelProvider.
// This label provider is also used by the custom comparator because the default one does not support text provided by the styled cell label provider.
final LabelProvider innerLabelProvider = new LabelProvider() {
@Override
public String getText(final Object element) {
if (element instanceof BusinessObjectContext) {
final BusinessObjectContext boc = (BusinessObjectContext) element;
return UiUtil.getDescription(boc, extRegistry);
}
return super.getText(element);
}
@Override
public Image getImage(final Object element) {
if (element instanceof DiagramElement) {
final DiagramElement de = (DiagramElement) element;
return UiUtil.getImage(de.getBusinessObjectHandler(), de.getBusinessObject()).orElse(null);
} else if (element instanceof BusinessObjectContext) {
final BusinessObjectContext boc = (BusinessObjectContext) element;
final Object bo = boc.getBusinessObject();
return UiUtil.getImage(extRegistry, bo).orElse(null);
}
return null;
}
};
viewer.setLabelProvider(new StyledCellLabelProvider(StyledCellLabelProvider.COLORS_ON_SELECTION) {
@Override
public void update(final ViewerCell cell) {
final Object element = cell.getElement();
cell.setText(innerLabelProvider.getText(element));
cell.setForeground(element instanceof DiagramNode ? null : Display.getCurrent().getSystemColor(SWT.COLOR_GRAY));
cell.setImage(innerLabelProvider.getImage(element));
}
});
viewer.setComparator(new ViewerComparator() {
@Override
public int compare(final Viewer viewer, final Object e1, final Object e2) {
final String t1 = innerLabelProvider.getText(e1);
final String t2 = innerLabelProvider.getText(e2);
return getComparator().compare(t1, t2);
}
});
viewer.addDoubleClickListener(event -> UiUtil.openPropertiesView());
final MenuManager menuMgr = new MenuManager();
menuMgr.setRemoveAllWhenShown(true);
final Tree tree = viewer.getTree();
final Menu menu = menuMgr.createContextMenu(tree);
tree.setMenu(menu);
// Allow contributions
getSite().registerContextMenu("org.osate.ge.editor.AgeDiagramEditor", menuMgr, viewer);
editor.addSelectionChangedListener(event -> updateOutlineSelectionIfLinked());
editor.getDiagram().addModificationListener(diagramModificationListener);
viewer.addSelectionChangedListener(this);
viewer.setInput(editor);
}
use of org.osate.ge.businessobjecthandling.GetNameContext in project osate2 by osate.
the class UiUtil method getDescription.
/**
* Returns a user friendly description for a business object context. This method determines the appropriate business object handler
* and uses it to to retrieve the name.
* This method adds descriptive prefixes in some cases.
* It is advised to use other methods when working with diagram elements in order to avoid calling the business object handlers.
* @param boc the business object context for which to retrieve the description
* @param extService the extension registry
* @return the description of the business object context
*/
public static String getDescription(final BusinessObjectContext boc, final ExtensionRegistryService extService) {
// Build a prefix based on the business object type
final Object bo = boc.getBusinessObject();
final String prefix;
if (bo instanceof EObject) {
prefix = StringUtil.camelCaseToUser(((EObject) bo).eClass().getName()) + " ";
} else {
prefix = "";
}
// Call the business object handler's GetName method
String baseName;
if (bo instanceof BusinessObjectProxy) {
baseName = ((BusinessObjectProxy) bo).getName();
} else {
final BusinessObjectHandler boh = extService.getApplicableBusinessObjectHandler(bo);
if (boh == null) {
baseName = null;
} else {
baseName = boh.getName(new GetNameContext(bo));
}
}
if (Strings.isNullOrEmpty(baseName)) {
final String typeName = StringUtil.camelCaseToUser(bo instanceof EObject ? ((EObject) bo).eClass().getName() : bo.getClass().getName());
return typeName;
}
return prefix + baseName;
}
Aggregations