Skip to content

Commit

Permalink
Change Implementation for folders in metadata items. #4712
Browse files Browse the repository at this point in the history
  • Loading branch information
@hansva
hansva committed Dec 16, 2024
1 parent ba1ea47 commit 2291fa6
Show file tree
Hide file tree
Showing 6 changed files with 196 additions and 28 deletions.
47 changes: 47 additions & 0 deletions core/src/main/java/org/apache/hop/metadata/api/HopMetadataBase.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ public class HopMetadataBase implements IHopMetadata {
/** All metadata objects have a name to uniquely identify it. */
@HopMetadataProperty protected String name;

/** All metadata objects can have a virtual path to organize them */
@HopMetadataProperty protected String virtualPath;

/**
* The metadata provider name is optionally used at runtime to figure out where the metadata came
* from. Optionally used by plugins. It's volatile because it's never persisted.
Expand All @@ -36,6 +39,13 @@ public HopMetadataBase() {}
public HopMetadataBase(String name) {
this();
this.name = name;
this.virtualPath = "";
}

public HopMetadataBase(String name, String virtualPath) {
this();
this.name = name;
this.virtualPath = virtualPath;
}

@Override
Expand Down Expand Up @@ -96,4 +106,41 @@ public String getMetadataProviderName() {
public void setMetadataProviderName(String metadataProviderName) {
this.metadataProviderName = metadataProviderName;
}

/**
* Get the virtual path set on a metadata item
*
* @return a String representing the virtual path
*/
@Override
public String getVirtualPath() {
return virtualPath;
}

/**
* Set the virtual path on a metadata item
*
* @param virtualPath the virtual path to set to the metadata item
*/
@Override
public void setVirtualPath(String virtualPath) {
this.virtualPath = virtualPath;
}

/**
* Return the virtual path and name of the object
*
* @return the virtual path and name of the object
*/
@Override
public String getFullName() {
if (virtualPath == null || virtualPath.isEmpty()) {
return name;
}
if (virtualPath.endsWith("/")) {
return virtualPath + name;
} else {
return virtualPath + "/" + name;
}
}
}
19 changes: 19 additions & 0 deletions core/src/main/java/org/apache/hop/metadata/api/IHopMetadata.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,23 @@ public interface IHopMetadata {
* @param metadataProviderName The source of metadata or null if it's not specified
*/
void setMetadataProviderName(String metadataProviderName);

/**
* @return the virtual path for organizing metadata items
*/
String getVirtualPath();

/**
* Set the virtual path on a metadata item
*
* @param virtualPath the virtual path to set to the metadata item
*/
void setVirtualPath(String virtualPath);

/**
* Get the complete name of the object (virtual path + name)
*
* @return the full name of the object
*/
String getFullName();
}
3 changes: 2 additions & 1 deletion ui/src/main/java/org/apache/hop/ui/core/metadata/MetadataManager.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ public T newMetadata(T element) {
}
}

