ChAO API - Revision history

TaniaTudorache at 00:57, October 25, 2008

2008-10-25T00:57:29Z

TaniaTudorache at 00:45, October 25, 2008

2008-10-25T00:45:30Z

TaniaTudorache at 00:41, October 25, 2008

2008-10-25T00:41:36Z

TaniaTudorache at 00:14, October 25, 2008

2008-10-25T00:14:51Z

TaniaTudorache at 00:14, October 25, 2008

2008-10-25T00:14:11Z

TaniaTudorache at 00:13, October 25, 2008

2008-10-25T00:13:24Z

TaniaTudorache at 00:12, October 25, 2008

2008-10-25T00:12:31Z

TaniaTudorache at 00:11, October 25, 2008

2008-10-25T00:11:06Z

TaniaTudorache at 00:06, October 25, 2008

2008-10-25T00:06:50Z

TaniaTudorache: /* Accessing the annotation information */

2008-10-25T00:03:29Z

‎Accessing the annotation information

@@ Line 1: / Line 1: @@
-= Accessing the collaboration features programatically (The Changes and Annotations API) =
+= Accessing the collaboration features programmatically (The Changes and Annotations API) =
 Protege provides support for collaboration through the [[Collaborative Protege|Collaborative Protege]] extension: e.g., tracking changes, annotating ontology components (classes, properties, etc.) or changes (creation of a class). This wiki page describes how to access the change tracking and the annotation information programatically.
@@ Line 6: / Line 6: @@
 The change tracking information and annotation of ontology entities and changes is stored as instances of the '''Changes and Annotation Ontology (ChAO)''', called the '''ChAO KB'''. This wiki page shows how to access this information programmatically.
 __TOC__
@@ Line 112: / Line 113: @@
 The access to the change information is done through the <codeedu.stanford.bmir.protegex.chao.change.api.ChangeFactory</code> class found in the <code>change-model.jar</code> from the edu.stanford.smi.protegex.changes plugin folder. The name of the methods are quite self evident. The code for the ChangeFactory has been generated from the ChAO ontology. For example, if in the ontology there is a class ''Class_Create'' that has a slot attached to it, ''author'', then the generated Java interface ''Class_Create'' will have a method ''getAuthor()''.
 <pre>
-private static void getAllChanges() {
+private void printAllChanges() {
     Project prj = Project.loadProjectFromFile("/tmp/pizza.pprj", new ArrayList());
     KnowledgeBase kb = prj.getKnowledgeBase();
@@ Line 128: / Line 133: @@
+}
 </pre>

@@ Line 102: / Line 102: @@
    Comment comment = factory.createComment(null);
-   factory.fillDefaultValues(comment);
+   factory.fillDefaultValues(comment); //fills in creation date and author
    comment.setBody("I know this class from somewhere..");
@@ Line 110: / Line 110: @@
 == Accessing the changes information ==

@@ Line 83: / Line 83: @@
 === Get annotations associated to an ontology entity ===
-Below is an example of how to get the annotations associated to a class "Pizza".
+Below is an example of how to get the annotations associated to a class "Pizza". (It works also with Frames and other backends)
 == Accessing the changes information ==

@@ Line 44: / Line 44: @@
   public static KnowledgeBase createDbChAOKb(KnowledgeBase kb, URI chaoURI, String dbDriver, String dbUrl, String dbTable, String dbUser, String dbPassword)
-''Italic text''
 Code example:
   private KnowledgeBase void createCHAOFileProject() {

← Older revision		Revision as of 00:14, October 25, 2008
Line 6:		Line 6:

	The change tracking information and annotation of ontology entities and changes is stored as instances of the '''Changes and Annotation Ontology (ChAO)''', called the '''ChAO KB'''. This wiki page shows how to access this information programmatically.		The change tracking information and annotation of ontology entities and changes is stored as instances of the '''Changes and Annotation Ontology (ChAO)''', called the '''ChAO KB'''. This wiki page shows how to access this information programmatically.
		+
		+	__TOC__

	== The ChAO KB Manager ==		== The ChAO KB Manager ==

@@ Line 15: / Line 15: @@
 to get access to the ChAO KB associated to kb.
-=== Create an RDF(S) files ChAO KB project ===
+=== Create a ChAO KB stored in RDF(S) files (default) ===
 You may also create the ChAO KB. To create a ChAO KB stored in RDF(S) files (default option), call:

@@ Line 14: / Line 14: @@
 to get access to the ChAO KB associated to kb.
 You may also create the ChAO KB. To create a ChAO KB stored in RDF(S) files (default option), call:
@@ Line 34: / Line 36: @@
+  }
 To create the ChAO KB stored in a database, call:

← Older revision		Revision as of 00:11, October 25, 2008
Line 58:		Line 58:

	The access to the annotation information is done through the <code>edu.stanford.bmir.protegex.chao.annotation.api.AnnotationFactory</code> class found in the <code>change-model.jar</code> from the edu.stanford.smi.protegex.changes plugin folder. The name of the methods are quite self evident. The code for the AnnotationFactory has been generated from the ChAO ontology. For example, if in the ontology there is a class ''Annotation'' that has a slot attached to it, ''author'', then the generated Java interface ''Annotation'' will have a method ''getAuthor()''.		The access to the annotation information is done through the <code>edu.stanford.bmir.protegex.chao.annotation.api.AnnotationFactory</code> class found in the <code>change-model.jar</code> from the edu.stanford.smi.protegex.changes plugin folder. The name of the methods are quite self evident. The code for the AnnotationFactory has been generated from the ChAO ontology. For example, if in the ontology there is a class ''Annotation'' that has a slot attached to it, ''author'', then the generated Java interface ''Annotation'' will have a method ''getAuthor()''.
		+
		+	=== Get all annotations ===
		+
		+	Example of how to '''print all annotations''' of a pizza.pprj file (stored in a ChAOKB project, for example annotation_pizza.pprj).
		+
		+	private void printAllAnnotations() {
		+	Project prj = Project.loadProjectFromFile("/tmp/pizza.pprj", new ArrayList());
		+	KnowledgeBase kb = prj.getKnowledgeBase();
		+	AnnotationFactory factory = new AnnotationFactory(ChAOKbManager.getChAOKb(kb));
		+	Collection<Annotation> annotations = factory.getAllAnnotationObjects(true);
		+	for (Annotation annotation : annotations) {
		+	System.out.println("\nAuthor: " + annotation.getAuthor());
		+	System.out.println("Date: " + annotation.getCreated().getDate());
		+	System.out.println("Body: " + annotation.getBody());
		+	}
		+	}
		+
		+	=== Get annotations associated to an ontology entity ===
		+
		+	Below is an example of how to get the annotations associated to a class "Pizza".
		+



	== Accessing the changes information ==		== Accessing the changes information ==

@@ Line 57: / Line 57: @@
 == Accessing the annotation information ==
+The access to the annotation information is done through the <code>edu.stanford.bmir.protegex.chao.annotation.api.AnnotationFactory</code> class
 == Accessing the changes information ==