I tried to assemble these patterns in 7 rules (now called the “KiWi Coding Patterns”, you may of course also call them “Sebastians stupid misconceptions on programming”). Each of these rules is really easy to adopt and doesn’t take much time and planning from you (just minor changes in your programming style), so they should be really easy to adopt and put into practice. The rules are - with examples - written down below.

What you find below are therefore not really big issues. Each of the rules only takes a small amount of time to realise, which pays off later 100 times. You should adapt each of the rules as a general pattern that you always apply without even thinking about it.

Rule 1: Comment Your Code!

Writing comments is extremely important. A typical scenario: someone checks in a new piece of code which contains an unexpected error that someone else discovers and could easily fix. However, since the code is so complicated and undocumented, it is not easy to find out what the right behaviour would be (writing a log entry, returning a default value, …). In this situation it is absolutely necessary that the code is commented.

Another scenario: a new developer wants to write a KiWi plugin, but he has no idea how to use a certain method. A Javadoc comment at the beginning of each method could help.

Commenting not only helps others. It also helps YOU. Both, afterwards when fixing bugs, and also immediately when writing the code, because it helps you think about how your code is supposed to perform.

Here are some common commenting patterns:

• JavaDoc comment in front of each method; in the Javadoc comment, describe at least what the method is supposed to do, which arguments it takes and what values these might have, and what return values can be expected. A nice plus, particularly for complicated methods, would also be to describe how the method is expected to work like (algorithm …) so that someone else can more easily fix bugs.
• 1-line comment in front of each variable declaration; this comment should briefly describe what values this variable will hold and what it will be used for - particularly for generic types like “Object” or “List”.
• 1-line comment in front of each for- or while-loop; this comment should briefly describe what the loop does
• 1-line comment in each branch of an if-then-else or switch; this comment should briefly describe what the case is (declaratively!) and what is supposed to happen in that case
  large comment in front of each “algorithm” or functional block; e.g. if you are writing a method that issues several queries and merges the results afterwards, describe before each query in several lines what the code is going to do.

Rule 2: Check your Arguments

Most bugs (I would guess 80%) stem from not properly checking all possible values of a variable (especially arguments passed in from somewhere else) when writing the code. Sometimes this is not easy or not even possible, but most of the time it is just laziness which costs 100 times the time afterwards when trying to fix the bug.

So the general rule is: when doing something with a variable, consider all values that variable might have. For values that you consider errors, write some error handling code. If you don’t know how to handle the error, at least write an explanatory message to the log file!

A little anecdote is from the Linux kernel. For many years, it contained a logging statement that said “warning: printer is on fire”. It was issued upon a certain signal from the parallel port that could in principle occur (so a possible variable state), but actually never did (it was meant for 1970s printers who actually could start burning!). The message is: the kernel programmer did a good job because he considered a case that could occur even though he did not really know when it would occur.

Typical scenarios when this happens is when working with collections, when working with strings, and when working with objects that might or might not be null. Examples:

• You have some object passed as argument (or worse: injected into the component), e.g. a User, and you want to print out the first and last name (or call any other method). In this case you should always take into account that the value of the parameter might also be null. Example: Instead of
public void printName(User u) {
System.out.println(u.getFirstName() + " " + u.getLastName());
}

  you should always (few exceptions!) write:
  
public void printName(User u) {
if(u != null) {
System.out.println(u.getFirstName() + " " + u.getLastName());
} else {
System.out.println("unknown user");
}
}

• You have a list, e.g. passed as argument and want to get one of its elements. For example, a method could look as follows:
  
public void processList(List list) {
Object o = list.get(0);
}

  The problem here is that you do not know whether the list contains an element at all, even if it does in your test cases! So when working with lists, always do the following pattern (adapt as necessary):
  
public void processList(List list) {
if(list != null && list.size() > 0) {
Object o = list.get(0);
} else {
log.error("processList: list was empty");
}
}

• You have a string that you need for further processing. In this case you would often check both, whether the string is null and whether it is empty. The common pattern is
  
if(s != null && !s.equals("")) {
...
}