public T newMetadataWithEditor() {
public T newMetadataWithEditor(String virtualPath) {
HopGui hopGui = HopGui.getInstance();

try {
Expand All @@ -456,6 +456,7 @@ public T newMetadataWithEditor() {
//
T element = managedClass.getDeclaredConstructor().newInstance();
initializeElementVariables(element);
element.setVirtualPath(virtualPath);

ExtensionPointHandler.callExtensionPoint(
hopGui.getLog(),
Expand Down
3 changes: 2 additions & 1 deletion ui/src/main/java/org/apache/hop/ui/hopgui/context/metadata/MetadataContextHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,8 @@ public List<GuiAction> getSupportedActions() {
+ " : "
+ TranslateUtil.translate(hopMetadata.description(), metadataObjectClass),
hopMetadata.image(),
(shiftClicked, controlClicked, parameters) -> metadataManager.newMetadataWithEditor());
(shiftClicked, controlClicked, parameters) ->
metadataManager.newMetadataWithEditor(""));
newAction.setClassLoader(metadataObjectClass.getClassLoader());
newAction.setCategory(CONST_METADATA);
newAction.setCategoryOrder("2");
Expand Down
141 changes: 115 additions & 26 deletions ui/src/main/java/org/apache/hop/ui/hopgui/perspective/metadata/MetadataPerspective.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@
import org.apache.hop.ui.core.ConstUi;
import org.apache.hop.ui.core.PropsUi;
import org.apache.hop.ui.core.bus.HopGuiEvents;
import org.apache.hop.ui.core.dialog.EnterStringDialog;
import org.apache.hop.ui.core.dialog.ErrorDialog;
import org.apache.hop.ui.core.dialog.ShowMessageDialog;
import org.apache.hop.ui.core.gui.GuiResource;
import org.apache.hop.ui.core.gui.GuiToolbarWidgets;
import org.apache.hop.ui.core.metadata.MetadataEditor;
Expand Down Expand Up @@ -265,38 +267,44 @@ protected void createTree(Composite parent) {
// Show the menu
//
Menu menu = new Menu(tree);
MenuItem menuItem;

switch ((String) treeItem.getData("type")) {
case "MetadataItem":
case "Folder":
menuItem = new MenuItem(menu, SWT.POP_UP);
menuItem.setText(BaseMessages.getString(PKG, "MetadataPerspective.Menu.New"));
menuItem.addListener(SWT.Selection, e -> onNewMetadata());
menuItem = new MenuItem(menu, SWT.POP_UP);
menuItem.setText(BaseMessages.getString(PKG, "MetadataPerspective.Menu.NewFolder"));
menuItem.addListener(SWT.Selection, e -> createNewFolder());
new MenuItem(menu, SWT.SEPARATOR);
break;
case "File":
menuItem = new MenuItem(menu, SWT.POP_UP);
menuItem.setText(BaseMessages.getString(PKG, "MetadataPerspective.Menu.Edit"));
menuItem.addListener(SWT.Selection, e -> onEditMetadata());

MenuItem menuItem = new MenuItem(menu, SWT.POP_UP);
menuItem.setText("New");
menuItem.addListener(SWT.Selection, e -> onNewMetadata());

new MenuItem(menu, SWT.SEPARATOR);

if (treeItem.getParentItem() != null) {

menuItem = new MenuItem(menu, SWT.POP_UP);
menuItem.setText("Edit");
menuItem.addListener(SWT.Selection, e -> onEditMetadata());

menuItem = new MenuItem(menu, SWT.POP_UP);
menuItem.setText("Rename");
menuItem.addListener(SWT.Selection, e -> onRenameMetadata());
menuItem = new MenuItem(menu, SWT.POP_UP);
menuItem.setText(BaseMessages.getString(PKG, "MetadataPerspective.Menu.Rename"));
menuItem.addListener(SWT.Selection, e -> onRenameMetadata());

menuItem = new MenuItem(menu, SWT.POP_UP);
menuItem.setText("Duplicate");
menuItem.addListener(SWT.Selection, e -> duplicateMetadata());
menuItem = new MenuItem(menu, SWT.POP_UP);
menuItem.setText(BaseMessages.getString(PKG, "MetadataPerspective.Menu.Duplicate"));
menuItem.addListener(SWT.Selection, e -> duplicateMetadata());

new MenuItem(menu, SWT.SEPARATOR);
new MenuItem(menu, SWT.SEPARATOR);

menuItem = new MenuItem(menu, SWT.POP_UP);
menuItem.setText("Delete");
menuItem.addListener(SWT.Selection, e -> onDeleteMetadata());
menuItem = new MenuItem(menu, SWT.POP_UP);
menuItem.setText(BaseMessages.getString(PKG, "MetadataPerspective.Menu.Delete"));
menuItem.addListener(SWT.Selection, e -> onDeleteMetadata());

new MenuItem(menu, SWT.SEPARATOR);
new MenuItem(menu, SWT.SEPARATOR);
break;
}

menuItem = new MenuItem(menu, SWT.POP_UP);
menuItem.setText("Help");
menuItem.setText(BaseMessages.getString(PKG, "MetadataPerspective.Menu.Help"));
menuItem.addListener(SWT.Selection, e -> onHelpMetadata());

tree.setMenu(menu);
Expand Down Expand Up @@ -526,7 +534,7 @@ public void onNewMetadata() {
metadataClass,
hopGui.getShell());

manager.newMetadataWithEditor();
manager.newMetadataWithEditor((String) treeItem.getData("virtualPath"));

hopGui.getEventsHandler().fire(HopGuiEvents.MetadataCreated.name());
} catch (Exception e) {
Expand Down Expand Up @@ -802,6 +810,8 @@ public void refresh() {
classItem.setExpanded(true);
classItem.setData(annotation.key());
classItem.setData(KEY_HELP, annotation.description());
classItem.setData("virtualPath", "");
classItem.setData("type", "MetadataItem");

// level 1: object names
//
Expand All @@ -811,8 +821,48 @@ public void refresh() {
Collections.sort(names);

for (final String name : names) {
TreeItem item = new TreeItem(classItem, SWT.NONE);
IHopMetadata hopMetadata = serializer.load(name);
TreeItem parentItem = classItem;

if (hopMetadata.getVirtualPath() != null && !hopMetadata.getVirtualPath().isEmpty()) {
List<String> folders =
new ArrayList<>(Arrays.asList(hopMetadata.getVirtualPath().split("/")));
// remove empty elements
folders.removeAll(Arrays.asList("", null));

for (String folder : folders) {
TreeItem alreadyExists = null;
if (!folder.isEmpty()) {
// check if folder already exists on this level
alreadyExists = null;
for (TreeItem childItem : parentItem.getItems()) {
if (childItem.getData("type").equals("Folder")
&& childItem.getText().equals(folder)) {
alreadyExists = childItem;
}
}

if (alreadyExists != null) {
parentItem = alreadyExists;
} else {
TreeItem folderItem = new TreeItem(parentItem, SWT.NONE);
folderItem.setText(folder);
folderItem.setData(annotation.key());
folderItem.setImage(GuiResource.getInstance().getImageFolder());
folderItem.setData(
"virtualPath",
folderItem.getParentItem().getData("virtualPath") + "/" + folder);
folderItem.setData("type", "Folder");
parentItem = folderItem;
}
}
}
}

TreeItem item = new TreeItem(parentItem, SWT.NONE);
item.setText(0, Const.NVL(name, ""));
item.setData("virtualPath", parentItem.getData("virtualPath"));
item.setData("type", "File");
MetadataEditor<?> editor = this.findEditor(annotation.key(), name);
if (editor != null && editor.hasChanged()) {
item.setFont(GuiResource.getInstance().getFontBold());
Expand Down Expand Up @@ -1000,4 +1050,43 @@ public void goToElement(Class<? extends IHopMetadata> managedClass, String eleme
}
}
}

public void createNewFolder() {
TreeItem[] selection = tree.getSelection();
if (selection == null || selection.length == 0) {
return;
}
TreeItem item = selection[0];
EnterStringDialog dialog =
new EnterStringDialog(
getShell(),
"",
BaseMessages.getString(PKG, "MetadataPerspective.CreateFolder.Header"),
BaseMessages.getString(
PKG,
"MetadataPerspective.CreateFolder.Message",
(String) item.getData("virtualPath")));
String folder = dialog.open();
if (folder != null) {
for (TreeItem treeItem : item.getItems()) {
if (folder.equals(treeItem.getText())) {
ShowMessageDialog msgDialog =
new ShowMessageDialog(
getShell(),
SWT.ICON_INFORMATION | SWT.OK,
BaseMessages.getString(PKG, "MetadataPerspective.CreateFolder.Error.Header"),
BaseMessages.getString(PKG, "MetadataPerspective.CreateFolder.Error.Message"),
false);
msgDialog.open();
return;
}
}
TreeItem newFolder = new TreeItem(item, SWT.NONE);
newFolder.setText(folder);
newFolder.setData(item.getData());
newFolder.setImage(GuiResource.getInstance().getImageFolder());
newFolder.setData("virtualPath", item.getData("virtualPath") + "/" + folder);
newFolder.setData("type", "Folder");
}
}
}
11 changes: 11 additions & 0 deletions ...esources/org/apache/hop/ui/hopgui/perspective/metadata/messages/messages_en_US.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,14 @@ MetadataPerspective.ToolbarElement.Delete.Tooltip=Delete
MetadataPerspective.ToolbarElement.Edit.Tooltip=Edit
MetadataPerspective.ToolbarElement.New.Tooltip=Create a new metadata element
MetadataPerspective.ToolbarElement.Refresh.Tooltip=Refresh
MetadataPerspective.CreateFolder.Header=Create directory
MetadataPerspective.CreateFolder.Message=Please enter name of the folder to create in: ''{0}''
MetadataPerspective.CreateFolder.Error.Header=Cannot Create folder
MetadataPerspective.CreateFolder.Error.Message=Folder already exists
MetadataPerspective.Menu.New=New
MetadataPerspective.Menu.NewFolder=New Folder
MetadataPerspective.Menu.Edit=Edit
MetadataPerspective.Menu.Rename=Rename
MetadataPerspective.Menu.Duplicate=Duplicate
MetadataPerspective.Menu.Delete=Delete
MetadataPerspective.Menu.Help=Help

0 comments on commit 2291fa6

Please sign in to comment.