Database Inclusion Plugin Devlopers Notes - Revision history

JenniferVendetti at 22:41, October 9, 2008

2008-10-09T22:41:45Z

TaniaTudorache: /* setName() is gone (Mainly Protege Core Developers) */

2008-06-03T19:12:56Z

‎setName() is gone (Mainly Protege Core Developers)

TaniaTudorache at 18:45, June 3, 2008

2008-06-03T18:45:26Z

TaniaTudorache at 17:35, June 3, 2008

2008-06-03T17:35:45Z

TaniaTudorache: /* setName() is gone (Mainly Protege Core Developers) */

2008-06-03T17:35:20Z

‎setName() is gone (Mainly Protege Core Developers)

TaniaTudorache at 17:26, June 3, 2008

2008-06-03T17:26:24Z

Tredmond at 00:01, April 25, 2008

2008-04-25T00:01:06Z

Tredmond: /* Renaming Frames (or OWL Entities) */

2008-04-14T20:43:43Z

‎Renaming Frames (or OWL Entities)

Tredmond: New page: TOC == Renaming Frames (or OWL Entities) == The single biggest change in this version is is that Protege frames cannot be renamed. Previously a rename operation consisted of simply ...

2008-04-14T20:27:25Z

New page: __TOC__ == Renaming Frames (or OWL Entities) == The single biggest change in this version is is that Protege frames cannot be renamed. Previously a rename operation consisted of simply ...

New page

__TOC__

== Renaming Frames (or OWL Entities) ==

The single biggest change in this version is is that Protege frames cannot be renamed. Previously a rename operation consisted of simply taking an existing frame and assigning a new name to it. In order to support database inclusion properly, we had to change this. The name is now an immutable part of a frame. In order to "rename" a frame, we need to do a shallow copy of the frame to another frame with the new name and then delete the old frame.

This creates two issues for plugin developers. First,

@@ Line 22: / Line 22: @@
   resource.getNamespacePrefix() -> owl
   resource.getNamespace() -> http://www.w3.org/2002/07/owl#
 == Renaming Frames or OWL Entities ==
@@ Line 79: / Line 80: @@
 The point is that all events except occuring for the duration of a rename event except for the Replace Frame event are ignored.
 == Users of FrameID ==
 Existing code that uses FrameID() probably won't work.  FrameID's can still be used to uniquely represent a frame but none of their previously existing structure exists any more.
 == setName() has been removed from the Frame interface ==
 The <code>setName</code> method has been removed from the interface. Please use instead <code>Frame.rename</code> both for Frames and OWL. See ''Renaming Frames or OWL Entities'' section above for more details.

@@ Line 84: / Line 84: @@
 Existing code that uses FrameID() probably won't work.  FrameID's can still be used to uniquely represent a frame but none of their previously existing structure exists any more.
-== setName() is gone (Mainly Protege Core Developers) ==
+== setName() has been removed from the Frame interface ==
 The <code>setName</code> method has been removed from the interface. Please use instead <code>Frame.rename</code> both for Frames and OWL. See ''Renaming Frames or OWL Entities'' section above for more details.

← Older revision		Revision as of 18:45, June 3, 2008
Line 34:		Line 34:
	frame = frame.rename(newName);		frame = frame.rename(newName);

−	The code above ~~applied~~ both for frames and OWL.	+	The code above applies both for frames and OWL.
		+
		+
		+	== Listening to frame rename (i.e. replace) events ==
		+
		+	A new method, <code>frameReplaced</code> in the <code>FrameListener</code> allows you to listen for frame replace events.
		+	The <code>getNewFrame</code> method from <code>FrameEvent</code> allows you to get the new frame with the new name. You can get the name of the old frame by calling <code>event.getOldName()</code>. After a frame was replaced, you should '''NOT''' use in your code the old frame anymore. The old frame will be destroyed. Your code should use the new frame.
		+
		+	The following code snippet shows an example how to listen for frame rename (i.e. replace) events:
		+
		+	FrameAdapter frameAdapter = new FrameAdapter() {
		+	@Override
		+	public void frameReplaced(FrameEvent event) {
		+	System.out.println("New frame: " + event.getNewFrame());
		+	System.out.println("Old frame name: " + event.getOldName());
		+	//don't use the old frame anymore!!
		+	System.out.println("Old frame: " + event.getFrame());
		+	}
		+	};
		+
		+	kb.addFrameListener(frameAdapter);
		+

← Older revision		Revision as of 17:35, June 3, 2008
Line 66:		Line 66:

	The <code>setName</code> method has been removed from the interface. Please use instead <code>Frame.rename</code> both for Frames and OWL. See ''Renaming Frames or OWL Entities'' section above for more details.		The <code>setName</code> method has been removed from the interface. Please use instead <code>Frame.rename</code> both for Frames and OWL. See ''Renaming Frames or OWL Entities'' section above for more details.
−
−	~~== Use getSystemFrames() ==~~
−
−	~~== Parser.run() ==~~

@@ Line 65: / Line 65: @@
 == setName() is gone (Mainly Protege Core Developers) ==
-Use instead Frame.rename. See ''Renaming Frames or OWL Entities'' section above.
+The <code>setName</code> method has been removed from the interface. Please use instead <code>Frame.rename</code> both for Frames and OWL. See ''Renaming Frames or OWL Entities'' section above for more details.
 == Use getSystemFrames() ==
 == Parser.run() ==

@@ Line 1: / Line 1: @@
 __TOC__
@@ Line 15: / Line 25: @@
 == Renaming Frames or OWL Entities ==