Rule 3: Write Self-Documenting Code

Even when comments are there it is still necessary to keep your code readable and as self-explanatory as possible. Sub-rules are therefore:

Rule 3a: keep code as simple as possible
because simple is easier to understand and less error-prone; always try to find a simple and nice-looking solution as early as possible

Rule 3b: modularize your code if it is too complex
because several functional modules are easier to understand

Rule 3c: properly name your variables and methods
a variable named “result” is always better than a variable named “x” apply a common naming convention, and adopt the Java conventions when writing Java code

Rule 3d: use formatting and indenting to make your code readable

Zunächst mit der nostalgischen Seilbahn von Reichenhall hinauf auf den Predigtstuhl (1. Gipfel). Von dort sind wir einen kurzen Marsch über die Schlegelmulde zum Gipfel des Hochschlegel (2. Gipfel). Am Hochschlegel sind wir dann in eine Busgruppe der Alpenvereinssektion Freising geraten, mit der wir uns um die nächsten Gipfel ein “Wettrennen” geliefert haben. Wieder hinunter und hinauf zum Karkopf, mit 1738m der höchste Gipfel des Lattengebirges (3. Gipfel).

Eine Dohle auf meinem Schuh (auf dem Karkopf).

Vom Karkopf aus konnten wir neben den vielen Dohlen eine Gruppe von 5 Geiern aus dem Nationalpark kommend beobachten (siehe Bilder), die schließlich eindrucksvoll in niedriger Höhe über uns gekreist haben und für die nächsten Stunden unsere Begleiter waren (komisches Gefühl ).

Geier kreisen über dem Karkopf.

Vom Karkopf hinüber auf den 4. Gipfel, den Dreisesselberg, von dem aus man eine fantastische Aussicht auf Reichenhall und Salzburg (von wo sich inzwischen der Nebel verzogen hatte) hat.

Karkopf vom Dreisesselberg gesehen.

Vom Dreisesselberg aus begann der lange Abstieg in Richtung Hallturm. Zunächst hinunter zur Steinbergalm (wo der Sage nach die “Steinerne Agnes” Sennerin war). Dort gab es eine fantastische Herbststimmung:

Herbststimmung oberhalb der Steinbergalm.

Von der Steinbergalm dann etwa auf konstanter Höhe (1200m) hinüber zur “Steinernen Agnes”, einer Felsformation die der Sage nach die versteinerte Form der Sennerin der Steinbergalm darstellt, die zum Schutz auf der Flucht vor dem Teufel versteinert wurde.

Steinerne Agnes aus der Ferne.

Und von der Steinernen Agnes dann schließlich hinüber zur letzten Pause auf dem “Rotofensattel” (am Fuß der “Nase” der “Schlafenden Hexe”). Hier hätten wir versucht die Schlafende Hexe soweit zu kitzeln dass sie niessen muss, aber leider war dieser Versuch vergeblich.:-)

Die Rotofenwand, Nase der schlafenden Hexe.

Schließlich, es war gegen 16 Uhr, dann hinab in Richtung Hallturm, wo wir Katharinas Auto geparkt hatten. Den schönen Tag haben wir dann im Gasthaus “Dreisesselberg” in Bayrisch Gmain ausklingen lassen - ebenfalls sehr empfehlenswert. Fazit: die Überschreitung des Lattengebirges kann man jedem eigentlich nur empfehlen, etwas Kondition ist allerdings gefragt. Das nächste Mal vielleicht statt mit der Seilbahn über den Waxlriessteig vom Saalachsee nach oben.:-)

Beyond my own talk (which I’ll maybe upload later), the other presentations were also very interesting, at least for me. It is interesting to witness and actively accompany the process of a whole industry and in consequence the whole society changing and adopting to the new forms of communication. Particularly, I was amazed by the fact that many news distributers actually gain all their profit from their online presence, whereas the print-based distribution is currently hardly self-sustaining. Also, the relevance of personalisation and of communities has been very nicely demonstrated. To me, this shows that we are right on track with our projects, particularly with KiWi.

