Licenses and comments.

Author: tsutomi

COPYING

@@ -0,0 +1,14 @@
+This file is part of DeveelDB in The  Cloud.
+
+    Foobar 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 3 of 
+    the License, or (at your option) any later version.
+
+    DeveelDB in The Cloud 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 Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with DeveelDB in The Cloud.  If not, see <http://www.gnu.org/licenses/>.

COPYING.HEADER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

COPYING.LESSER

@@ -0,0 +1,15 @@
+using System;
+
+namespace Deveel.Data.Net.Client {
+	/// <summary>
+	/// A client transaction opened on the path instance.
+	/// </summary>
+	public interface IPathTransaction : IDisposable {
+		/// <summary>
+		/// Gets the execution context of the path instance.
+		/// </summary>
+		IPathContext Context { get; }
+
+		DataAddress Commit();
+	}
+}

cloudb/Deveel.Data.Net.Client/IPathTransaction.cs

@@ -2,16 +2,62 @@
 using System.IO;
 
 namespace Deveel.Data.Net {
+	/// <summary>
+	/// An interface used to access and modify data stored
+	/// in a block store component.
+	/// </summary>
 	public interface IBlockStore {
+		/// <summary>
+		/// Verifies if the block storage exists within the
+		/// storage context.
+		/// </summary>
 		bool Exists { get; }
 
+		/// <summary>
+		/// Gets a code that idenitfies the kind of block
+		/// storage of the instance.
+		/// </summary>
+		/// <remarks>
+		/// Since the architecture of the system is open, it is
+		/// required to provide a code that uniquely identifies
+		/// the kind of data storage handled, to permit to the
+		/// communication protocol to correctly identify the
+		/// format of the destination/origin of data to be transported.
+		/// </remarks>
 		int Type { get; }
 
 
+		/// <summary>
+		/// Opens the block store.
+		/// </summary>
+		/// <returns>
+		/// Returns <b>true</b> if the store has been created,
+		/// or <b>false</b> if otherwise it was opened an existing
+		/// block store.
+		/// </returns>
 		bool Open();
 
+		/// <summary>
+		/// Writes the given data in the block pointer given
+		/// </summary>
+		/// <param name="dataId">The identifier of the portion of data, that must
+		/// be ranging between 0 and 16383 (the maximum number of nodes that can be
+		/// stored in a block).</param>
+		/// <param name="buffer">The data to write</param>
+		/// <param name="offset">The offset within the data buffer from where
+		/// to start writing.</param>
+		/// <param name="length">The amount of data to write (65535 bytes maximum).</param>
 		void Write(int dataId, byte[] buffer, int offset, int length);
 
+		/// <summary>
+		/// Reads an amount of data given from the block at the given pointer.
+		/// </summary>
+		/// <param name="dataId">The identifier of the portion of data from where to 
+		/// start reading, </param>
+		/// <param name="buffer"></param>
+		/// <param name="offset"></param>
+		/// <param name="length"></param>
+		/// <returns></returns>
 		int Read(int dataId, byte[] buffer, int offset, int length);
 
 		Stream OpenInputStream();

cloudb/Deveel.Data.Net/IBlockStore.cs

@@ -2,14 +2,58 @@
 using System.Collections.Generic;
 
 namespace Deveel.Data {
+	/// <summary>
+	/// Enumerates the elements of an <see cref="IIndex"/> instance 
+	/// and provides additional functionalities to move backward, 
+	/// modify the content of the index, freely set the position
+	/// within the enumeration and obtain more information about 
+	/// the set enumerated.
+	/// </summary>
 	public interface IIndexCursor : IEnumerator<long>, ICloneable {
+		/// <summary>
+		/// Gets the total number of values in the group defined by 
+		/// the scope of the enumerator.
+		/// </summary>
 		long Count { get; }
 
+		/// <summary>
+		/// Gets or sets the current zero-based offset in the
+		/// enumerator address space.
+		/// </summary>
+		/// <value>
+		/// The returned value is the current position of the
+		/// cursor within the enumeration, -1 if the cursor is
+		/// located before the start of the enumeration, or
+		/// <see cref="Count"/> if the cursor is at the end of
+		/// the enumeration.
+		/// </value>
 		long Position { get; set; }
 
-
+		/// <summary>
+		/// Decreses the cursor of the enumeration to the previous
+		/// position within the enumeration.
+		/// </summary>
+		/// <returns>
+		/// Returns <b>true</b> if the cursor successfully stepped back
+		/// by one within the enumeration, or <b>false</b> otherwise (for
+		/// example, when at the beginning of the enumeration).
+		/// </returns>
 		bool MoveBack();
 
+		/// <summary>
+		/// Removes a single element from the underlying index
+		/// at the current position of the enumeration.
+		/// </summary>
+		/// <remarks>
+		/// When this method returns the interator position will point to 
+		/// the next value in the collection.
+		/// </remarks>
+		/// <returns>
+		/// Returns the element removed from the enumeration.
+		/// </returns>
+		/// <seealso cref="Position"/>
+		/// <seealso cref="MoveNext" />
+		/// <seealso cref="MoveBack" />
 		long Remove();
 	}
 }

cloudb/Deveel.Data.Net/IPathTransaction.cs

@@ -2,14 +2,40 @@
 using System.Collections.Generic;
 
 namespace Deveel.Data {
+	/// <summary>
+	/// Defines a <see cref="ICollection">collection</see> that 
+	/// is sorted against a given order (specified by the 
+	/// provided <see cref="IComparer"/>.
+	/// </summary>
 	public interface ISortedCollection<T> : ICollection<T> {
+		/// <summary>
+		/// Gets the instance of the <see cref="IComparer"/> that is
+		/// used to sort the elements of the collection.
+		/// </summary>
 		IComparer<T> Comparer { get; }
 
+		/// <summary>
+		/// Gets the first element of the collection in the sorted order.
+		/// </summary>
 		T First { get; }
 
+		/// <summary>
+		/// Gets the least element of the collection in the sorted order.
+		/// </summary>
 		T Last { get; }
 
 
+		/// <summary>
+		/// Constructs a subset of the collection that starts from
+		/// the given element (inclusive) and ends at the bottom of
+		/// the list.
+		/// </summary>
+		/// <param name="start">The starting element of the subset collection.</param>
+		/// <returns>
+		/// Returns an instance of <see cref="ISortedCollcetion"/> that
+		/// represents a subset of this collection, starting at the
+		/// given element (inclusive) and ending at the end of this collection.
+		/// </returns>
 		ISortedCollection<T> Tail(T start);
 
 		ISortedCollection<T> Head(T end);