use of org.knime.core.node.workflow.WorkflowManager in project knime-core by knime.
the class SandboxedNodeCreator method copyExistingTablesIntoSandboxContainer.
/**
* Copies the tables (port and internal) into the context of the corresponding node in the targetWFM. The execution
* result must fit to the passed node container.
*
* @param execResult the object holding the result of the sourceNC. If the sourceNC is a workflow, this must hold
* all results of all contained nodes.
* @param sourceNC the node that produced the execution result.
* @param targetNC the context into which the tables are copied into
* @param progressMon For progress information
* @param copyDataIntoNewContext as per {@link #setCopyData(boolean)}
* @throws CanceledExecutionException
* @throws IOException
*/
public static void copyExistingTablesIntoSandboxContainer(final NodeContainerExecutionResult execResult, final NodeContainer sourceNC, final NodeContainer targetNC, final ExecutionMonitor progressMon, final boolean copyDataIntoNewContext) throws CanceledExecutionException, IOException {
assert targetNC.getNrOutPorts() == sourceNC.getNrOutPorts();
if (execResult instanceof NativeNodeContainerExecutionResult) {
NativeNodeContainerExecutionResult sncResult = (NativeNodeContainerExecutionResult) execResult;
// execResult and node types must match
assert sourceNC instanceof NativeNodeContainer;
assert targetNC instanceof NativeNodeContainer;
// data is to copy ... get the correct execution context
ExecutionContext targetExec = copyDataIntoNewContext ? ((SingleNodeContainer) targetNC).createExecutionContext() : null;
NodeExecutionResult ner = sncResult.getNodeExecutionResult();
// TODO this copy process has to take place in a different place
// though it needs the final execution context for correct copy
// of BDT objects
PortObject[] resultTables = new PortObject[targetNC.getNrOutPorts()];
int copyCount = resultTables.length;
// copy also the internally held tables (such as for instance
// the table in the table view) -- use the copy of the outports
// if they match (likely they don't)
PortObject[] oldInternTables = ner.getInternalHeldPortObjects();
PortObject[] newInternTables = null;
if (oldInternTables != null) {
newInternTables = new PortObject[oldInternTables.length];
copyCount += newInternTables.length;
}
// skip flow variable output
for (int i = 0; i < resultTables.length; i++) {
ExecutionMonitor sub = progressMon.createSubProgress(1.0 / copyCount);
progressMon.setMessage("Port " + i);
PortObject o = ner.getPortObject(i);
PortObject newPO = copyPortObject(o, sub, targetExec);
if (newInternTables != null) {
for (int j = 0; j < oldInternTables.length; j++) {
if (oldInternTables[j] == o) {
newInternTables[j] = newPO;
}
}
}
sub.setProgress(1.0);
resultTables[i] = newPO;
}
if (newInternTables != null) {
for (int i = 0; i < newInternTables.length; i++) {
ExecutionMonitor sub = progressMon.createSubProgress(1.0 / copyCount);
progressMon.setMessage("Internal Table " + i);
if (newInternTables[i] == null) {
PortObject oldT = oldInternTables[i];
PortObject newT = copyPortObject(oldT, sub, targetExec);
newInternTables[i] = newT;
}
sub.setProgress(1.0);
}
}
if (oldInternTables != null) {
ner.setInternalHeldPortObjects(newInternTables);
}
ner.setPortObjects(resultTables);
} else if (execResult instanceof WorkflowExecutionResult) {
WorkflowExecutionResult wfmResult = (WorkflowExecutionResult) execResult;
// exec result and node types must match
WorkflowManager targetWFM = (WorkflowManager) targetNC;
WorkflowManager sourceWFM = (WorkflowManager) sourceNC;
copyIntoSandboxContainerRecursive(sourceWFM, targetWFM, wfmResult, progressMon, copyDataIntoNewContext);
} else if (execResult instanceof SubnodeContainerExecutionResult) {
SubnodeContainerExecutionResult subResult = (SubnodeContainerExecutionResult) execResult;
WorkflowExecutionResult wfmResult = subResult.getWorkflowExecutionResult();
WorkflowManager targetWFM = ((SubNodeContainer) targetNC).getWorkflowManager();
WorkflowManager sourceWFM = ((SubNodeContainer) sourceNC).getWorkflowManager();
copyIntoSandboxContainerRecursive(sourceWFM, targetWFM, wfmResult, progressMon, copyDataIntoNewContext);
} else {
throw new IllegalStateException("Unsupported node result type: " + execResult.getClass().getSimpleName());
}
}
use of org.knime.core.node.workflow.WorkflowManager in project knime-core by knime.
the class SandboxedNodeCreator method getFlowVariablesOnPort.
/**
* Checks which flow variables are available on a port by looking on the output port connected to this input port.
*
* @param portIdx input port of the {@link NodeContainer} {@link #m_nc}
* @return the flow variables available at this port
*/
private List<FlowVariable> getFlowVariablesOnPort(final int portIdx) {
WorkflowManager wfm = m_nc.getParent();
Optional<Stream<FlowVariable>> nodeInputFlowVariables = wfm.getNodeInputFlowVariables(m_nc.getID(), portIdx);
if (nodeInputFlowVariables.isPresent()) {
List<FlowVariable> result = nodeInputFlowVariables.get().filter(fv -> !fv.isGlobalConstant()).collect(Collectors.toList());
// getNodeInputFlowVariables returns top down, make sure iterations on list return oldest entry first
// (will be pushed onto node stack using an iterator)
Collections.reverse(result);
return result;
}
return Collections.emptyList();
}
use of org.knime.core.node.workflow.WorkflowManager in project knime-core by knime.
the class SandboxedNodeCreator method deepCopyFilesInWorkflowDir.
/**
* Deep copies data and drop folders contained in the source directory to the target directory.
* @param source Source node
* @param targetParent Target node's parent
*/
private static void deepCopyFilesInWorkflowDir(final NodeContainer source, final WorkflowManager targetParent) {
NodeContainer target = targetParent.getNodeContainer(targetParent.getID().createChild(source.getID().getIndex()));
ReferencedFile sourceDirRef = source.getNodeContainerDirectory();
ReferencedFile targetDirRef = target.getNodeContainerDirectory();
if (sourceDirRef == null) {
// The source node has never been saved, there are no files to copy
return;
}
File sourceDir = sourceDirRef.getFile();
File targetDir = targetDirRef.getFile();
for (String magicFolderName : MAGIC_DATA_FOLDERS) {
File dataSourceDir = new File(sourceDir, magicFolderName);
if (dataSourceDir.isDirectory()) {
File dataTargetDir = new File(targetDir, magicFolderName);
try {
FileUtils.copyDirectory(dataSourceDir, dataTargetDir);
LOGGER.debugWithFormat("Copied directory \"%s\" to \"%s\"", dataSourceDir.getAbsolutePath(), dataTargetDir.getAbsolutePath());
} catch (IOException ex) {
LOGGER.error(String.format("Could not copy directory \"%s\" to \"%s\": %s", dataSourceDir.getAbsolutePath(), dataTargetDir.getAbsolutePath(), ex.getMessage()), ex);
}
}
}
Collection<NodeContainer> childrenList = Collections.emptyList();
WorkflowManager childTargetParent = null;
if (source instanceof WorkflowManager) {
childrenList = ((WorkflowManager) source).getNodeContainers();
childTargetParent = (WorkflowManager) target;
} else if (source instanceof SubNodeContainer) {
childrenList = ((SubNodeContainer) source).getWorkflowManager().getNodeContainers();
childTargetParent = ((SubNodeContainer) target).getWorkflowManager();
}
for (NodeContainer child : childrenList) {
deepCopyFilesInWorkflowDir(child, childTargetParent);
}
}
use of org.knime.core.node.workflow.WorkflowManager in project knime-core by knime.
the class NodeLogger method getLogObject.
/**
* @param message the logging message
* @return a KNIMELogMessage that not only contains the log message but also the information about the workflow
* and node that belong to the log message if applicable
*/
private Object getLogObject(final Object message) {
if (!LOG_NODE_ID && !LOG_IN_WF_DIR && !LOG_WF_DIR) {
return message;
}
final NodeContext context = NodeContext.getContext();
NodeID nodeID = null;
String nodeName = null;
File workflowDir = null;
if (context != null) {
if (LOG_NODE_ID) {
// retrieve and store the node id only if the user has requested to log it
final NodeContainer nodeContainer = context.getNodeContainer();
if (nodeContainer != null) {
nodeID = nodeContainer.getID();
nodeName = nodeContainer.getName();
}
}
if (LOG_IN_WF_DIR || LOG_WF_DIR) {
final WorkflowManager workflowManager = context.getWorkflowManager();
if (workflowManager != null) {
final WorkflowContext workflowContext = workflowManager.getContext();
if (workflowContext != null) {
workflowDir = workflowContext.getCurrentLocation();
}
}
}
}
return new KNIMELogMessage(nodeID, nodeName, workflowDir, message);
}
use of org.knime.core.node.workflow.WorkflowManager in project knime-core by knime.
the class WorkflowContextMenuProvider method buildContextMenu.
/**
* {@inheritDoc}
*/
@Override
public void buildContextMenu(final IMenuManager manager) {
final String FLOW_VAR_PORT_GRP = "Flow Variable Ports";
// add the groups (grouped by separators) in their order first
manager.add(new Separator(IWorkbenchActionConstants.GROUP_APP));
manager.add(new Separator(FLOW_VAR_PORT_GRP));
GEFActionConstants.addStandardActionGroups(manager);
IAction action;
action = m_actionRegistry.getAction("cut");
manager.appendToGroup(GEFActionConstants.GROUP_EDIT, action);
((UpdateAction) action).update();
action = m_actionRegistry.getAction("copy");
manager.appendToGroup(GEFActionConstants.GROUP_EDIT, action);
((UpdateAction) action).update();
action = m_actionRegistry.getAction(PasteActionContextMenu.ID);
manager.appendToGroup(GEFActionConstants.GROUP_EDIT, action);
((UpdateAction) action).update();
action = m_actionRegistry.getAction("undo");
manager.appendToGroup(GEFActionConstants.GROUP_EDIT, action);
((UpdateAction) action).update();
action = m_actionRegistry.getAction("redo");
manager.appendToGroup(GEFActionConstants.GROUP_EDIT, action);
((UpdateAction) action).update();
action = m_actionRegistry.getAction("delete");
manager.appendToGroup(GEFActionConstants.GROUP_EDIT, action);
((UpdateAction) action).update();
// Add (some) available actions from the registry to the context menu
// manager
// openDialog
action = m_actionRegistry.getAction(OpenDialogAction.ID);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
((AbstractNodeAction) action).update();
// execute
action = m_actionRegistry.getAction(ExecuteAction.ID);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
((AbstractNodeAction) action).update();
// execute and open first view
action = m_actionRegistry.getAction(ExecuteAndOpenViewAction.ID);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
((AbstractNodeAction) action).update();
// cancel execution
action = m_actionRegistry.getAction(CancelAction.ID);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
((AbstractNodeAction) action).update();
// show some menu items on LoopEndNodes only
List parts = m_viewer.getSelectedEditParts();
if (parts.size() == 1) {
EditPart p = (EditPart) parts.get(0);
if (p instanceof NodeContainerEditPart) {
NodeContainerUI container = (NodeContainerUI) ((NodeContainerEditPart) p).getModel();
if (container instanceof SingleNodeContainerUI) {
SingleNodeContainerUI snc = (SingleNodeContainerUI) container;
Wrapper.unwrapOptional(snc, SingleNodeContainer.class).ifPresent(sncImpl -> {
if (sncImpl.isModelCompatibleTo(LoopEndNode.class)) {
// pause loop execution
IAction loopAction;
loopAction = m_actionRegistry.getAction(PauseLoopExecutionAction.ID);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, loopAction);
((AbstractNodeAction) loopAction).update();
// step loop execution
loopAction = m_actionRegistry.getAction(StepLoopAction.ID);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, loopAction);
((AbstractNodeAction) loopAction).update();
// resume loop execution
loopAction = m_actionRegistry.getAction(ResumeLoopAction.ID);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, loopAction);
((AbstractNodeAction) loopAction).update();
}
});
}
}
}
// reset
action = m_actionRegistry.getAction(ResetAction.ID);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
((AbstractNodeAction) action).update();
// set name and description
action = m_actionRegistry.getAction(SetNodeDescriptionAction.ID);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
((AbstractNodeAction) action).update();
// add workflow annotation
action = m_actionRegistry.getAction(AddAnnotationAction.ID);
AddAnnotationAction aaa = (AddAnnotationAction) action;
aaa.setLocation(m_lastLocation.x, m_lastLocation.y);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
((AbstractNodeAction) action).update();
// collapse metanodes
action = m_actionRegistry.getAction(CollapseMetaNodeAction.ID);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
((AbstractNodeAction) action).update();
action = m_actionRegistry.getAction(EncapsulateSubNodeAction.ID);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
((AbstractNodeAction) action).update();
// insert "select loop" if loop nodes are selected
boolean addSelectLoop = true;
for (Object p : parts) {
if (!(p instanceof NodeContainerEditPart)) {
addSelectLoop = false;
break;
}
NodeContainerUI nc = ((NodeContainerEditPart) p).getNodeContainer();
if (!(nc instanceof SingleNodeContainerUI)) {
addSelectLoop = false;
break;
}
if (!((SingleNodeContainerUI) nc).isMemberOfScope()) {
addSelectLoop = false;
break;
}
}
if (addSelectLoop) {
action = m_actionRegistry.getAction(SelectLoopAction.ID);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
((AbstractNodeAction) action).update();
}
IMenuManager metanodeMenuMgr = null;
IMenuManager subnodeMenuMgr = null;
IMenuManager subnodeViewMgr = null;
// depending on the current selection: add the actions for the port
// views and the node views
// also check whether this node part is a meta-node
// if so offer the "edit meta-node" option
// all these feature are only offered if exactly 1 part is selected
parts = m_viewer.getSelectedEditParts();
// by now, we only support one part...
if (parts.size() == 1) {
EditPart p = (EditPart) parts.get(0);
if (p instanceof WorkflowInPortBarEditPart) {
WorkflowInPortBarEditPart root = (WorkflowInPortBarEditPart) p;
manager.add(new Separator("outPortViews"));
for (Object o : p.getChildren()) {
EditPart child = (EditPart) o;
if (child instanceof WorkflowInPortEditPart && ((WorkflowInPortEditPart) child).isSelected()) {
final WorkflowManager wm = Wrapper.unwrapWFM(((WorkflowPortBar) root.getModel()).getWorkflowManager());
action = new OpenWorkflowPortViewAction(wm, ((WorkflowInPortEditPart) child).getIndex(), wm.getNrInPorts());
manager.appendToGroup("outPortViews", action);
((WorkflowInPortEditPart) child).setSelected(false);
}
}
}
if (p instanceof NodeContainerEditPart) {
NodeContainerUI container = null;
container = (NodeContainerUI) ((NodeContainerEditPart) p).getModel();
if (!(container instanceof WorkflowManagerUI)) {
action = m_actionRegistry.getAction(ToggleFlowVarPortsAction.ID);
manager.appendToGroup(FLOW_VAR_PORT_GRP, action);
((AbstractNodeAction) action).update();
}
// add for node views option if applicable
int numNodeViews = container.getNrViews();
for (int i = 0; i < numNodeViews; i++) {
action = new OpenViewAction(unwrapNC(container), i);
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
}
// add interactive view options
if (container.hasInteractiveView()) {
action = new OpenInteractiveViewAction(unwrapNC(container));
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
} else {
// TODO for subnodes move to submenu?
if (wraps(container, NativeNodeContainer.class)) {
InteractiveWebViewsResult interactiveWebViewsResult = unwrapNC(container).getInteractiveWebViews();
for (int i = 0; i < interactiveWebViewsResult.size(); i++) {
action = new OpenInteractiveWebViewAction(unwrapNC(container), interactiveWebViewsResult.get(i));
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
}
}
}
if (container instanceof WorkflowManagerUI) {
metanodeMenuMgr = getMetaNodeMenuManager(metanodeMenuMgr, manager);
// OPEN META NODE
action = new OpenSubworkflowEditorAction((NodeContainerEditPart) p);
metanodeMenuMgr.appendToGroup(GROUP_METANODE, action);
// EXPAND META NODE
action = m_actionRegistry.getAction(ExpandMetaNodeAction.ID);
metanodeMenuMgr.appendToGroup(GROUP_METANODE, action);
((AbstractNodeAction) action).update();
// RECONFIGURE META NODE
if (parts.size() == 1) {
action = m_actionRegistry.getAction(MetaNodeReconfigureAction.ID);
metanodeMenuMgr.appendToGroup(GROUP_METANODE, action);
((AbstractNodeAction) action).update();
}
// WRAP
action = m_actionRegistry.getAction(ConvertMetaNodeToSubNodeAction.ID);
metanodeMenuMgr.appendToGroup(GROUP_METANODE, action);
((AbstractNodeAction) action).update();
}
// SUBNODE
if (container instanceof SubNodeContainerUI) {
subnodeMenuMgr = getSubNodeMenuManager(subnodeMenuMgr, manager);
// OPEN SUBNODE
action = new OpenSubNodeEditorAction((NodeContainerEditPart) p);
subnodeMenuMgr.appendToGroup(GROUP_SUBNODE, action);
// EXPAND SUBNODE
action = m_actionRegistry.getAction(ExpandSubNodeAction.ID);
subnodeMenuMgr.appendToGroup(GROUP_SUBNODE, action);
((AbstractNodeAction) action).update();
// RECONFIGURE SUBNODE
action = m_actionRegistry.getAction(SubNodeReconfigureAction.ID);
subnodeMenuMgr.appendToGroup(GROUP_SUBNODE, action);
((AbstractNodeAction) action).update();
// UNWRAP
action = m_actionRegistry.getAction(ConvertSubNodeToMetaNodeAction.ID);
subnodeMenuMgr.appendToGroup(GROUP_SUBNODE, action);
((AbstractNodeAction) action).update();
if (wraps(container, SubNodeContainer.class)) {
InteractiveWebViewsResult interactiveWebViewsResult = unwrapNC(container).getInteractiveWebViews();
if (interactiveWebViewsResult.size() > 0) {
subnodeViewMgr = getSingleSubNodeViewsMenuManager(subnodeViewMgr, subnodeMenuMgr);
for (int i = 0; i < interactiveWebViewsResult.size(); i++) {
action = new OpenInteractiveWebViewAction(unwrapNC(container), interactiveWebViewsResult.get(i));
subnodeViewMgr.appendToGroup(GROUP_SUBNODE_VIEWS, action);
}
}
action = new OpenSubnodeWebViewAction(Wrapper.unwrap(container, SubNodeContainer.class));
manager.appendToGroup(IWorkbenchActionConstants.GROUP_APP, action);
}
}
// add port views
manager.add(new Separator("outPortViews"));
int numOutPorts = container.getNrOutPorts();
for (int i = 0; i < numOutPorts; i++) {
if (i == 0 && !(container instanceof WorkflowManagerUI)) {
// skip the implicit flow var ports on "normal" nodes
continue;
}
if (wraps(container, NodeContainer.class)) {
action = new OpenPortViewAction(unwrapNC(container), i, numOutPorts);
manager.appendToGroup("outPortViews", action);
}
}
}
}
boolean addMetaNodeActions = false;
boolean addSubNodeActions = false;
for (Object p : parts) {
if (p instanceof NodeContainerEditPart) {
NodeContainerUI model = ((NodeContainerEditPart) p).getNodeContainer();
if (model instanceof WorkflowManagerUI) {
addMetaNodeActions = true;
} else if (model instanceof SubNodeContainerUI) {
addSubNodeActions = true;
}
}
}
if (addMetaNodeActions) {
metanodeMenuMgr = getMetaNodeMenuManager(metanodeMenuMgr, manager);
// SAVE AS TEMPLATE
action = m_actionRegistry.getAction(SaveAsMetaNodeTemplateAction.ID);
metanodeMenuMgr.appendToGroup(GROUP_METANODE_LINKS, action);
((AbstractNodeAction) action).update();
// CHECK UPDATE
action = m_actionRegistry.getAction(CheckUpdateMetaNodeLinkAction.ID);
metanodeMenuMgr.appendToGroup(GROUP_METANODE_LINKS, action);
((AbstractNodeAction) action).update();
// DISCONNECT
action = m_actionRegistry.getAction(DisconnectMetaNodeLinkAction.ID);
metanodeMenuMgr.appendToGroup(GROUP_METANODE_LINKS, action);
((AbstractNodeAction) action).update();
// LINK TYPE
action = m_actionRegistry.getAction(ChangeMetaNodeLinkAction.ID);
metanodeMenuMgr.appendToGroup(GROUP_METANODE_LINKS, action);
((AbstractNodeAction) action).update();
// REVEAL TEMPLATE
action = m_actionRegistry.getAction(RevealMetaNodeTemplateAction.ID);
metanodeMenuMgr.appendToGroup(GROUP_METANODE_LINKS, action);
((AbstractNodeAction) action).update();
// LOCK
if (Boolean.getBoolean(KNIMEConstants.PROPERTY_SHOW_METANODE_LOCK_ACTION)) {
action = m_actionRegistry.getAction(LockMetaNodeAction.ID);
metanodeMenuMgr.appendToGroup(GROUP_METANODE, action);
((AbstractNodeAction) action).update();
}
}
if (addSubNodeActions) {
subnodeMenuMgr = getSubNodeMenuManager(subnodeMenuMgr, manager);
// SAVE AS TEMPLATE (SUBNODE)
action = m_actionRegistry.getAction(SaveAsSubNodeTemplateAction.ID);
subnodeMenuMgr.appendToGroup(GROUP_SUBNODE_LINKS, action);
((AbstractNodeAction) action).update();
// CHECK UPDATE (SUBNODE)
action = m_actionRegistry.getAction(CheckUpdateMetaNodeLinkAction.ID);
subnodeMenuMgr.appendToGroup(GROUP_SUBNODE_LINKS, action);
((AbstractNodeAction) action).update();
// DISCONNECT LINK (SUBNODE)
action = m_actionRegistry.getAction(DisconnectSubNodeLinkAction.ID);
subnodeMenuMgr.appendToGroup(GROUP_SUBNODE_LINKS, action);
((AbstractNodeAction) action).update();
// CHANGE LINK (SUBNODE)
action = m_actionRegistry.getAction(ChangeSubNodeLinkAction.ID);
subnodeMenuMgr.appendToGroup(GROUP_SUBNODE_LINKS, action);
((AbstractNodeAction) action).update();
// REVEAL TEMPLATE (SUBNODE)
action = m_actionRegistry.getAction(RevealSubNodeTemplateAction.ID);
subnodeMenuMgr.appendToGroup(GROUP_SUBNODE_LINKS, action);
((AbstractNodeAction) action).update();
// LOCK SUBNODE
if (Boolean.getBoolean(KNIMEConstants.PROPERTY_SHOW_METANODE_LOCK_ACTION)) {
action = m_actionRegistry.getAction(LockSubNodeAction.ID);
subnodeMenuMgr.appendToGroup(GROUP_SUBNODE, action);
((AbstractNodeAction) action).update();
}
}
manager.updateAll(true);
}
Aggregations