Heute war gleich in mehrfacher Hinsicht ein Tag zum feiern. Morgens schnell zum Wahllokal und dann direkt weiter zum Bergwachtfest am Unternberg bei Ruhpolding. Da habe ich Skifahren gelernt und sicher viele Wintertage verbracht, insofern auch eine Bergtour in die Vergangenheit. Auf dem Weg nach  oben ein erster Schock: eine neue, häßliche Forststrasse zerstört und zerschneidet jetzt einen der Berge meiner Jugend - ein Zeichen der Ignoranz gegenüber der Natur und ein Resultat der Forstreform. Der Unternberg ist knapp 1000 Jahre ohne Strasse zurechtgekommen, wieso jetzt eine?

Das Bergwachtfest selbst war nett - alte Freunde getroffen, gutes (Wochinger!) Bier getrunken, die Sonne und den Ausblick genossen.:-)

Das Highlight des Tages waren dann aber eindeutig die ersten Hochrechnungen für die Landtagswahl! Die Vorherrschaft der CSU nach 42 Jahren gebrochen, das ist ein großer Erfolg für alle, die sich für die Natur, für die Bildung, für die Bürger, und gegen die Amigos einsetzen. Ein großer Tag für Bayern! Und möglicherweise ist die Forststrasse einer der Gründe dafür…

And BTW, Peter gets his share of video space as well (click image on the right). His count of “ehms” is much less than mine.:-)

Semantic Wikis - IkeWiki - A Semantic Wiki for Collaborative Knowledge Management

Semantic Wikis - Introduction to semantic wikis

I’d like to particularly point you to the fact that the first KiWi deliverables are now also publicly available, and most of them I consider really well written. As a starting point, I would recommend that you have a look into the KiWi Vision. If you are interested in the four research lines (we call them “Enabling Technologies”), then you might want to look into the state-of-the-art summaries on Reasoning, Reason Maintenance, Information Extraction, and Personalisation.

There are also deliverables on the requirements of the two use cases, but they are currently not publicly available due to privacy reasons. We aim to clarify whether we can make at least parts of them public, as they are very interesting as well.

Burano ist eine Insel außerhalb von Venedig die sich durch die in vielen verschiedenen Farben gemalten Häuser auszeichnet. Laut Massimo liegt das daran daß die Gemeine irgendwann beschlossen hat, die Ortschaft zu renovieren und deswegen allen Bürgern die Farben für ihre Häuser kostenfrei zur Verfügung gestellt hat. Die Bürger wollten aber natürlich keine weißen oder grauen Fassaden wie in Venedig, sondern möglichst viele verschiedene.

Auf Burano haben wir auch einen weiteren fantastischen Sonnenuntergang genossen. Ein weiteres Merkmal von Burano ist außerdem der außerordentlich schiefe Kirchturm - im folgenden Foto mit Mond im Hintergrund (daß er schief ist sieht man da nicht …):

Danach sind wir nach Torcello gefahren, dem Ursprung Venedigs. Massimo zufolge war Torcello ein beliebter Ausflugsort der nahe am Festland gelegenen römischen Stadt Altinum. Nachdem die Barbaren kamen, haben sich die Bewohner der Stadt auf die Insel zurückgezogen (weil die Barbaren nicht schwimmen konnten ) und dort eine blühende Stadt aufgebaut. Im 10. Jh lebten dort wohl 20.000 Leute. Nachdem die Lagune zu dieser Zeit immer mehr versumpfte war die Stadt allerdings Malaria-geplagt und wurde dann irgendwann zu Gunsten Venedigs aufgegeben. Heute gibt es dort neben einer uralten Kathedrale nicht mehr viel. Aber ein sehr berühmtes Restaurant, in dem wir ein fantastisches Abendessen geniesen konnten:

Sonnenuntergang über dem Markusplatz (mit Polfilter, sonst kriegt man die Farben nicht so hin).

Markusplatz im Abendlicht.

Markusplatz im Abendlicht (aus der Nähe).

Tauben auf irgendeinem Platz in Castello.