[tinyTiM-commits] SF.net SVN: tinytim:[149] website/trunk/1.5/source

[<lh...@us...>]

Revision: 149
          http://tinytim.svn.sourceforge.net/tinytim/?rev=149&view=rev
Author:   lheuer
Date:     2008-08-25 14:54:55 +0000 (Mon, 25 Aug 2008)

Log Message:
-----------
Updated 1.5 docs

Modified Paths:
--------------
    website/trunk/1.5/source/index.txt

Added Paths:
-----------
    website/trunk/1.5/source/properties.txt

Modified: website/trunk/1.5/source/index.txt
===================================================================
--- website/trunk/1.5/source/index.txt	2008-08-25 14:07:12 UTC (rev 148)
+++ website/trunk/1.5/source/index.txt	2008-08-25 14:54:55 UTC (rev 149)
@@ -1,6 +1,13 @@
 Documentation
 =============
 
+Welcome to tinyTiM, a small and lightweight in-memory Topic Maps engine
+
+tinyTiM provides a native implementation of the `Topic Maps API (TMAPI) <http://www.tmapi.org/>`_.
+
+It holds everything in-memory, so tinyTiM is reasonable fast and needs no setup; 
+just `download <http://sf.net/projects/tinytim>`_ and use it! :)
+
 Contents:
 
 .. toctree::

Added: website/trunk/1.5/source/properties.txt
===================================================================
--- website/trunk/1.5/source/properties.txt	                        (rev 0)
+++ website/trunk/1.5/source/properties.txt	2008-08-25 14:54:55 UTC (rev 149)
@@ -0,0 +1,41 @@
+.. highlight:: java
+
+Properties
+==========
+
+:Author: Lars Heuer (heuer[at]semagia.com)
+:Date: $Date:$
+:Version: $Rev:$
+
+You can configure tinyTiM through some properties.
+
+For convenience, the class ``org.tinytim.Property`` provides constants 
+for tinyTiM-specific properties.
+
+.. Note::
+
+    These properties are tinyTiM-specific, other TMAPI compatible Topic Maps 
+    engines ignore them or may report failures.
+
+
+CollectionFactory property
+--------------------------
+tinyTiM provides two collection factories. The collection factory is used to 
+create instances of ``java.util.Map`` and ``java.util.Set``. If tinyTiM detects, 
+that the `Trove4J <http://trove4j.sourceforge.net/>`_ library is available, it 
+utilizes that library. If Trove4J is not available, it uses a collection factory 
+that utilizes the default Java collections.
+
+As said, tinyTiM tries to detect the approbate collection factory, but you can 
+configure the collection factory explicitly::
+
+    import org.tmapi.core.TopicMapSystemFactory;
+    import org.tmapi.core.TopicMapSystem;
+ 
+    TopicMapSystemFactory tmSysFactory = TopicMapSystemFactory.newInstance();
+ 
+    // Sets the collection factory to the Java implementation even if Trove4J is available
+    tmSysFactory.setProperty("org.tinytim.CollectionFactory", "org.tinytim.JavaCollectionFactory");
+ 
+    TopicMapSystem tmSys = tmSysFactory.newTopicMapSystem();
+


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.