Protege 4.1.0

org.protege.editor.owl
Class OWLEditorKit

java.lang.Object
  extended by org.protege.editor.core.editorkit.AbstractEditorKit<OWLEditorKitFactory>
      extended by org.protege.editor.owl.OWLEditorKit
All Implemented Interfaces:
Disposable, EditorKit

public class OWLEditorKit
extends AbstractEditorKit<OWLEditorKitFactory>

Author: Matthew Horridge
The University Of Manchester
Medical Informatics Group
Date: Mar 17, 2006

matthew.horridge@cs.man.ac.uk
www.cs.man.ac.uk/~horridgm


Field Summary
static String ID
           
static String URI_KEY
           
 
Constructor Summary
OWLEditorKit(OWLEditorKitFactory editorKitFactory)
           
 
Method Summary
 void addRecent(URI physicalURI)
           
 void dispose()
           
 Disposable get(Object key)
           
 String getId()
          Gets the EditorKit Id.
 OWLModelManager getModelManager()
          Gets the "model" that the clsdescriptioneditor kit edits.
 OWLModelManager getOWLModelManager()
           
 OWLWorkspace getOWLWorkspace()
           
 OWLWorkspace getWorkspace()
          Gets the Workspace that is used in the UI to display the contents of the clsdescriptioneditor kit "model".
 boolean handleLoadFrom(URI uri)
           
 boolean handleLoadRecentRequest(EditorKitDescriptor descriptor)
           
 boolean handleLoadRequest()
           
 boolean handleNewRequest()
          Called by the system to initialise the editorkit to an "new" or "empty" state.
 void handleSave()
           
 void handleSaveAs()
           
protected  void initialise()
           
 void put(Object key, Disposable value)
           
 void setOWLModelManager(OWLModelManager modelManager)
          Deprecated. This call isn't really deprecated - it is just not recommended. If you are thinking of using this call then probably there is a missing feature in Protégé or there is a plugin capability that you should consider using instead. Contact the Protégé developers on the p4 mailing list: http://mailman.stanford.edu/mailman/listinfo/p4-feedback.
 
Methods inherited from class org.protege.editor.core.editorkit.AbstractEditorKit
getEditorKitFactory, initialiseCompleted
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ID

public static final String ID
See Also:
Constant Field Values

URI_KEY

public static final String URI_KEY
See Also:
Constant Field Values
Constructor Detail

OWLEditorKit

public OWLEditorKit(OWLEditorKitFactory editorKitFactory)
Method Detail

initialise

protected void initialise()
Specified by:
initialise in class AbstractEditorKit<OWLEditorKitFactory>

setOWLModelManager

@Deprecated
public void setOWLModelManager(OWLModelManager modelManager)
Deprecated. This call isn't really deprecated - it is just not recommended. If you are thinking of using this call then probably there is a missing feature in Protégé or there is a plugin capability that you should consider using instead. Contact the Protégé developers on the p4 mailing list: http://mailman.stanford.edu/mailman/listinfo/p4-feedback.


getId

public String getId()
Gets the EditorKit Id. This can be used to identify the type of EditorKit.

Returns:
A String that represents the EditorKit Id.

getWorkspace

public OWLWorkspace getWorkspace()
Gets the Workspace that is used in the UI to display the contents of the clsdescriptioneditor kit "model".


getOWLWorkspace

public OWLWorkspace getOWLWorkspace()

getModelManager

public OWLModelManager getModelManager()
Gets the "model" that the clsdescriptioneditor kit edits. This will probably contain one or more ontologies.


getOWLModelManager

public OWLModelManager getOWLModelManager()

handleLoadRecentRequest

public boolean handleLoadRecentRequest(EditorKitDescriptor descriptor)
                                throws Exception
Throws:
Exception

handleLoadRequest

public boolean handleLoadRequest()
                          throws Exception
Throws:
Exception

handleLoadFrom

public boolean handleLoadFrom(URI uri)
                       throws Exception
Throws:
Exception

handleNewRequest

public boolean handleNewRequest()
                         throws Exception
Description copied from interface: EditorKit
Called by the system to initialise the editorkit to an "new" or "empty" state. This is typically called in response to a File->New request for example.

Returns:
true in an new/empty editorkit and model was successfully created. false if the intialisation sequence was cancelled or didn't complete.
Throws:
Exception - This exception is thrown if there were errors.

handleSave

public void handleSave()
                throws Exception
Throws:
Exception

handleSaveAs

public void handleSaveAs()
                  throws Exception
Throws:
Exception

addRecent

public void addRecent(URI physicalURI)

get

public Disposable get(Object key)
Specified by:
get in interface EditorKit
Overrides:
get in class AbstractEditorKit<OWLEditorKitFactory>

put

public void put(Object key,
                Disposable value)
Specified by:
put in interface EditorKit
Overrides:
put in class AbstractEditorKit<OWLEditorKitFactory>

dispose

public void dispose()
Specified by:
dispose in interface Disposable
Overrides:
dispose in class AbstractEditorKit<OWLEditorKitFactory>

Protege 4.1.0

Submit a bug report or feature request

For further API reference and developer documentation, see Protege 4 Developer Documentation.

Copyright © 2010 Stanford Center for Biomedical Informatics Research