configmgr/source/treemgr/deferredview.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: deferredview.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef CONFIGMGR_DEFERREDVIEW_HXX_
  32 #define CONFIGMGR_DEFERREDVIEW_HXX_
  33
  34 #include "viewstrategy.hxx"
  35
  36
  37 namespace configmgr
  38 {
  39     namespace view
  40     {
  41 //-----------------------------------------------------------------------------
  42 // View behavior for direct data access
  43 //-----------------------------------------------------------------------------
  44
  45         class DeferredViewStrategy : public ViewStrategy
  46         {
  47         public:
  48             explicit
  49             DeferredViewStrategy() {}
  50
  51         // ViewStrategy implementation
  52         private:
  53             // change handling -required
  54             virtual bool doHasChanges(Node const& _aNode) const;
  55             virtual void doMarkChanged(Node const& _aNode);
  56
  57
  58             // change handling
  59             virtual void doCollectChanges(Node const& _aNode, configuration::NodeChanges& rChanges) const;
  60
  61             // commit protocol
  62             virtual std::auto_ptr<SubtreeChange> doPreCommitChanges(configuration::Tree * tree, std::vector< rtl::Reference<configuration::ElementTree> >& _rRemovedElements);
  63             virtual void doFailedCommit(configuration::Tree * tree, SubtreeChange& rChanges);
  64             virtual void doFinishCommit(configuration::Tree * tree, SubtreeChange& rChanges);
  65             virtual void doRevertCommit(configuration::Tree * tree, SubtreeChange& rChanges);
  66
  67             // notification protocol
  68             virtual configuration::ValueChangeImpl* doAdjustToValueChange(GroupNode const& _aGroupNode, rtl::OUString const& aName, ValueChange const& rExternalChange);
  69         //      virtual void doAdjustToElementChanges(configuration::NodeChangesInformation& rLocalChanges, SetNode const& _aNode, SubtreeChange const& rExternalChanges, TreeDepth nDepth);
  70
  71             // common attributes
  72             virtual node::Attributes doAdjustAttributes(node::Attributes const& _aAttributes) const;
  73
  74             // group member access
  75             virtual configuration::ValueMemberNode doGetValueMember(GroupNode const& _aNode, rtl::OUString const& _aName, bool _bForUpdate) const;
  76
  77             // set element access
  78             virtual void doInsertElement(SetNode const& _aNode, rtl::OUString const& aName, configuration::SetEntry const& aNewEntry);
  79             virtual void doRemoveElement(SetNode const& _aNode, rtl::OUString const& aName);
  80
  81             virtual NodeFactory& doGetNodeFactory();
  82         private:
  83             void implCollectChangesIn(Node const& _aNode, configuration::NodeChanges& rChanges) const;
  84             // commit protocol
  85             std::auto_ptr<SubtreeChange> implPreCommitChanges(Node const& _aNode, std::vector< rtl::Reference<configuration::ElementTree> >& _rRemovedElements);
  86             void implFailedCommit(Node const& _aNode, SubtreeChange& rChanges);
  87             void implFinishCommit(Node const& _aNode, SubtreeChange& rChanges);
  88             void implRevertCommit(Node const& _aNode, SubtreeChange& rChanges);
  89
  90             void implPreCommitSubChanges(GroupNode const & _aGroup, std::vector< rtl::Reference<configuration::ElementTree> >& _rRemovedElements, SubtreeChange& _rParentChange);
  91             void implFailedSubCommitted(GroupNode const & _aGroup, SubtreeChange& rChanges);
  92             void implFinishSubCommitted(GroupNode const & _aGroup, SubtreeChange& rChanges);
  93             void implRevertSubCommitted(GroupNode const & _aGroup, SubtreeChange& rChanges);
  94
  95         };
  96 //-----------------------------------------------------------------------------
  97     }
  98 }
  99
 100 #endif // CONFIGMGR_DEFERREDVIEW_HXX_