Merge lp:~zeitgeist/zeitgeist/symbols into lp:~zeitgeist/zeitgeist/bluebird

[Seif Lotfy]

Symbols class for generating symbols that will be used later for Interpretation and Manifestation

[Siegfried Gevatter (rainct)]

 - /* datamodel.vala
ontology

 - public static HashTable<string, Symbol> SymbolsCollection = null;
rename all_symbols, put it into Symbol (it's static), make it private

 - displayName, allChildren
display_name, all_children

 - why are you messing with GenericArray<->List? (parents, etc.)
they're the same, so use just one

 - doesn't work when it isn't a direct parent.
you need to lookup the parent in all_symbols (formerly SymbolsCollection)
then iterate over its all_children

 - make the constructor private and let register take the uri/name/etc and
instantiate (later we'll also hide register in some way, eg. making it
protected).

 - we need a "static Symbol from_uri(sting uri)" which returns
"all_symbols.lookup(uri)".

review: Needs Fixing

[Michal Hruby (mhr3)]

I find the Symbol class just an implementation detail, there's no need to expose it at all, as RainCT said you'll want to use static functions with signature like `string[] Symbol.get_children (string uri)`, or `string Symbol.get_description (string uri)` (of course we can use different container, not just array of strings, but ultimately why not make it simple - the only reason that comes to mind would be API compatibility with current libzg).

review: Needs Fixing

[Seif Lotfy (seif)]

> - /* datamodel.vala
> ontology
>
> - public static HashTable<string, Symbol> SymbolsCollection = null;
> rename all_symbols, put it into Symbol (it's static), make it private
>

why put it in symbol?

> - displayName, allChildren
> display_name, all_children

ok

>
> - why are you messing with GenericArray<->List? (parents, etc.)
> they're the same, so use just one

ok i will go with string[]

>
> - doesn't work when it isn't a direct parent.
> you need to lookup the parent in all_symbols (formerly SymbolsCollection)
> then iterate over its all_children

what doesnt work? in case of get_parents it will work since upon construction u already pass the parent classes as an argument...

>
> - make the constructor private and let register take the uri/name/etc and
> instantiate (later we'll also hide register in some way, eg. making it
> protected).
>
> - we need a "static Symbol from_uri(sting uri)" which returns
> "all_symbols.lookup(uri)".

ok

[lp:~zeitgeist/zeitgeist/symbols]

63. By Seif Lotfy on 2011-07-31

changed namings from camelCase to camel_case and added new method from_uri and move SymbolcsCollection into the Symbol class

64. By Seif Lotfy on 2011-07-31

updated to trunk

65. By Seif Lotfy on 2011-07-31

merged and updated get_parents and get_children

66. By Seif Lotfy on 2011-07-31

Change generic arrays to lists in ontology.vala, also make get_parents and get_all_children return strings instead of symbols

67. By Seif Lotfy on 2011-07-31

removed all_children property and fixed the unowned issue

[Michal Hruby (mhr3)]

Since you made get_parents return all parents, there's now no way to get the immediate parents and therefore reconstruct the original ontology graph easily. Fix pls...

review: Needs Fixing

[Seif Lotfy (seif)]

you can get the immidiate stuff by asking for the properties, parents and
children...
I will just change the names to get_all_parents

On Mon, Aug 1, 2011 at 1:55 PM, Michal Hruby <email address hidden> wrote:

> Review: Needs Fixing
> Since you made get_parents return all parents, there's now no way to get
> the immediate parents and therefore reconstruct the original ontology graph
> easily. Fix pls...
> --
> https://code.launchpad.net/~zeitgeist/zeitgeist/symbols/+merge/69927
> Your team Zeitgeist Framework Team is subscribed to branch
> lp:~zeitgeist/zeitgeist/bluebird.
>
> _______________________________________________
> Mailing list: https://launchpad.net/~zeitgeist
> Post to : <email address hidden>
> Unsubscribe : https://launchpad.net/~zeitgeist
> More help : https://help.launchpad.net/ListHelp
>

[lp:~zeitgeist/zeitgeist/symbols]

68. By Seif Lotfy on 2011-08-01

removed unneccesary string

[Michal Hruby (mhr3)]

My point is that the Symbol class itself shouldn't even be public, it should be something private to this source file.

Method that this file needs to expose are (all of them are static):

List<string> Symbol.get_parents (string uri)
List<string> Symbol.get_children (string uri)
List<string> Symbol.get_all_children (string uri)
bool Symbol.is_a (string uri, string parent_uri)

string Symbol.get_display_name (string uri)
string Symbol.get_... (string uri)

and of course to make all of this usable:
void Symbol.register(string uri, string display_name, string[] parents, ...)

review: Needs Fixing

[lp:~zeitgeist/zeitgeist/symbols]

69. By Seif Lotfy on 2011-08-01

changed symbol methods to be static

70. By Seif Lotfy on 2011-08-02

hide symbol

71. By Seif Lotfy on 2011-08-02

added get_parents and get_children

72. By Seif Lotfy on 2011-08-02

changed all methods to be static and no more properties and added get_display_name method

73. By Seif Lotfy on 2011-08-02

updated to trunk

=== modified file 'src/Makefile.am'
--- src/Makefile.am	2011-08-02 01:21:22 +0000
+++ src/Makefile.am	2011-08-02 12:36:46 +0000
@@ -27,6 +27,7 @@
 	table-lookup.vala \
 	sql-schema.vala \
 	where-clause.vala \
+	ontology.vala \
 	$(NULL)
 
 bluebird_LDADD = \

=== added file 'src/ontology.vala'
--- src/ontology.vala	1970-01-01 00:00:00 +0000
+++ src/ontology.vala	2011-08-02 12:36:46 +0000
@@ -0,0 +1,116 @@
+/* datamodel.vala
+ *
+ * Copyright © 2011 Collabora Ltd.
+ *             By Seif Lotfy <[e-mail]>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 2.1 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+private class Symbol
+{
+    private static HashTable<string, Symbol> all_symbols = null;
+    private List<string> parents;
+    private List<string> children;
+    private List<string> all_children;
+    private string uri;
+    private string display_name;
+    
+    private Symbol(string uri, string display_name, string[] parents,string[] children){
+        this.uri = uri;
+        this.display_name = display_name;
+        this.parents = new List<string>();
+        for (int i = 0; i < parents.length; i++)
+            this.parents.append(parents[i]);
+        this.children = new List<string>();
+        for (int i = 0; i < children.length; i++)
+            this.children.append(children[i]);
+    }
+    
+    public static string get_display_name(string symbol_uri)
+    {
+        var symbol = all_symbols.lookup(symbol_uri);
+        return symbol.display_name;
+    }
+    
+    public static List<string> get_all_parents(string symbol_uri)
+    {
+        var symbol = all_symbols.lookup(symbol_uri);
+        var results = new List<string>();
+        foreach (string uri in symbol.parents)
+        {
+            results.append(uri);
+            var parent = all_symbols.lookup(uri);
+            // Recursivly get the other parents
+            foreach (string s in get_all_parents(uri))
+                if (results.index(s) > -1)
+                    results.append(s);
+        }
+        return results;
+    }
+    
+    public static List<string> get_all_children(string symbol_uri)
+    {
+        var results = new List<string>();
+        var symbol = all_symbols.lookup(symbol_uri);
+        foreach (string uri in symbol.all_children)
+            results.append(uri);
+        return results;
+    }
+    
+    public static List<string> get_children(string symbol_uri)
+    {
+        var results = new List<string>();
+        var symbol = all_symbols.lookup(symbol_uri);
+        foreach (string uri in symbol.children)
+            results.append(uri);
+        return results;
+    }
+    
+    public static List<string> get_parents(string symbol_uri)
+    {
+        var results = new List<string>();
+        var symbol = all_symbols.lookup(symbol_uri);
+        foreach (string uri in symbol.parents)
+            results.append(uri);
+        return results;
+    }
+    
+    public static bool is_a(string symbol_uri, string parent_uri)
+    {
+        foreach (string uri in get_all_parents(symbol_uri))
+            if (parent_uri == uri)
+                return true;
+        return false;
+    }
+    
+    public static void register(string uri, string display_name, string[] parents,
+                                string[] children)
+    {
+        if (all_symbols == null)
+            all_symbols = new HashTable<string, Symbol>(str_hash, str_equal);
+        Symbol symbol = new Symbol(uri, display_name, parents, children);
+        all_symbols.insert(uri, symbol);
+    }
+    
+    public static Symbol from_uri(string uri)
+    {
+        return all_symbols.lookup(uri);
+    }
+    
+    public string to_string()
+    {
+        return this.uri;
+    }
+}

=== modified file 'src/zeitgeist-daemon.vala'
--- src/zeitgeist-daemon.vala	2011-07-31 17:41:19 +0000
+++ src/zeitgeist-daemon.vala	2011-08-02 12:36:46 +0000
@@ -3,6 +3,7 @@
  * Copyright © 2011 Seif Lotfy <[e-mail]>
  * Copyright © 2011 Collabora Ltd.
  *             By Siegfried-Angel Gevatter Pujals <[e-mail]>
+ *             By Seif Lotfy <[e-mail]>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by