Ńņ 5ł!Ic@swdZddkZddklZddklZlZddklZl Z l Z l Z dei fd„ƒYZ dS(s‰ treebeard.models ---------------- Django models. :copyright: 2008 by Gustavo Picon :license: Apache License 2.0 i’’’’N(tQ(tmodelst transaction(tInvalidPositiontInvalidMoveToDescendantt PathOverflowtMissingNodeOrderBytNodecBsÅeZdZed„ƒZed(ed„ƒZed(ed„ƒZ ed„ƒZ ed„ƒZ ed„ƒZ ed„ƒZ ed„ƒZed(d „ƒZed(d „ƒZd „Zd „Zd „Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Z d(d„Z!d„Z"d„Z#d„Z$d„Z%ed „Z&d(d!„Z'd"„Z(d#„Z)d$„Z*d%„Z+d&d)d'„ƒYZ,RS(*s Node class. This is the base class that defines the API of all tree models in this library: - :class:`mp_tree.MP_Node` (materialized path) - :class:`ns_tree.NS_Node` (nested sets) - :class:`al_tree.AL_Node` (adjacency list) cKs t‚dS(s= Adds a root node to the tree. The new root node will be the new rightmost root node. If you want to insert a root node at a specific position, use :meth:`add_sibling` in an already existing root node instead. :param \*\*kwargs: object creation data that will be passed to the inherited Node model :returns: the created node object. It will be save()d by this method. Example:: MyNode.add_root(numval=1, strval='abcd') MyNode.add_root(**{'numval':1, 'strval':'abcd'}) N(tNotImplementedError(tclstkwargs((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytadd_root%sc Csg}g}|ddd…D]}|||fq~}xŠ|oČ|iƒ\}}|diƒ} |o|d| ds cCs t‚dS(st :returns: A queryset of all the node's children Example:: node.get_children() N(R(R2((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyR+JscCs|iƒiƒS(sw :returns: The number of the node's children Example:: node.get_children_count() (R+tcount(R2((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytget_children_countUs cCs t‚dS(sŌ :returns: A queryset of all the node's descendants, doesn't include the node itself (some subclasses may return a list). Example:: node.get_descendants() N(R(R2((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytget_descendantscs cCs|iƒiƒS(sƒ :returns: the number of descendants of a node. Example:: node.get_descendant_count() (R7R5(R2((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyR-oscCs-y|iƒdSWntj odSXdS(s‹ :returns: The leftmost node's child, or None if it has no children. Example:: node.get_first_child() iN(R+R#R$(R2((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytget_first_childzscCs3y|iƒiƒdSWntj odSXdS(s‹ :returns: The rightmost node's child, or None if it has no children. Example:: node.get_last_child() iN(R+R&R#R$(R2((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytget_last_childˆscCs|iƒdS(sĄ :returns: The leftmost node's sibling, can return the node itself if it was the leftmost sibling. Example:: node.get_first_sibling() i(R4(R2((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytget_first_sibling–s cCs|iƒiƒdS(s¹ :returns: The rightmost node's sibling, can return the node itself if it was the rightmost sibling. Example:: node.get_last_sibling() i(R4R&(R2((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytget_last_sibling¢s cCst|iƒ}g}|D]}||iq~}|i|jo0|i|iƒ}|djo ||dSndS(s£ :returns: The previous node's sibling, or None if it was the leftmost sibling. Example:: node.get_prev_sibling() iiN(R4tpktindex(R2tsiblingsRtobjtidstidx((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytget_prev_sibling®s $ cCs~|iƒ}g}|D]}||iq~}|i|jo:|i|iƒ}|t|ƒdjo ||dSndS(s  :returns: The next node's sibling, or None if it was the rightmost sibling. Example:: node.get_next_sibling() iN(R4R<R=tlen(R2R>RR?R@RA((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytget_next_siblingĄs $cCs(t|iƒid|igƒƒdjS(s :returns: ``True`` if the node if a sibling of another node given as an argument, else, returns ``False`` :param node: The node that will be checked as a sibling Example:: node.is_sibling_of(node2) tpk__ini(RCR4tfilterR<(R2R((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyt is_sibling_ofŃs cCs(t|iƒid|igƒƒdjS(s  :returns: ``True`` if the node is a child of another node given as an argument, else, returns ``False`` :param node: The node that will be checked as a parent Example:: node.is_child_of(node2) REi(RCR+RFR<(R2R((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyt is_child_ofįs cCs t‚dS(s :returns: ``True`` if the node if a descendant of another node given as an argument, else, returns ``False`` :param node: The node that will be checked as an ancestor Example:: node.is_descendant_of(node2) N(R(R2R((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytis_descendant_ofńs cKs t‚dS(sJ Adds a child to the node. The new node will be the new rightmost child. If you want to insert a node at a specific position, use the :meth:`add_sibling` method of an already existing child node instead. :param \*\*kwargs: Object creation data that will be passed to the inherited Node model :returns: The created node object. It will be save()d by this method. Example:: node.add_child(numval=1, strval='abcd') node.add_child(**{'numval': 1, 'strval': 'abcd'}) N(R(R2R ((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyRscKs t‚dS(s¶ Adds a new node as a sibling to the current node object. :param pos: The position, relative to the current node object, where the new node will be inserted, can be one of: - ``first-sibling``: the new node will be the new leftmost sibling - ``left``: the new node will take the node's place, which will be moved to the right 1 position - ``right``: the new node will be inserted at the right of the node - ``last-sibling``: the new node will be the new rightmost sibling - ``sorted-sibling``: the new node will be at the right position according to the value of node_order_by :param \*\*kwargs: Object creation data that will be passed to the inherited Node model :returns: The created node object. It will be saved by this method. :raise InvalidPosition: when passing an invalid ``pos`` parm :raise InvalidPosition: when :attr:`node_order_by` is enabled and the ``pos`` parm wasn't ``sorted-sibling`` :raise MissingNodeOrderBy: when passing ``sorted-sibling`` as ``pos`` and the :attr:`node_order_by` attribute is missing Examples:: node.add_sibling('sorted-sibling', numval=1, strval='abcd') node.add_sibling('sorted-sibling', **{'numval': 1, 'strval': 'abcd'}) N(R(R2tposR ((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyt add_siblings'cCs t‚dS(st :returns: the root node for the current node object. Example:: node.get_root() N(R(R2((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytget_rootBscCs|iƒ|jS(s :returns: True if the node is a root node (else, returns False) Example:: node.is_root() (RL(R2((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytis_rootMscCs|iƒdjS(s :returns: True if the node is a leaf node (else, returns False) Example:: node.is_leaf() i(R6(R2((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytis_leafXscCs t‚dS(sž :returns: A queryset containing the current node object's ancestors, starting by the root node and descending to the parent. (some subclasses may return a list) Example:: node.get_ancestors() N(R(R2((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyt get_ancestorscs cCs t‚dS(s÷ :returns: the parent node of the current node object. Caches the result in the object itself to help in loops. :param update: Updates de cached value. Example:: node.get_parent() N(R(R2tupdate((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyt get_parentps cCs t‚dS(sG Moves the current node and all it's descendants to a new position relative to another node. .. note:: The node can be moved under another root node. :param target: The node that will be used as a relative child/sibling when moving :param pos: The position, relative to the target node, where the current node object will be moved to, can be one of: - ``first-child``: the node will be the new leftmost child of the ``target`` node - ``last-child``: the node will be the new rightmost child of the ``target`` node - ``sorted-child``: the new node will be moved as a child of the ``target`` node according to the value of :attr:`node_order_by` - ``first-sibling``: the node will be the new leftmost sibling of the ``target`` node - ``left``: the node will take the ``target`` node's place, which will be moved to the right 1 position - ``right``: the node will be moved to the right of the ``target`` node - ``last-sibling``: the node will be the new rightmost sibling of the ``target`` node - ``sorted-sibling``: the new node will be moved as a sibling of the ``target`` node according to the value of :attr:`node_order_by` .. note:: If no ``pos`` is given the library will use ``last-sibling``, or ``sorted-sibling`` if :attr:`node_order_by` is enabled. :returns: None :raise InvalidPosition: when passing an invalid ``pos`` parm :raise InvalidPosition: when :attr:`node_order_by` is enabled and the ``pos`` parm wasn't ``sorted-sibling`` or ``sorted-child`` :raise InvalidMoveToDescendant: when trying to move a node to one of it's own descendants :raise PathOverflow: when the library can't make room for the node's new position :raise MissingNodeOrderBy: when passing ``sorted-sibling`` or ``sorted-child`` as ``pos`` and the :attr:`node_order_by` attribute is missing Examples:: node.move(node2, 'sorted-child') node.move(node2, 'prev-sibling') N(R(R2ttargetRJ((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytmoves9cCs#|iiid|iƒiƒdS(sŲ Removes a node and all it's descendants. .. note:: Call our queryset's delete to handle children removal. Subclasses will handle extra maintenance. R N(t __class__tobjectsRFR tdelete(R2((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyRV»s cCs¦|d jo|io d}q+d}n|d jotd|fƒ‚n|io!|djotdd ƒ‚n|djo|i otdƒ‚n|S( sE prepare the pos variable for the add_sibling method ssorted-siblings last-siblings first-siblingtlefttrightsInvalid relative position: %ss8Must use %s in add_sibling when node_order_by is enableds Missing node_order_by attribute.N(s first-siblingsleftsrights last-siblingssorted-sibling(ssorted-sibling(R$t node_order_byRR(R2RJ((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyt_fix_add_sibling_optsĒs     c Cs¦|d jo|io d}q+d}n|d jotd |fƒ‚n|io!|djotd dƒ‚n|djo|i otd ƒ‚n|S(s9 prepare the pos var for the move method ssorted-siblings last-siblings first-siblingRWRXs first-childs last-childs sorted-childsInvalid relative position: %ss>Must use %s or %s in add_sibling when node_order_by is enableds Missing node_order_by attribute.N(s first-siblingsleftsrights last-siblingssorted-siblings first-childs last-childs sorted-child(s sorted-childssorted-sibling(ssorted-siblings sorted-child(s sorted-childssorted-sibling(R$RYRR(R2RJ((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyt_fix_move_optsŚs     c Csgg}}xŒ|iD]}t||ƒ}|itg}|D] \}} |th| |6q@~th|d|6gŒƒ|i||fƒqW|itti|ƒƒSy |i|i ƒdi ƒ} Wn t j odg} }nX| |fS(s§ :returns: The position a new node will be inserted related to the current node, and also a queryset of the nodes that must be moved to the right. Called only for Node models with :attr:`node_order_by` This function was taken from django-mptt (BSD licensed) by Jonathan Buchanan: http://code.google.com/p/django-mptt/source/browse/trunk/mptt/signals.py?spec=svn100&r=100#12 s%s__gtiN( RYtgetattrRRRFtreducetoperatortor_t_get_lastpos_in_pathtalltpathR#R$( R2R>tnewobjtfieldstfilterstfieldtvalueRtftvtnewpos((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pytget_sorted_pos_querysetļs   1 tMetacBseZdZeZRS(s! Abstract model. (t__name__t __module__t__doc__tTruetabstract(((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyRlsN((-RmRnRot classmethodR R$tFalseR RpR!R"R%R'R(R)R*R1R3R4R+R6R7R-R8R9R:R;RBRDRGRHRIRRKRLRMRNRORQRSRVRZR[RkRl(((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyRsV k    %          *  <   (RoR^tdjango.db.modelsRt django.dbRRttreebeard.exceptionsRRRRtModelR(((sR/afs/sipb.mit.edu/project/remit/demo-code/django-treebeard-1.1/treebeard/models.pyt s  "