-The single biggest change in this version is is that Protege frames cannot be renamed.  Previously a rename operation consisted of simply taking an existing frame and assigning a new name to it.  In order to support  database inclusion properly, we had to change this.  The name is now an immutable part of a frame.  In order to "rename" a frame, we need to do a shallow copy of the frame to another frame with the new name and then delete the old frame.
+The single biggest change in this version is is that Protege frames (so also OWL entities) cannot be renamed.  Previously a rename operation consisted of simply taking an existing frame and assigning a new name to it.  In order to support  database inclusion properly, we had to change this.  The name is now an immutable part of a frame.  In order to "rename" a frame, we need to do a shallow copy of the frame to another frame with the new name and then delete the old frame.
-This creates two issues for plugin developers.  First, the old Frame.setName call has been replaced with Frame.rename.  This means that when plugins need to change the names of frames they will need to be updated and recompiled.
+This creates two issues for plugin developers.  First, the old '''Frame.setName call has been replaced with Frame.rename'''.  This means that when plugins need to change the names of frames they will need to be updated and recompiled.
-Second, developers may want to change the logic of how their plugins react to a name change.  If the plugin is not changed then a rename operation will look like a create, some copy operations and a delete.  This logic is internally consistent but it is not always what the user wants to see.  For example if the user was editing the frame that was renamed the editting window might disappear because the frame was deleted.  So in some cases the plugin may need to maintain the illusion that the newly created frame is the same as the existing frame.  Therefore plugins will want to listen for the FrameReplaced event (which indicates that a rename is occuring where one frame is getting replaced with another) with a frame listener.  In addition, if the plugin now has logic for listening to the FrameReplaced event, it will probably want to ignore other events like the deletion of the original frame and the creation of the new frame.  To support this we have provided a new method called AbstractEvent.isReplacementEvent() that will inform the caller of whether an event is appearing as part of a rename operation.  Thus one rename event aware component has a ClsListener with the following code:
+The code for renaming a frame (OWL entity) should look like:
      public void directSubclassMoved(ClsEvent event) {
@@ Line 44: / Line 64: @@
 == setName() is gone (Mainly Protege Core Developers) ==
 == Use getSystemFrames() ==
 == Parser.run() ==

← Older revision		Revision as of 20:43, April 14, 2008
Line 5:		Line 5:
	The single biggest change in this version is is that Protege frames cannot be renamed. Previously a rename operation consisted of simply taking an existing frame and assigning a new name to it. In order to support database inclusion properly, we had to change this. The name is now an immutable part of a frame. In order to "rename" a frame, we need to do a shallow copy of the frame to another frame with the new name and then delete the old frame.		The single biggest change in this version is is that Protege frames cannot be renamed. Previously a rename operation consisted of simply taking an existing frame and assigning a new name to it. In order to support database inclusion properly, we had to change this. The name is now an immutable part of a frame. In order to "rename" a frame, we need to do a shallow copy of the frame to another frame with the new name and then delete the old frame.

−	This creates two issues for plugin developers. First,	+	This creates two issues for plugin developers. First, the old Frame.setName call has been replaced with Frame.rename. This means that when plugins need to change the names of frames they will need to be updated and recompiled.
		+
		+	Second, developers may want to change the logic of how their plugins react to a name change. If the plugin is not changed then a rename operation will look like a create, some copy operations and a delete. This logic is internally consistent but it is not always what the user wants to see. For example if the user was editing the frame that was renamed the editting window might disappear because the frame was deleted. So in some cases the plugin may need to maintain the illusion that the newly created frame is the same as the existing frame. Therefore plugins will want to listen for the FrameReplaced event (which indicates that a rename is occuring where one frame is getting replaced with another) with a frame listener. In addition, if the plugin now has logic for listening to the FrameReplaced event, it will probably want to ignore other events like the deletion of the original frame and the creation of the new frame. To support this we have provided a new method called AbstractEvent.isReplacementEvent() that will inform the caller of whether an event is appearing as part of a rename operation. Thus one rename event aware component has a ClsListener with the following code:
		+
		+	public void directSubclassMoved(ClsEvent event) {
		+	if (event.isReplacementEvent()) return;
		+	Cls subclass = event.getSubclass();
		+	int index = (new ArrayList(getChildObjects())).indexOf(subclass);
		+	if (index != -1) {
		+	childRemoved(subclass);
		+	childAdded(subclass, index);
		+	}
		+	}
		+
		+	public void directInstanceAdded(ClsEvent event) {
		+	if (event.isReplacementEvent()) return;
		+	notifyNodeChanged();
		+	}
		+	...
		+
		+	The point is that all events except occuring for the duration of a rename event except for the Replace Frame event are ignored.

Database Inclusion Plugin Devlopers Notes - Revision history

JenniferVendetti at 22:41, October 9, 2008

TaniaTudorache: /* setName() is gone (Mainly Protege Core Developers) */

TaniaTudorache at 18:45, June 3, 2008

TaniaTudorache at 17:35, June 3, 2008

TaniaTudorache: /* setName() is gone (Mainly Protege Core Developers) */

TaniaTudorache at 17:26, June 3, 2008

Tredmond at 00:01, April 25, 2008

Tredmond: /* Renaming Frames (or OWL Entities) */

Tredmond: New page: __TOC__ == Renaming Frames (or OWL Entities) == The single biggest change in this version is is that Protege frames cannot be renamed. Previously a rename operation consisted of simply ...

Tredmond: New page: TOC == Renaming Frames (or OWL Entities) == The single biggest change in this version is is that Protege frames cannot be renamed. Previously a rename operation consisted of simply ...