XMLTree.h

   1 \r
   2 /******************************************************************************\r
   3  *   Copyright (C) 2008 by Diego Arroyuelo                                    *\r
   4  *   Interface for the in-memory XQuery/XPath engine                          *\r
   5  *                                                                            *\r
   6  *   This program is free software; you can redistribute it and/or modify     *\r
   7  *   it under the terms of the GNU Lesser General Public License as published *\r
   8  *   by the Free Software Foundation; either version 2 of the License, or     *\r
   9  *   (at your option) any later version.                                      *\r
  10  *                                                                            *\r
  11  *   This program is distributed in the hope that it will be useful,          *\r
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of           *\r
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *\r
  14  *   GNU Lesser General Public License for more details.                      *\r
  15  *                                                                            *\r
  16  *   You should have received a copy of the GNU Lesser General Public License *\r
  17  *   along with this program; if not, write to the                            *\r
  18  *   Free Software Foundation, Inc.,                                          *\r
  19  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.                *\r
  20  ******************************************************************************/ \r
  21 \r
  22 #ifndef XMLTREE_H_\r
  23 #define XMLTREE_H_\r
  24 #include "TextCollection/TextCollection.h"\r
  25 #include <stdio.h>\r
  26 #include <stdlib.h>\r
  27 #include <cstring>\r
  28 \r
  29 //KIM : OJO\r
  30 //clash between TextCollection/Tools.h and libcds/includes/basics.h\r
  31 #undef W\r
  32 #undef WW\r
  33 #undef Wminusone\r
  34 \r
  35 #include "bp.h"\r
  36 #include <static_bitsequence.h>\r
  37 #include <alphabet_mapper.h>\r
  38 #include <static_sequence.h>\r
  39 using SXSI::TextCollection;\r
  40 \r
  41 \r
  42 // this constant is used to efficiently compute the child operation in the tree\r
  43 #define OPTD 10\r
  44 \r
  45 #define NULLT -1\r
  46 \r
  47 #define PERM_SAMPLE 10\r
  48 \r
  49         // sets bit p in e\r
  50 #define bitset(e,p) ((e)[(p)/W] |= (1<<((p)%W)))\r
  51         // cleans bit p in e\r
  52 #define bitclean(e,p) ((e)[(p)/W] &= ~(1<<((p)%W)))\r
  53 \r
  54 \r
  55 typedef int treeNode;\r
  56 typedef int TagType; \r
  57 typedef int DocID;  \r
  58 \r
  59 typedef struct {\r
  60    int min;\r
  61    int max;\r
  62 } range;\r
  63 \r
  64 \r
  65 //KIM : OJO\r
  66 // I know this class implements the working draft that we have but the logics seem flawed here...\r
  67 // We should have two classes. One XMLTreeBuilder and one XMLTree.\r
  68 // XMLTreeBuilder would have OpenDocument, NewOpenTag,... and CloseDocument would return an XMLTree\r
  69 // XMLTree would have only an initialized structure. If find it really ugly to check (!finished) or (!initialized)\r
  70 // in every function (FirstChild....).\r
  71 \r
  72 class XMLTree {\r
  73    /** Balanced parentheses representation of the tree */\r
  74    bp *Par;\r
  75  \r
  76    /** Mapping from tag identifer to tag name */  \r
  77    unsigned char **TagName;\r
  78   \r
  79    /** boolean flag indicating whether we are indexing empty texts or not */\r
  80    bool indexing_empty_texts; \r
  81    \r
  82    /** Bit vector indicating with a 1 the positions of the non-empty texts. */\r
  83    static_bitsequence_rrr02 *EBVector;  \r
  84                       \r
  85    /** Tag sequence represented with a data structure for rank and select */\r
  86    static_sequence *Tags;\r
  87          uint * tags_fix;\r
  88          uint tags_blen, tags_len;\r
  89 \r
  90    /** The texts in the XML document */\r
  91    TextCollection *Text;\r
  92    /** The texts in the XML document (cached for faster display) */\r
  93    vector<string> CachedText;\r
  94    \r
  95    /** Flag indicating whether the whole data structure has been constructed or \r
  96     * not. If the value is true, you cannot add more texts, nodes, etc. */\r
  97    bool finished;\r
  98 \r
  99    /** Flag indicating whether the construction of the data structure has been\r
 100     * initialized or not (by calling method OpenDocument()). If this is true,\r
 101     * you cannot insert new tags or texts. */\r
 102    bool initialized;\r
 103    \r
 104    /* the following components are used for construction purposes */\r
 105    pb *par_aux;\r
 106    TagType *tags_aux;\r
 107    int npar;\r
 108    int parArraySize;\r
 109    int ntagnames;\r
 110    unsigned int *empty_texts_aux;\r
 111 \r
 112    // KIM : OJO\r
 113    // I added those two. The TagName array should always contains two special tags\r
 114    // <@> for attributes and <$> for PCDATA.\r
 115    // <$> can never be in a document (since we handle the text differently)\r
 116    // but <@> can be returned by the parser. This boolean is needed for the construction\r
 117    // of the Tag bitmap to know if <@> must be taken into account or not\r
 118    bool found_attributes;\r
 119 \r
 120    // KIM : OJO\r
 121    // Allows to disable the TextCollection for benchmarkin purposes\r
 122    bool disable_tc;\r
 123    \r
 124 public:\r
 125 \r
 126    /** Data structure constructor */\r
 127    XMLTree() {finished = false; initialized = false;}; \r
 128  \r
 129    /** Data structure destructor */\r
 130    ~XMLTree();\r
 131    \r
 132    /** root(): returns the tree root. */\r
 133    treeNode Root();\r
 134    \r
 135    /** SubtreeSize(x): the number of nodes (and attributes) in the subtree of \r
 136     * node x. */\r
 137    int SubtreeSize(treeNode x);\r
 138    \r
 139    /** SubtreeTags(x,tag): the number of occurrences of tag within the subtree \r
 140     * of node x. */\r
 141    int SubtreeTags(treeNode x, TagType tag);\r
 142    \r
 143    /** IsLeaf(x): returns whether node x is leaf or not. In the succinct \r
 144     * representation this is just a bit inspection. */\r
 145    bool IsLeaf(treeNode x);\r
 146     \r
 147    /** IsAncestor(x,y): returns whether node x is ancestor of node y. */\r
 148    bool IsAncestor(treeNode x, treeNode y);\r
 149   \r
 150    /** IsChild(x,y): returns whether node x is parent of node y. */\r
 151    bool IsChild(treeNode x, treeNode y);\r
 152    \r
 153    /** NumChildren(x): number of children of node x. Constant time with the \r
 154     * data structure of Sadakane. */\r
 155    int NumChildren(treeNode x);\r
 156    \r
 157    /** ChildNumber(x): returns i if node x is the i-th children of its \r
 158     * parent. */\r
 159    inline int ChildNumber(treeNode x);\r
 160 \r
 161    /** Depth(x): depth of node x, a simple binary rank on the parentheses \r
 162     * sequence. */\r
 163    int Depth(treeNode x);\r
 164    \r
 165    /** Preorder(x): returns the preorder number of node x, just regarding tree \r
 166     * nodes (and not texts). */ \r
 167    int Preorder(treeNode x);\r
 168    \r
 169    /** Postorder(x): returns the postorder number of node x, just regarding \r
 170     * tree nodes (and not texts). */\r
 171    int Postorder(treeNode x);\r
 172    \r
 173    /** Tag(x): returns the tag identifier of node x. */\r
 174    TagType Tag(treeNode x);\r
 175    \r
 176    /** DocIds(x): returns the range (i.e., a pair of integers) of document \r
 177     * identifiers that descend from node x. */\r
 178    range DocIds(treeNode x);\r
 179    \r
 180    /** Parent(x): returns the parent node of node x. */\r
 181    treeNode Parent(treeNode x);\r
 182    \r
 183    /** Child(x,i): returns the i-th child of node x, assuming it exists. */   \r
 184    treeNode Child(treeNode x, int i);\r
 185    \r
 186    /** FirstChild(x): returns the first child of node x, assuming it exists. \r
 187     * Very fast in BP. */\r
 188    treeNode FirstChild(treeNode x);\r
 189    \r
 190    /** NextSibling(x): returns the next sibling of node x, assuming it \r
 191     * exists. */\r
 192    treeNode NextSibling(treeNode x);\r
 193    \r
 194    /** PrevSibling(x): returns the previous sibling of node x, assuming it \r
 195     * exists. */\r
 196    treeNode PrevSibling(treeNode x);\r
 197    \r
 198    /** TaggedChild(x,i,tag): returns the i-th child of node x tagged tag, or \r
 199     * NULLT if there is none. Because of the balanced-parentheses representation \r
 200     * of the tree, this operation is not supported efficiently, just iterating \r
 201     * among the children of node x until finding the desired child. */\r
 202    treeNode TaggedChild(treeNode x, int i, TagType tag);\r
 203    \r
 204    /** TaggedDesc(x,tag): returns the first node tagged tag with larger \r
 205     * preorder than x and within the subtree of x. Returns NULT if there \r
 206     * is none. */\r
 207    treeNode TaggedDesc(treeNode x, TagType tag);\r
 208 \r
 209    /** TaggedNext(x,tag): returns the first node tagged tag with larger \r
 210     * preorder than x. Returns NULT if there is none. */\r
 211    treeNode TaggedNext(treeNode x, TagType tag);\r
 212 \r
 213    /** TaggedPrec(x,tag): returns the first node tagged tag with smaller \r
 214     * preorder than x and not an ancestor of x. Returns NULLT if there \r
 215     * is none. */\r
 216    treeNode TaggedPrec(treeNode x, TagType tag);\r
 217   \r
 218    /** TaggedFoll(x,tag): returns the first node tagged tag with larger \r
 219     * preorder than x and not in the subtree of x. Returns NULLT if there \r
 220     * is none. */\r
 221    treeNode TaggedFoll(treeNode x, TagType tag);\r
 222   \r
 223    /** TaggedFollowingSibling(x,tag) */\r
 224    treeNode TaggedFollowingSibling(treeNode x, TagType tag);\r
 225 \r
 226    /** TaggedAncestor(x, tag): returns the closest ancestor of x tagged \r
 227      * tag. Return NULLT is there is none. */\r
 228    treeNode TaggedAncestor(treeNode x, TagType tag);\r
 229  \r
 230    /** PrevText(x): returns the document identifier of the text to the left of \r
 231     * node x, or NULLT if x is the root node. */\r
 232    DocID PrevText(treeNode x);\r
 233    \r
 234    /** NextText(x): returns the document identifier of the text to the right of \r
 235     * node x, or NULLT if x is the root node. */\r
 236    DocID NextText(treeNode x);\r
 237    \r
 238    /** MyText(x): returns the document identifier of the text below node x, or \r
 239     * NULLT if x is not a leaf node. */\r
 240    DocID MyText(treeNode x);\r
 241    \r
 242    /** TextXMLId(d): returns the preorder of document with identifier d in the \r
 243     * tree consisting of all tree nodes and all text nodes. */\r
 244    int TextXMLId(DocID d);\r
 245    \r
 246    /** NodeXMLId(x): returns the preorder of node x in the tree consisting of \r
 247     * all tree nodes and all text nodes. */\r
 248    int NodeXMLId(treeNode x);\r
 249    \r
 250    /** ParentNode(d): returns the parent node of document identifier d. */\r
 251    treeNode ParentNode(DocID d);\r
 252 \r
 253    /** OpenDocument(empty_texts,sample_rate_text,dtc): initilizes the construction\r
 254     * of the data structure for the XML document. Parameter empty_texts \r
 255     * indicates whether we index empty texts in document or not. Parameter \r
 256     * sample_rate_text indicates the sampling rate for the text searching data\r
 257     * structures (small values get faster searching but a bigger space \r
 258     * requirement). dtc disable the use of the TextCollection\r
 259     * (i.e. everything is considered an empty text *)\r
 260     * Returns a non-zero value upon success, NULLT in case of \r
 261     * error. */\r
 262 \r
 263    int OpenDocument(bool empty_texts, int sample_rate_text, bool dtc);\r
 264 \r
 265    /** CloseDocument(): finishes the construction of the data structure for \r
 266     * the XML document. Tree and tags are represented in the final form, \r
 267     * dynamic data structures are made static, and the flag "finished" is set \r
 268     * to true. After that, the data structure can be queried. */\r
 269    int CloseDocument();\r
 270 \r
 271    /** NewOpenTag(tagname): indicates the event of finding a new opening tag \r
 272     * in the document. Tag name is given. Returns a non-zero value upon \r
 273     * success, and returns NULLT in case of error. */\r
 274    int NewOpenTag(unsigned char *tagname);\r
 275    \r
 276    /** NewClosingTag(tagname): indicates the event of finding a new closing tag\r
 277     *  in the document. Tag name is given. Returns a non-zero value upon \r
 278     *  success, and returns NULLT in case of error. */\r
 279    int NewClosingTag(unsigned char *tagname);\r
 280  \r
 281    /** NewText(s): indicates the event of finding a new (non-empty) text s in \r
 282     * the document. The new text is inserted within the text collection. \r
 283     * Returns a non-zero value upon success, NULLT in case of error. */\r
 284    int NewText(unsigned char *s);\r
 285 \r
 286    /** NewEmptyText(): indicates the event of finding a new empty text in the \r
 287     * document. In case of indexing empty and non-empty texts, we insert the \r
 288     * empty texts into the text collection. In case of indexing only non-empty\r
 289     * texts, it just indicates an empty text in the bit vector of empty texts. \r
 290     * Returns a non-zero value upon success, NULLT in case of error. */\r
 291    int NewEmptyText();\r
 292 \r
 293    /** GetTagId(tagname): returns the tag identifier corresponding to a given \r
 294     * tag name. Returns NULLT in case that the tag name does not exists. */\r
 295    TagType GetTagId(unsigned char *tagname);\r
 296 \r
 297    /** GetTagName(tagid): returns the tag name of a given tag identifier. \r
 298     * Returns NULL in case that the tag identifier is not valid.*/\r
 299    unsigned char *GetTagName(TagType tagid);\r
 300 \r
 301 \r
 302    // OJO\r
 303    /** GetTagName(tagid): returns the tag name of a given tag identifier.     \r
 304     *  The result is just a reference and should not be freed by the caller.\r
 305     */\r
 306    const unsigned char *GetTagNameByRef(TagType tagid);\r
 307 \r
 308    //OJO\r
 309    /** RegisterTag adds a new tag to the tag collection this is needed\r
 310     * if the query contains a tag which is not in the document, we need\r
 311     * to give this new tag a fresh id and store it somewhere. A logical\r
 312     * choice is here.\r
 313     * We might want to use a hashtable instead of an array though.\r
 314     */\r
 315    TagType RegisterTag(unsigned char *tagname);\r
 316 \r
 317    bool EmptyText(DocID i) {\r
 318       return Text->EmptyText(i);\r
 319    }\r
 320    /** Prefix(s): search for texts prefixed by string s. */\r
 321    TextCollection::document_result Prefix(uchar const *s) {\r
 322       return Text->Prefix(s);\r
 323    }\r
 324 \r
 325    /** Suffix(s): search for texts having string s as a suffix. */\r
 326    TextCollection::document_result Suffix(uchar const *s) {\r
 327       return Text->Suffix(s);\r
 328    }\r
 329 \r
 330    /** Equal(s): search for texts equal to string s. */\r
 331    TextCollection::document_result Equal(uchar const *s) {\r
 332       return Text->Equal(s);\r
 333    }\r
 334 \r
 335    /** Contains(s): search for texts containing string s.  */\r
 336    TextCollection::document_result Contains(uchar const *s) {\r
 337       return Text->Contains(s);\r
 338    }\r
 339 \r
 340    /** LessThan(s): returns document identifiers for the texts that\r
 341     * are lexicographically smaller than string s. */\r
 342    TextCollection::document_result LessThan(uchar const *s) {\r
 343       return Text->LessThan(s);\r
 344    }\r
 345    \r
 346    /** IsPrefix(x): returns true if there is a text prefixed by string s. */\r
 347    bool IsPrefix(uchar const *s) {\r
 348       return Text->IsPrefix(s);\r
 349    }          \r
 350    \r
 351    /** IsSuffix(s): returns true if there is a text having string s as a \r
 352     * suffix.*/\r
 353    bool IsSuffix(uchar const *s) {\r
 354       return Text->IsSuffix(s);\r
 355    }\r
 356    \r
 357    /** IsEqual(s): returns true if there is a text that equals given \r
 358     * string s. */\r
 359    bool IsEqual(uchar const *s) {\r
 360       return Text->IsEqual(s);\r
 361    }\r
 362    \r
 363    /** IsContains(s): returns true if there is a text containing string s. */\r
 364    bool IsContains(uchar const *s) {\r
 365       return Text->IsContains(s);\r
 366    }\r
 367    \r
 368    /** IsLessThan(s): returns true if there is at least a text that is \r
 369     * lexicographically smaller than string s. */\r
 370    bool IsLessThan(uchar const *s) {\r
 371       return Text->IsLessThan(s);\r
 372    }\r
 373 \r
 374    /** CountPrefix(s): counting version of Prefix(s). */\r
 375    unsigned CountPrefix(uchar const *s) {\r
 376       return Text->CountPrefix(s);\r
 377    }\r
 378    \r
 379    /** CountSuffix(s): counting version of Suffix(s). */\r
 380    unsigned CountSuffix(uchar const *s) {\r
 381       return Text->CountSuffix(s);\r
 382    }\r
 383    \r
 384    /** CountEqual(s): counting version of Equal(s). */\r
 385    unsigned CountEqual(uchar const *s) {\r
 386       return Text->CountEqual(s);\r
 387    }\r
 388    \r
 389    /** CountContains(s): counting version of Contains(s). */\r
 390    unsigned CountContains(uchar const *s) {\r
 391       return Text->CountContains(s);\r
 392    }\r
 393    \r
 394    /** CountLessThan(s): counting version of LessThan(s). */\r
 395    unsigned CountLessThan(uchar const *s) {\r
 396       return CountLessThan(s);\r
 397    }\r
 398    \r
 399    /** GetText(d): returns the text corresponding to document with\r
 400     * id d. */\r
 401    uchar* GetText(DocID d) {\r
 402       return Text->GetText(d);\r
 403    }\r
 404 \r
 405    uchar* GetCachedText(DocID d) {\r
 406      uchar * str = (uchar*) calloc(sizeof(char),(CachedText.at(d).size() + 1));\r
 407      strcpy((char*) str,(const char*) CachedText.at(d).c_str());\r
 408      return (uchar*) (str);\r
 409    }\r
 410    \r
 411    TextCollection *getTextCollection() {\r
 412       return Text;\r
 413    }\r
 414    /** Save: saves XML tree data structure to file. */\r
 415    void Save(unsigned char *filename);\r
 416       \r
 417    /** Load: loads XML tree data structure from file. sample_rate_text \r
 418     * indicates the sample rate for the text search data structure. */\r
 419    static XMLTree *Load(unsigned char *filename, int sample_rate_text);   \r
 420 };\r
 421 #endif\r