org.appdapter.gui.repo.ModelAsTurtleEditor Maven / Gradle / Ivy
Show all versions of org.appdapter.lib.gui Show documentation
package org.appdapter.gui.repo;
import java.awt.BorderLayout;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.Font;
import java.awt.Toolkit;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ComponentAdapter;
import java.awt.event.ComponentEvent;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.io.File;
import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Random;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.swing.BorderFactory;
import javax.swing.Box;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.SwingUtilities;
import javax.swing.WindowConstants;
import javax.swing.event.CaretEvent;
import javax.swing.event.CaretListener;
import javax.swing.text.BadLocationException;
import org.appdapter.core.convert.NoSuchConversionException;
import org.appdapter.core.store.RepoOper;
import org.appdapter.core.store.dataset.RepoDatasetFactory;
import org.appdapter.gui.browse.Utility;
import org.appdapter.gui.editors.ObjectPanel;
import org.appdapter.gui.swing.JJPanel;
import org.appdapter.gui.swing.ScreenBoxPanel;
import org.appdapter.gui.swing.SimpleTextEditor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.hp.hpl.jena.graph.Graph;
import com.hp.hpl.jena.rdf.listeners.StatementListener;
import com.hp.hpl.jena.rdf.model.Model;
import com.hp.hpl.jena.rdf.model.ModelFactory;
import com.hp.hpl.jena.rdf.model.Statement;
import com.hp.hpl.jena.shared.Lock;
//import com.hp.hpl.jena.n3.N3Exception;
/**
*
* A Swing-based GUI window that provides a simple Turtle-based editor and inspector for Jena models. Useful for debugging GUI and web applications. To open an editor window, pass the model instance to the static {@link ModelAsTurtleEditor#open(Model)} method.
*
*
*
* The editor has basic reporting of Turtle syntax errors. It also updates the namespace prefixes of the model. Several windows for different models may be open at the same time. Concurrent changes to the model are reported.
*
*
*
* The class has a {@link #main} method for demonstration purposes. It loads one or more RDF files into Jena models and displays an editor for each.
*
*
* @version $Id$
* @author Richard Cyganiak ([email protected])
* @author LogicMoo
*/
public class ModelAsTurtleEditor extends ScreenBoxPanel implements ObjectPanel {
public interface VoidFunc1 {
public void call(P boundModel);
}
String header = "";
static Logger theLogger = LoggerFactory.getLogger(ModelMatrixPanel.class);
public static Class[] EDITTYPE = new Class[] { Model.class, Graph.class };
@UISalient(IsPanel = true) static public ModelAsTurtleEditor showTurtleTextEditor(Model obj) {
return new ModelAsTurtleEditor(obj);
}
static {
//Utility.registerPanel(ModelAsTurtleEditor.class, Model.class);
//Utility.addClassMethods(ModelAsTurtleEditor.class);
}
private final static int WINDOW_MIN_WIDTH = 400;
private final static int WINDOW_MIN_HEIGHT = 200;
// We randomize the position of new windows
private final static Random random = new Random(19790715);
/**
* Opens a new editor window and binds it to the given model.
*
* @param sourceModel
* A Jena model
* @return A reference to the new editor window
*/
@UISalient public static ModelAsTurtleEditor open(Model sourceModel) {
return new ModelAsTurtleEditor(sourceModel, "Jena Model Editor for " + sourceModel);
}
/**
* Opens a new editor window and binds it to the given model. A custom title is useful to distinguish multiple editor windows for different models.
*
* @param sourceModel
* A Jena model
* @param title
* A custom title for the editor window
* @return A reference to the new editor window
*/
public static ModelAsTurtleEditor open(Model sourceModel, String title) {
return new ModelAsTurtleEditor(sourceModel, title + " - Jena Model Editor");
}
/**
* Main method for demonstration purposes. Takes a number of filename or URL arguments. Reads them as RDF/XML or Turtle (if ends with ".n3" or ".ttl"). Displays an editor for each. If the same filename appears twice, then both editors will use the same model.
*
* @param args
*/
public static void main(String[] args) {
if (args.length == 0) {
System.out.println("Please specify one or more " + "RDF filenames or URLs.");
return;
}
for (int i = 0; i < args.length; i++) {
if (!filenamesToGraph.containsKey(args[i])) {
String url = args[i];
if (url.indexOf(":") == -1) {
url = "file:" + url;
}
Model m = RepoDatasetFactory.createPrivateMemModel();
String lang = (url.endsWith(".n3") || url.endsWith(".ttl")) ? "N3" : "RDF/XML";
m.read(url, lang);
filenamesToGraph.put(args[i], m);
}
Model m = (Model) filenamesToGraph.get(args[i]);
open(m, args[i]);
}
}
/**
* The model bound to the editor.
*/
protected Model currentModel;
protected String currentName;
JFrame window;
SimpleTextEditor turtleTextArea;
JLabel cursorPositionLabel;
JJPanel buttons;
StatementListener listener;
/**
* true when the model has been changed by another part of the system
*/
boolean outOfSync;
/**
* true while we've locked the model. Assumption: All changes to the model reported by the listener during this period have been caused by us.
*/
boolean weAreEditingTheModel = false;
protected String titleShouldBe;
protected JComboBox combo;
private boolean inAddingModel;
/**
* Creates and displays new ModelEditor.
*
* @param sourceModel
* The model bound to the editor
* @param title
* The full title of the editor window
*/
public ModelAsTurtleEditor(Model sourceModel, String title) {
this.window = Utility.getAppFrame();
this.titleShouldBe = title;
this.setObject(sourceModel);
}
public ModelAsTurtleEditor() {
this.window = Utility.getAppFrame();
}
public ModelAsTurtleEditor(Model sourceModel) {
this.window = Utility.getAppFrame();
if (sourceModel != null) {
this.titleShouldBe = sourceModel.getNsPrefixURI("");
}
this.setObject(sourceModel);
}
/**
* Parses the contents of the Turtle text area and adds all statements and namespace prefixes to the model. Displays an error message if the contents are invalid.
*/
protected synchronized void addTurtleToModel() {
inModelLock(false, new VoidFunc1() {
@Override public void call(Model boundModel) {
Model contents = getContentsAsModel();
if (contents == null) { // Syntax error?
return;
}
// Namespace prefixes
Iterator it = contents.getNsPrefixMap().keySet().iterator();
while (it.hasNext()) {
String prefix = (String) it.next();
String uri = contents.getNsPrefixURI(prefix);
if (!uri.equals(boundModel.getNsPrefixURI(prefix))) {
boundModel.setNsPrefix(prefix, uri);
}
}
boundModel.add(contents);
turtleTextArea.requestFocusInWindow();
}
});
}
/**
* Parses the contents of the Turtle text area and removes all statements and namespace prefixes from the model. Displays an error message if the contents are invalid.
*/
protected synchronized void removeTurtleFromModel() {
inModelLock(false, new VoidFunc1() {
@Override public void call(Model boundModel) {
Model contents = getContentsAsModel();
if (contents == null) { // syntax error?
return;
}
// Namespace prefixes
Iterator it = contents.getNsPrefixMap().keySet().iterator();
while (it.hasNext()) {
String prefix = (String) it.next();
if (prefix.length() > 0)
boundModel.removeNsPrefix(prefix);
}
boundModel.remove(contents);
turtleTextArea.requestFocusInWindow();
}
});
}
/**
* Parses the contents of the Turtle text area and replaces all statements and namespace prefixes in the model with those from the text area. Displays an error message if the contents are invalid.
*/
protected synchronized void replaceModelWithTurtle() {
inModelLock(false, new VoidFunc1() {
@Override public void call(Model boundModel) {
Model contents = getContentsAsModel();
if (contents == null) { // syntax error?
return;
}
// Namespace prefixes
Iterator it = boundModel.getNsPrefixMap().keySet().iterator();
while (it.hasNext()) {
String prefix = (String) it.next();
boundModel.removeNsPrefix(prefix);
}
boundModel.setNsPrefixes(contents);
boundModel.removeAll();
boundModel.add(contents);
turtleTextArea.requestFocusInWindow();
// Model contains the contents of the text area so we're synced
outOfSync = false;
turtleTextArea.fileSaved = !outOfSync;
}
});
}
public void inModelLock(boolean readLockRequested, VoidFunc1 runnable) {
Lock mlock = null;
Model currentModel = this.currentModel;
if (currentModel != null) {
mlock = currentModel.getLock();
}
try {
this.weAreEditingTheModel = true;
if (mlock != null)
mlock.enterCriticalSection(readLockRequested);
runnable.call(currentModel);
} finally {
if (mlock != null)
mlock.leaveCriticalSection();
this.weAreEditingTheModel = false;
}
}
/**
* Replaces the contents of the text area with a Turtle serialization of the model.
*/
protected void fetchTurtleFromModel() {
inModelLock(true, new VoidFunc1() {
@Override public void call(Model boundModel) {
String turtle = getModelSource(boundModel);
setContents(turtle);
turtleTextArea.requestFocusInWindow();
moveCursorTo(1, 1);
// Text area now contains model so we're synced
outOfSync = false;
turtleTextArea.fileSaved = !outOfSync;
}
});
}
/**
* @return The current contents of the Turtle text area
*/
protected String getContentsAsTurtle() {
return this.turtleTextArea.getText();
}
/**
* Parses the current contents of the Turtle text area and returns them as a Jena model. Will show an error message to the user and return null if the contents are not syntactically valid.
*
* @return The parsed contents of the Turtle text area
*/
protected Model getContentsAsModel() {
Model result = RepoDatasetFactory.createPrivateMemModel();
StringReader reader = new StringReader(getContentsAsTurtle());
try {
xferPrefixes(currentModel, result);
result.read(reader, "", "N3");
return result;
} catch (Throwable ex) { // syntax error?
// Split error message into line, column, parser message
Pattern p = Pattern.compile(".*\\[([0-9]+):([0-9]+)\\] (.*)");
Matcher m = p.matcher(ex.getMessage());
if (!m.matches()) {
throw new RuntimeException("Unexpected error format: " + ex.getMessage());
}
// Show error message
JOptionPane.showMessageDialog(this.window, m.group(3), "Parse Error", JOptionPane.ERROR_MESSAGE);
// Then highlight the offending character
int line = Integer.parseInt(m.group(1));
int column = Integer.parseInt(m.group(2));
highlightCharacter(line, column);
// null return means there was a syntax error
return null;
}
}
Map prefixes = new HashMap();
private void xferPrefixes(Model from, Model to) {
if (from != null) {
prefixes.putAll(from.getNsPrefixMap());
}
if (to != null) {
String s = to.getNsPrefixURI("");
to.getNsPrefixMap().putAll(prefixes);
if (s != null) {
to.setNsPrefix("", s);
}
}
}
/**
* Sets the contents of the Turtle text area.
*
* @param text
* The new contents
*/
protected void setContents(String text) {
this.turtleTextArea.setText(text);
}
/**
* @return The line number of the current cursor position
*/
protected int getCurrentCursorLine() {
try {
return this.turtleTextArea.getLineOfOffset(this.turtleTextArea.getCaretPosition()) + 1;
} catch (BadLocationException e) {
throw new RuntimeException(e);
}
}
/**
* @return The column number of the current cursor position
*/
protected int getCurrentCursorColumn() {
try {
int line = this.turtleTextArea.getLineOfOffset(this.turtleTextArea.getCaretPosition());
return this.turtleTextArea.getCaretPosition() - this.turtleTextArea.getLineStartOffset(line) + 1;
} catch (BadLocationException e) {
throw new RuntimeException(e);
}
}
/**
* Selects the character at the given position to indicate the location of a syntax error.
*
* @param line
* A cursor position
* @param column
* A cursor position
*/
protected void highlightCharacter(int line, int column) {
try {
this.turtleTextArea.requestFocusInWindow();
int offset = this.turtleTextArea.getLineStartOffset(line - 1) + column - 1;
this.turtleTextArea.setCaretPosition(offset + 1);
this.turtleTextArea.moveCaretPosition(offset);
} catch (BadLocationException e) {
throw new RuntimeException(e);
}
}
/**
* Moves the cursor to a given position.
*
* @param line
* A cursor position
* @param column
* A cursor position
*/
protected void moveCursorTo(int line, int column) {
try {
this.turtleTextArea.requestFocusInWindow();
int offset = this.turtleTextArea.getLineStartOffset(line - 1) + column - 1;
this.turtleTextArea.setCaretPosition(offset);
notifyCursorPositionChanged();
} catch (BadLocationException e) {
throw new RuntimeException(e);
}
}
/**
* Updates the cursor position label.
*/
protected void notifyCursorPositionChanged() {
this.cursorPositionLabel.setText(getCurrentCursorLine() + " : " + getCurrentCursorColumn());
}
/**
* Shows a message about a concurrent modification of the model to the user, except if we have locked the model (then we assume the change has been by ourselves), or if model and text area are already out of sync (then the user has already seen the message earlier).
*/
protected synchronized void notifyConcurrentChange(Model m, Statement statement) {
if (this.weAreEditingTheModel || this.outOfSync) {
return;
}
this.outOfSync = true;
turtleTextArea.fileSaved = !outOfSync;
// This is called by the model's worker thread and
// the error dialog blocks the thread until the user
// clicks OK, so we better show the dialog in another
// thread
SwingUtilities.invokeLater(new Runnable() {
public void run() {
JOptionPane.showMessageDialog(ModelAsTurtleEditor.this.window, "The model has been changed by another part of the system.\n"
+ "Re-fetch the contents of the model to get the latest changes.", "Concurrent Change", JOptionPane.WARNING_MESSAGE);
}
});
}
/**
* Sets up the window.
*/
public void initGUIForReference() {
this.removeAll();
// set up the north-side panel with the buttons
JPanel theButtonsAndFlow = new JPanel(new BorderLayout());
this.buttons = new JJPanel();
this.buttons.setLayout(new FlowLayout());
this.buttons.setBorder(BorderFactory.createEmptyBorder(0, 12, 0, 16));
theButtonsAndFlow.add(BorderLayout.CENTER, buttons);
this.combo = new JComboBox();
//Dimension preferredSize = new Dimension(200, 24);
//this.combo.setMaximumSize(preferredSize);
//this.combo.setSize(preferredSize);
//this.combo.setPreferredSize(preferredSize);
combo.addItemListener(new ItemListener() {
@Override public void itemStateChanged(ItemEvent e) {
stateChange(e);
}
});
JPanel comboHolder = new JJPanel();
comboHolder.setLayout(new BorderLayout());
comboHolder.add(BorderLayout.CENTER, combo);
theButtonsAndFlow.add("South", comboHolder);
// buttons
makeButton("Add To model", new ActionListener() {
public void actionPerformed(ActionEvent e) {
addTurtleToModel();
}
});
makeButton("Remove From model", new ActionListener() {
public void actionPerformed(ActionEvent e) {
removeTurtleFromModel();
}
});
makeButton("Fetch Model", new ActionListener() {
public void actionPerformed(ActionEvent e) {
fetchTurtleFromModel();
}
});
makeButton("Replace Model", new ActionListener() {
public void actionPerformed(ActionEvent e) {
replaceModelWithTurtle();
}
});
makeButton("Save Model", new ActionListener() {
public void actionPerformed(ActionEvent e) {
turtleTextArea.fileSaveAs();
}
});
makeButton("Load Model", new ActionListener() {
public void actionPerformed(ActionEvent e) {
turtleTextArea.fileOpenAndRead();
}
});
// cursor position label
this.cursorPositionLabel = new JLabel("Status bar");
this.cursorPositionLabel.setFont(new Font("Dialog", Font.PLAIN, 10));
this.buttons.add(this.cursorPositionLabel);
Container contentPane = getContentPane();
turtleTextArea = getTurtleTextArea();
contentPane.removeAll();
contentPane.setLayout(new BorderLayout());
contentPane.add(BorderLayout.NORTH, theButtonsAndFlow);
contentPane.add(BorderLayout.CENTER, turtleTextArea.getContentPane());
if (Utility.getAppFrame() == window)
return;
if (true)
return;
// Hack to prevent resizing the window below a minimum size
this.window.addComponentListener(new ComponentAdapter() {
public void componentResized(ComponentEvent e) {
int width = ModelAsTurtleEditor.this.window.getWidth();
int height = ModelAsTurtleEditor.this.window.getHeight();
boolean doResize = false;
if (width < WINDOW_MIN_WIDTH) {
width = WINDOW_MIN_WIDTH;
doResize = true;
}
if (height < WINDOW_MIN_HEIGHT) {
height = WINDOW_MIN_HEIGHT;
doResize = true;
}
if (!doResize) {
return;
}
ModelAsTurtleEditor.this.window.setSize(width, height);
}
});
if (Utility.getAppFrame() == window)
return;
// DISPOSE_ON_CLOSE so we can have multiple windows running
this.window.setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
this.window.pack();
// Randomly set initial window positions (otherwise they would
// all sit overlapping in the top left corner)
Dimension screen = Toolkit.getDefaultToolkit().getScreenSize();
this.window.setLocation(random.nextInt(screen.width - this.window.getWidth()), random.nextInt(screen.height - this.window.getHeight()));
}
protected void stateChange(final ItemEvent e) {
theLogger.warn(" " + e);
final String mname = "" + e.getItem();
final Model focusModel = namesToGraph.get(mname);
inModelLock(true, new VoidFunc1() {
@Override public void call(Model boundModel) {
if (currentModel == null && focusModel != null) {
setCurrentModel(mname, focusModel);
} else {
if (e.getStateChange() == ItemEvent.SELECTED && !inAddingModel) {
if (!turtleTextArea.confirmSaved()) {
combo.setSelectedItem(currentName);
} else {
setCurrentModel(mname, focusModel);
}
}
}
}
});
}
protected void setCurrentModel(String name, Model focusModel) {
currentModel = focusModel;
currentName = name;
fetchTurtleFromModel();
}
private SimpleTextEditor getTurtleTextArea() {
// set up Turtle text area
if (this.turtleTextArea == null) {
this.turtleTextArea = new SimpleTextEditor();
this.turtleTextArea.setFont(new Font("Monospaced", Font.PLAIN, 12));
this.turtleTextArea.addCaretListener(new CaretListener() {
public void caretUpdate(CaretEvent e) {
// update cursor position label
notifyCursorPositionChanged();
}
});
}
return this.turtleTextArea;
}
/**
* Helper function that creates a button
*
* @param label
* The button's label
* @param action
*/
public void makeButton(String label, ActionListener action) {
JButton newButton = new JButton(label) {
// Try to cover the whole width of its parent container.
// We use this because we want all buttons to have the
// same width.
public Dimension getMaximumSize() {
Dimension dim = super.getMaximumSize();
return new Dimension(Short.MAX_VALUE, (int) dim.getHeight());
}
};
newButton.addActionListener(action);
this.buttons.add(newButton);
// 6 pixels spacing between this and next button
this.buttons.add(Box.createRigidArea(new Dimension(0, 6)));
}
@Override public Class getClassOfBox() {
return EDITTYPE[0];
}
@Override protected boolean reloadObjectGUI(Object obj) throws Throwable {
setModelObject(Utility.recast(obj, Model.class));
return true;
}
@Override protected void initSubclassGUI() throws Throwable {
initGUIForReference();
}
@Override protected void completeSubClassGUI() throws Throwable {
}
void setModelObject(final Model boundModel) {
this.currentModel = boundModel;
super.setObject(boundModel);
Utility.addShutdownHook(new Runnable() {
@Override public void run() {
boundModel.unregister(ModelAsTurtleEditor.this.listener);
}
});
// Add listener to the model
this.listener = new StatementListener() {
public void addedStatement(Statement s) {
notifyConcurrentChange(boundModel, s);
}
public void removedStatement(Statement s) {
notifyConcurrentChange(boundModel, s);
}
};
boundModel.register(this.listener);
add(boundModel, RepoOper.getBaseURI(boundModel, null));
}
public static Map listeners = new HashMap();
public Map namesToGraph = new HashMap();
public void add(final Model m, String name) {
this.inAddingModel = true;
if (!namesToGraph.containsKey(name)) {
if (name.indexOf(":") == -1) {
name = "file:" + name;
}
namesToGraph.put(name, m);
} else {
Model m2 = namesToGraph.get(name);
if (m2 == m)
return;
// have a problem!
name = name + " " + System.identityHashCode(m);
}
try {
combo.addItem(name);
StatementListener sl = listeners.get(m);
if (sl == null) {
sl = new StatementListener() {
public void addedStatement(Statement s) {
notifyConcurrentChange(m, s);
}
public void removedStatement(Statement s) {
notifyConcurrentChange(m, s);
}
};
listeners.put(m, sl);
}
} finally {
this.inAddingModel = false;
}
}
public String getModelSource(Model boundModel) {
// Serialize model and update text area
StringWriter writer = new StringWriter();
xferPrefixes(boundModel, null);
Map pmap = boundModel.getNsPrefixMap();
boundModel.write(writer, "TTL");
String turtle = writer.toString();
Iterator it = pmap.keySet().iterator();
while (it.hasNext()) {
String prefix = (String) it.next();
String uri = pmap.get(prefix);
if (prefix.length() > 0) {
String remove = "\\@prefix " + prefix + "\\:.*\\<" + uri + "\\> .\n";
turtle = turtle.replaceAll(remove, "");
}
}
return turtle;
}
public void loadTTL(File file) throws IOException, NoSuchConversionException {
// TODO Auto-generated method stub
}
public void saveTTL(File file) throws IOException, NoSuchConversionException {
// TODO Auto-generated method stub
}
}