edu.cmu.tetradapp.app.SessionEditorWorkbench Maven / Gradle / Ivy
The newest version!
///////////////////////////////////////////////////////////////////////////////
// For information as to what this class does, see the Javadoc, below. //
// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, //
// 2007, 2008, 2009, 2010, 2014, 2015, 2022 by Peter Spirtes, Richard //
// Scheines, Joseph Ramsey, and Clark Glymour. //
// //
// This program is free software; you can redistribute it and/or modify //
// it under the terms of the GNU General Public License as published by //
// the Free Software Foundation; either version 2 of the License, or //
// (at your option) any later version. //
// //
// This program is distributed in the hope that it will be useful, //
// but WITHOUT ANY WARRANTY; without even the implied warranty of //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
// GNU General Public License for more details. //
// //
// You should have received a copy of the GNU General Public License //
// along with this program; if not, write to the Free Software //
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA //
///////////////////////////////////////////////////////////////////////////////
package edu.cmu.tetradapp.app;
import edu.cmu.tetrad.graph.*;
import edu.cmu.tetradapp.model.EditorUtils;
import edu.cmu.tetradapp.model.SessionNodeWrapper;
import edu.cmu.tetradapp.model.SessionWrapper;
import edu.cmu.tetradapp.session.*;
import edu.cmu.tetradapp.workbench.AbstractWorkbench;
import edu.cmu.tetradapp.workbench.DisplayNode;
import edu.cmu.tetradapp.workbench.IDisplayEdge;
import javax.swing.*;
import java.awt.*;
import java.rmi.MarshalledObject;
import java.util.Collections;
import java.util.List;
/**
* Adds the functionality needed to turn an abstract workbench into a workbench usable for editing sessions.
*
* @author josephramsey
* @version $Id: $Id
*/
public final class SessionEditorWorkbench extends AbstractWorkbench {
/**
* The string label of the next node to create.
*/
private String nextButtonType;
/**
* The simulation edu.cmu.tetrad.study. This contains a reference to the session being edited.
*/
private SimulationStudy simulationStudy;
/**
* Constructs a new workbench for the given SessionWrapper.
*
* @param sessionWrapper a {@link edu.cmu.tetradapp.model.SessionWrapper} object
*/
public SessionEditorWorkbench(SessionWrapper sessionWrapper) {
super(sessionWrapper);
sessionWrapper.addPropertyChangeListener(e -> {
String propertyName = e.getPropertyName();
if ("name".equals(propertyName)) {
firePropertyChange("name", e.getOldValue(),
e.getNewValue());
}
});
this.addPropertyChangeListener(evt -> {
if ("cloneMe".equals(evt.getPropertyName())) {
SessionEditorNode sessionEditorNode
= (SessionEditorNode) evt.getNewValue();
SessionNodeWrapper wrapper
= (SessionNodeWrapper) sessionEditorNode.getModelNode();
Object result;
try {
result = new MarshalledObject(wrapper).get();
} catch (Exception e1) {
e1.printStackTrace();
throw new IllegalStateException("Could not clone.");
}
SessionNodeWrapper clone = (SessionNodeWrapper) result;
List sessionElements = Collections.singletonList(clone);
Point point = EditorUtils.getTopLeftPoint(sessionElements);
point.translate(50, 50);
SessionWrapper sessionWrapper1 = (SessionWrapper) getGraph();
deselectAll();
sessionWrapper1.pasteSubsession(sessionElements, point);
selectNode(clone);
}
});
List nodes = getGraph().getNodes();
for (Object node1 : nodes) {
SessionNodeWrapper node = (SessionNodeWrapper) node1;
setRepetitionLabel(node.getSessionNode());
}
setRightClickPopupAllowed(false);
}
/**
* @return the model classes associated with the given button type.
* @throws NullPointerException if no classes are stored for the given type.
*/
private static Class[] getModelClasses(String nextButtonType) {
TetradApplicationConfig config = TetradApplicationConfig.getInstance();
SessionNodeConfig nodeConfig = config.getSessionNodeConfig(nextButtonType);
if (nodeConfig == null) {
throw new NullPointerException("There is no configuration for: " + nextButtonType);
}
return nodeConfig.getModels();
}
/**
* @param base the string base of the name--for example, "Graph".
* @return the next string in the sequence--for example, "Graph1".
*/
private static String nextUniqueName(String base, Graph graph) {
if (base == null) {
throw new NullPointerException("Base name must be non-null.");
}
int i = 0; // Sequence 1, 2, 3, ...
loop:
while (true) {
i++;
String name = base + i;
for (Node o : graph.getNodes()) {
if (o.getName().equals(name)) {
continue loop;
}
}
break;
}
return base + i;
}
/**
* getNewModelNode.
*
* @return a SessionNodeWrapper for a new SessionNode, the type of which is determined by the next button type, and
* the name of which is the next button type (a String) appended with the next available positive integer.
*/
public Node getNewModelNode() {
if (this.nextButtonType == null) {
throw new NullPointerException(
"Next button type must be a " + "non-null string.");
}
String name = SessionEditorWorkbench.nextUniqueName(this.nextButtonType, getGraph());
Class[] modelClasses = SessionEditorWorkbench.getModelClasses(this.nextButtonType);
SessionNode newNode
= new SessionNode(this.nextButtonType, name, modelClasses);
SessionNodeWrapper nodeWrapper = new SessionNodeWrapper(newNode);
nodeWrapper.setButtonType(this.nextButtonType);
return nodeWrapper;
}
/**
* {@inheritDoc}
*/
public DisplayNode getNewDisplayNode(Node modelNode) {
SessionNodeWrapper wrapper = (SessionNodeWrapper) modelNode;
SessionEditorNode displayNode = new SessionEditorNode(wrapper, getSimulationStudy());
displayNode.adjustToModel();
return displayNode;
}
/**
* {@inheritDoc}
*/
public Edge getNewModelEdge(Node node1, Node node2) {
return new Edge(node1, node2, Endpoint.TAIL, Endpoint.ARROW);
}
/**
* {@inheritDoc}
*/
public IDisplayEdge getNewTrackingEdge(DisplayNode node, Point mouseLoc) {
return new SessionEditorEdge((SessionEditorNode) node, mouseLoc);
}
/**
* {@inheritDoc}
*/
public IDisplayEdge getNewDisplayEdge(Edge modelEdge) {
Node modelNodeA = modelEdge.getNode1();
Node modelNodeB = modelEdge.getNode2();
DisplayNode displayNodeA
= (DisplayNode) (getModelNodesToDisplay().get(modelNodeA));
DisplayNode displayNodeB
= (DisplayNode) (getModelNodesToDisplay().get(modelNodeB));
if ((displayNodeA == null) || (displayNodeB == null)) {
return null;
}
SessionEditorNode sessionEditorNodeA = (SessionEditorNode) displayNodeA;
SessionEditorNode sessionEditorNodeB = (SessionEditorNode) displayNodeB;
return new SessionEditorEdge(sessionEditorNodeA, sessionEditorNodeB,
SessionEditorEdge.UNRANDOMIZED);
}
/**
* Getter for the field simulationStudy.
*
* @return a {@link SimulationStudy} object
*/
public SimulationStudy getSimulationStudy() {
if (this.simulationStudy == null) {
Session session = ((SessionWrapper) getGraph()).getSession();
this.simulationStudy = new SimulationStudy(session);
this.simulationStudy.addSessionListener(new SessionAdapter() {
public void repetitionChanged(SessionEvent event) {
setRepetitionLabel(event.getNode());
}
});
}
return this.simulationStudy;
}
/**
* Sets the type of the next button.
*
* @param nextButtonType the type of the next button
*/
public void setNextButtonType(String nextButtonType) {
this.nextButtonType = nextButtonType;
}
/**
* Pastes list of session elements into the workbench.
*
* @param sessionElements a {@link java.util.List} object
* @param point a {@link java.awt.Point} object
*/
public void pasteSubsession(List sessionElements, Point point) {
SessionWrapper sessionWrapper = (SessionWrapper) getGraph();
sessionWrapper.pasteSubsession(sessionElements, point);
deselectAll();
for (Object sessionElement : sessionElements) {
if (sessionElement instanceof GraphNode) {
Node modelNode = (Node) sessionElement;
selectNode(modelNode);
}
}
selectConnectingEdges();
}
/**
* getSessionWrapper.
*
* @return a {@link edu.cmu.tetradapp.model.SessionWrapper} object
*/
public SessionWrapper getSessionWrapper() {
return (SessionWrapper) getGraph();
}
/**
* Resets the session wrapper that this editor is editing to the given session wrapper.
*
* @param sessionWrapper a {@link edu.cmu.tetradapp.model.SessionWrapper} object
*/
public void setSessionWrapper(SessionWrapper sessionWrapper) {
this.setGraph(sessionWrapper);
// Force simulation edu.cmu.tetrad.study to be recreated.
this.simulationStudy = null;
sessionWrapper.addPropertyChangeListener(e -> {
String propertyName = e.getPropertyName();
if ("name".equals(propertyName)) {
firePropertyChange("name", e.getOldValue(),
e.getNewValue());
}
});
}
/**
* {@inheritDoc}
*/
public void setName(String name) {
getSimulationStudy().getSession().setName(name);
}
/**
* Adds a label to the session editor node for the given session node indicating how many times the simulation
* edu.cmu.tetrad.study will run that node. If the number is one, the label is removed.
*/
private void setRepetitionLabel(SessionNode sessionNode) {
if (sessionNode == null) {
throw new NullPointerException("Node must not be null.");
}
SessionNodeWrapper sessionNodeWrapper
= getSessionNodeWrapper(sessionNode);
int repetitions = sessionNode.getRepetition();
if (repetitions > 1) {
JLabel label = new JLabel("x " + repetitions);
label.setForeground(Color.red);
setNodeLabel(sessionNodeWrapper, label, 0, 0);
} else {
setNodeLabel(sessionNodeWrapper, null, 0, 0);
}
}
/**
* @return the SessionNodeWrapper for the given SessionEditorNode.
*/
private SessionNodeWrapper getSessionNodeWrapper(SessionNode sessionNode) {
for (Object key : getModelNodesToDisplay().keySet()) {
if (key instanceof SessionNodeWrapper wrapper) {
if (wrapper.getSessionNode() == sessionNode) {
return wrapper;
}
}
}
throw new NullPointerException("Session node wrapper not in map.");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy