Documentación sobre las operaciones básicas.

[z.facultad/75.52/treemulator.git] / src / btree_data.h

diff --git a/src/btree_data.h b/src/btree_data.h
index db8ecc180a318834906762505a294b9d42e65aed..b7f457ac2a903731c1bc1665c9f8675e6a164acd 100644 (file)
--- a/src/btree_data.h
+++ b/src/btree_data.h
@@ -6,31 +6,65 @@
 #include <stdlib.h>
 #include "clave.h"
 #include "clave_fija.h"
+#include "clave_variable.h"
 
-/** Dato a guardar en los nodos */
+/** Dato a guardar en los nodos de un árbol B
+ *
+ *  Esta clase es la "magia" de todo. Es la encargada de transformar
+ *  datos RAW sacados de un bloque del archivo que representa un árbol B
+ *  y convertirlos en datos cómodos de manejar desde el programa.
+ *
+ *  Esta clase en la más genérica de todos y utilizada en los nodos internos
+ *  del árbol, que contiene claves y punteros a hijos.
+ *
+ *  También es quién abstrae el uso de distintos tipo de claves al árbol.
+ */
 class BTreeData {
        public:
                BTreeData () {}
-               BTreeData (uchar *node);
+               /** Crea una instancia a partir de un bloque RAW
+                *
+                *  \param node Bloque RAW desde donde leer.
+                *  \param tree_type Tipo de clave utilizada por el árbol.
+                */
+               BTreeData (uchar *node, int tree_type);
+               /** Crea una instancia.
+                *
+                *  \param k Clave a contener.
+                *  \param hijo Hijo derecho.
+                */
                BTreeData (Clave *k, uint child);
+               /** Destructor */
                virtual ~BTreeData ();
 
+               /** Retorna el tamaño en bytes que ocupa en RAW */
                virtual uint Size () const;
+               /** Retorna un array RAW de bytes con el contenido
+                *
+                *  El array retornado debe ser liberado por el programador.
+                */
                virtual uchar *ToArray () const;
 
-               Clave* getClave () { return clave; }
-               uint getChild () { return hijo; }
-               void setChild (uint c) { hijo = c; }
+               /** Retorna la clave manejada */
+               Clave* GetKey () { return clave; }
+               void SetKey (Clave *k) { clave = k; }
+               /** Retorna el hijo apuntado */
+               uint GetChild () { return hijo; }
+               /** Setea el hijo apuntado */
+               void SetChild (uint c) { hijo = c; }
+
+               bool Abrev (BTreeData *anterior);
+               bool DesAbrev (BTreeData *anterior);
 
                bool operator < (const BTreeData &data) const;
                bool operator == (const BTreeData &data) const;
                virtual operator std::string () const {
                        std::string out = (*clave);
                        std::stringstream ss;
-                       ss << "(" << out ;
+                       ss << "(";
+                       ss << out;
                        ss << ")" << "[" << hijo << "]";
-                       ss >> out;
-                       return out;
+                       return ss.str ();
                }
        protected:
                Clave *clave;
@@ -40,8 +74,8 @@ class BTreeData {
 /** Dato a guardar en las hojas */
 class BTreeLeafData:public BTreeData {
        public:
-               BTreeLeafData (Clave *k) { clave = k; }
-               BTreeLeafData (uchar *node) { clave = new ClaveFija (node); }
+               BTreeLeafData (Clave *k) { clave = k; hijo = 0; }
+               BTreeLeafData (uchar *node, int key_type);
                virtual ~BTreeLeafData ();
 
                virtual uint Size () const;
@@ -62,6 +96,7 @@ class BTreeChildData:public BTreeData {
 
                virtual uint Size () const;
                virtual uchar *ToArray () const;
+               bool operator < (const BTreeData &data) const;
                virtual operator std::string () const {
                        std::string out;
                        std::stringstream ss;