Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
*/
public class OWLEditorKit extends AbstractEditorKit {
public static final String ID = "OWLEditorKit";
public static final String URI_KEY = "URI";
public static final String FILE_URI_SCHEME = "file";
private static final Logger logger = LoggerFactory.getLogger(OWLEditorKit.class);
private final OWLModelManager modelManager;
private final OWLWorkspace workspace;
private final Set newPhysicalURIs = new HashSet<>();
private final OntologyLoadErrorHandlerUI loadErrorHandler;
private final ServiceRegistration registration;
private final OWLOntologyChangeListener ontologyChangeListener = changes -> modifiedDocument = true;
private final SearchManagerSelector searchManagerSelector;
private boolean modifiedDocument = false;
public OWLEditorKit(@Nonnull OWLEditorKitFactory editorKitFactory) {
super(editorKitFactory);
logger.info("OWL API Version: {}", VersionInfo.getVersionInfo().getVersion());
modelManager = new OWLModelManagerImpl();
// Make sure that the workspace is not null,
// but don't initialise it until our EditorKitHooks have been initialised.
workspace = new OWLWorkspace();
workspace.setup(this);
Initializers.loadEditorKitHooks(this);
searchManagerSelector = new SearchManagerSelector(this);
modelManager.addOntologyChangeListener(ontologyChangeListener);
modelManager.setExplanationManager(new ExplanationManager(this));
modelManager.setMissingImportHandler(new MissingImportHandlerUI(this));
loadErrorHandler = new OntologyLoadErrorHandlerUI(this);
modelManager.setLoadErrorHandler(loadErrorHandler);
loadIOListenerPlugins();
registration = ProtegeOWL.getBundleContext().registerService(EditorKit.class.getCanonicalName(), this, new Hashtable<>());
// Finally load the UI
workspace.initialise();
}
/**
* Determines if this editor kit has modified the contents if its documents in any way.
*
* @return true if this editor kit has modified the contents of its document, otherwise
* false.
*/
@Override
public boolean hasModifiedDocument() {
return modifiedDocument;
}
/**
* Gets the EditorKit Id. This can be used to identify
* the type of EditorKit.
*
* @return A String that represents the EditorKit
* Id.
*/
@Nonnull
public String getId() {
return ID;
}
/**
* Gets the Workspace that is used in the UI to
* display the contents of the clsdescriptioneditor kit "model".
*/
@Nonnull
public OWLWorkspace getWorkspace() {
if (workspace == null) {
throw new RuntimeException("Workspace has not been initialised");
}
return workspace;
}
@Nonnull
public OWLWorkspace getOWLWorkspace() {
return getWorkspace();
}
/**
* Gets the "model" that the clsdescriptioneditor kit edits. This will
* probably contain one or more ontologies.
*/
@Nonnull
public OWLModelManager getModelManager() {
return modelManager;
}
@Nonnull
public OWLModelManager getOWLModelManager() {
return getModelManager();
}
@Nonnull
public SearchManager getSearchManager() {
return searchManagerSelector.getCurrentSearchManager();
}
@Override
public boolean handleLoadRecentRequest(@Nonnull EditorKitDescriptor descriptor) throws Exception {
URI uri = descriptor.getURI(URI_KEY);
return uri != null && handleLoadFrom(uri);
}
@Override
public boolean handleLoadRequest() throws Exception {
File f = new UIHelper(this).chooseOWLFile("Select an OWL file");
return f != null && handleLoadFrom(f.toURI());
}
@Override
public boolean handleLoadFrom(@Nonnull URI uri) throws Exception {
loadErrorHandler.setReloadFlag(false);
boolean success = ((OWLModelManagerImpl) getModelManager()).loadOntologyFromPhysicalURI(uri);
if (success) {
addRecent(uri);
}
else if (loadErrorHandler.getReloadFlag()) {
success = handleLoadFrom(uri);
}
modifiedDocument = true;
return success;
}
/**
* Creates an ontology Id which should be used by default. The current implementation returns the next anonymous
* ontology identifier.
*
* @return The id.
*/
@Nonnull
private OWLOntologyID createDefaultOntologyId() {
return new OWLOntologyID(Optional.of(createFreshOntologyIRI()), Optional.absent());
}
/**
* Creates a fresh ontology IRI.
*
* @return The ontology IRI.
*/
@Nonnull
private IRI createFreshOntologyIRI() {
OntologyPreferences ontologyPreferences = OntologyPreferences.getInstance();
return IRI.create(ontologyPreferences.generateNextURI());
}
@Override
public boolean handleNewRequest() throws Exception {
OWLOntologyID id = createDefaultOntologyId();
OWLOntology ont = getModelManager().createNewOntology(id, URI.create(id.getDefaultDocumentIRI().get().toString()));
OWLOntologyManager owlOntologyManager = getModelManager().getOWLOntologyManager();
owlOntologyManager.setOntologyFormat(ont, new RDFXMLDocumentFormat());
return true;
}
@Override
public void handleSave() {
logger.info(LogBanner.start("Saving Workspace and Ontologies"));
try {
OWLOntologyManager ontologyManager = getOWLModelManager().getOWLOntologyManager();
Set ontologiesToSave = new HashSet<>();
Set ontologiesToSaveAs = new HashSet<>();
OWLOntology activeOntology = modelManager.getActiveOntology();
IRI activeOntologyDocumentIRI = ontologyManager.getOntologyDocumentIRI(activeOntology);
if (!"file".equalsIgnoreCase(activeOntologyDocumentIRI.getScheme())) {
logger.info("Will prompt 'Save As' for the active ontology because it was not loaded from a local file");
ontologiesToSaveAs.add(activeOntology);
}
for (OWLOntology dirtyOntology : getOWLModelManager().getDirtyOntologies()) {
String ontologyRendering = getModelManager().getRendering(dirtyOntology);
if (!"file".equals(ontologyManager.getOntologyDocumentIRI(dirtyOntology).getScheme())) {
logger.info("Will prompt 'Save As' for the {} ontology because it was not loaded from a local file " +
"but has been modified", ontologyRendering);
ontologiesToSaveAs.add(dirtyOntology);
}
else {
logger.info("Will save the {} ontology because it has been modified", ontologyRendering);
ontologiesToSave.add(dirtyOntology);
}
}
Map saveErrors = new LinkedHashMap<>();
for (OWLOntology ontology : ontologiesToSaveAs) {
try {
if (!handleSaveAs(ontology)) {
// SaveAs aborted. Abort all?
return;
}
} catch (OWLOntologyStorageException e) {
//noinspection ThrowableResultOfMethodCallIgnored
saveErrors.put(ontology, e);
}
}
for (OWLOntology ontology : ontologiesToSave) {
try {
getOWLModelManager().save(ontology);
} catch (OWLOntologyStorageException e) {
//noinspection ThrowableResultOfMethodCallIgnored
saveErrors.put(ontology, e);
}
}
getWorkspace().save();
newPhysicalURIs.forEach(this::addRecent);
newPhysicalURIs.clear();
handleSaveErrors(saveErrors);
} finally {
logger.info(LogBanner.end());
}
}
private void handleSaveErrors(Map saveErrors) {
if (saveErrors.isEmpty()) {
return;
}
StringBuilder errorMessage = new StringBuilder();
errorMessage.append("Some errors where encountered during the save operation.
");
}
JOptionPane.showMessageDialog(getWorkspace(), errorMessage.toString(), "Save Errors", JOptionPane.ERROR_MESSAGE);
}
/**
* Saves the active ontology
*/
public void handleSaveAs() {
final OWLOntology ont = getModelManager().getActiveOntology();
try {
handleSaveAs(ont);
} catch (OWLOntologyStorageException e) {
Map saveErrorMap = new HashMap<>();
//noinspection ThrowableResultOfMethodCallIgnored
saveErrorMap.put(ont, e);
handleSaveErrors(saveErrorMap);
}
}
/**
* Saves the specified ontology to a location that is specified by the user before the save operation.
*
* @param ont the ontology to save.
* @throws OWLOntologyStorageException if there was a problem saving the ontology.
*/
private boolean handleSaveAs(@Nonnull OWLOntology ont) throws OWLOntologyStorageException {
OWLOntologyManager man = getModelManager().getOWLOntologyManager();
OWLDocumentFormat oldFormat = man.getOntologyFormat(ont);
java.util.Optional format = OntologyFormatPanel.showDialog(this, oldFormat,
String.format("" +
"
Choose a format to use when saving the '%s' ontology.
" +
"
" +
"(If you are unsure as to what format to choose, " +
"we recommend that you use the standard RDF/XML format, " +
"or a widely supported format such as Turtle)
" +
"", getModelManager().getRendering(ont)));
if (!format.isPresent()) {
logger.info("No ontology document format has been selected. Aborting saveAs.");
return false;
}
if (oldFormat instanceof PrefixDocumentFormat && format.get() instanceof PrefixDocumentFormat) {
PrefixDocumentFormat oldPrefixes = (PrefixDocumentFormat) oldFormat;
for (String name : oldPrefixes.getPrefixNames()) {
String prefix = oldPrefixes.getPrefix(name);
if (prefix != null) {
((PrefixDocumentFormat) format.get()).setPrefix(name, prefix);
}
}
}
File file = getSaveAsOWLFile(ont);
if (file != null) {
man.setOntologyFormat(ont, format.get());
man.setOntologyDocumentIRI(ont, IRI.create(file));
getModelManager().save(ont);
addRecent(file.toURI());
return true;
}
else {
return false;
}
}
private File getSaveAsOWLFile(@Nonnull OWLOntology ont) {
UIHelper helper = new UIHelper(this);
File file = helper.saveOWLFile(String.format("Please select a location in which to save: %s", getModelManager().getRendering(ont)));
if (file != null) {
int extensionIndex = file.toString().lastIndexOf('.');
if (extensionIndex == -1) {
file = new File(file.toString() + ".owl");
}
else if (extensionIndex != file.toString().length() - 4) {
file = new File(file.toString() + ".owl");
}
}
return file;
}
public void addRecent(@Nonnull URI physicalURI) {
String label = physicalURI.toString();
if (FILE_URI_SCHEME.equals(physicalURI.getScheme())) {
label = new File(physicalURI).getPath();
}
else {
// also add to the URI bookmarks
BookMarkedURIManager.getInstance().add(physicalURI);
}
EditorKitDescriptor descriptor = new EditorKitDescriptor(label, getEditorKitFactory());
descriptor.setURI(URI_KEY, physicalURI);
RecentEditorKitManager.getInstance().add(descriptor);
}
private void loadIOListenerPlugins() {
IOListenerPluginLoader loader = new IOListenerPluginLoader(this);
for (IOListenerPlugin pl : loader.getPlugins()) {
try {
IOListenerPluginInstance instance = pl.newInstance();
getModelManager().addIOListener(instance);
} catch (Throwable e) {
logger.warn("An IOListenerPlugin threw an error: {}", e.getMessage(), e);
}
}
}
/*
* Call the model manager get and put here because otherwise
* listeners created by owl editor kit objects may get disposed
* too late.
*
* Feels risky.
*/
@Override
public Disposable get(@Nullable Object key) {
return getOWLModelManager().get(key);
}
@Override
public void put(@Nullable Object key, @Nullable Disposable value) {
getOWLModelManager().put(key, value);
}
@Override
public void dispose() {
logger.info(LogBanner.start("Disposing of Workspace"));
getModelManager().removeOntologyChangeListener(ontologyChangeListener);
super.dispose();
searchManagerSelector.getCurrentSearchManager().dispose();
workspace.dispose();
try {
modelManager.getExplanationManager().dispose();
modelManager.dispose();
} catch (Exception e) {
ErrorLogPanel.showErrorDialog(e);
}
try {
registration.unregister();
} catch (Exception e) {
logger.warn("Error whilst unregistering service: {}", e.getMessage());
}
logger.info(LogBanner.end());
}
@Nonnull
public SearchManagerSelector getSearchManagerSelector() {
return searchManagerSelector;
}
}
