src/core/net/sf/basedb/util/overview/loader/NullNodeLoader.java

Code
Comments
Other
Rev Date Author Line
4740 05 Feb 09 nicklas 1 /**
4740 05 Feb 09 nicklas 2   $Id$
4740 05 Feb 09 nicklas 3
4740 05 Feb 09 nicklas 4   Copyright (C) 2008 Nicklas Nordborg
4740 05 Feb 09 nicklas 5
4740 05 Feb 09 nicklas 6   This file is part of BASE - BioArray Software Environment.
4740 05 Feb 09 nicklas 7   Available at http://base.thep.lu.se/
4740 05 Feb 09 nicklas 8
4740 05 Feb 09 nicklas 9   BASE is free software; you can redistribute it and/or
4740 05 Feb 09 nicklas 10   modify it under the terms of the GNU General Public License
4740 05 Feb 09 nicklas 11   as published by the Free Software Foundation; either version 3
4740 05 Feb 09 nicklas 12   of the License, or (at your option) any later version.
4740 05 Feb 09 nicklas 13
4740 05 Feb 09 nicklas 14   BASE is distributed in the hope that it will be useful,
4740 05 Feb 09 nicklas 15   but WITHOUT ANY WARRANTY; without even the implied warranty of
4740 05 Feb 09 nicklas 16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4740 05 Feb 09 nicklas 17   GNU General Public License for more details.
4740 05 Feb 09 nicklas 18
4740 05 Feb 09 nicklas 19   You should have received a copy of the GNU General Public License
4740 05 Feb 09 nicklas 20   along with BASE. If not, see <http://www.gnu.org/licenses/>.
4740 05 Feb 09 nicklas 21 */
4740 05 Feb 09 nicklas 22 package net.sf.basedb.util.overview.loader;
4740 05 Feb 09 nicklas 23
4740 05 Feb 09 nicklas 24 import net.sf.basedb.core.DbControl;
4740 05 Feb 09 nicklas 25 import net.sf.basedb.core.ItemNotFoundException;
4740 05 Feb 09 nicklas 26 import net.sf.basedb.util.overview.OverviewContext;
4740 05 Feb 09 nicklas 27 import net.sf.basedb.util.overview.Node;
4740 05 Feb 09 nicklas 28
4740 05 Feb 09 nicklas 29 /**
4740 05 Feb 09 nicklas 30   A node loader implementation that doesn't load any nodes.
4740 05 Feb 09 nicklas 31   This may be useful for {@link NodeLoaderFactory} implementations
4740 05 Feb 09 nicklas 32   that wish to handle missing node loaders in the {@link 
4740 05 Feb 09 nicklas 33   NodeLoaderFactory#createNodeLoader(Object)} method differently. Normally this should
4740 05 Feb 09 nicklas 34   result in an {@link ItemNotFoundException}, but an alternative approach may
4740 05 Feb 09 nicklas 35   be to return this loader which will effectively make an end-point in the
4740 05 Feb 09 nicklas 36   node tree. This node loader can't be used for root nodes and will throw
4740 05 Feb 09 nicklas 37   an {@link UnsupportedOperationException} if {@link 
4740 05 Feb 09 nicklas 38   #createRootNode(DbControl, OverviewContext, Object)} is called.
4740 05 Feb 09 nicklas 39
4740 05 Feb 09 nicklas 40   @author Nicklas
4740 05 Feb 09 nicklas 41   @version 2.10
4740 05 Feb 09 nicklas 42   @base.modified $Date$
4740 05 Feb 09 nicklas 43 */
4740 05 Feb 09 nicklas 44 public class NullNodeLoader<I>
4740 05 Feb 09 nicklas 45   implements NodeLoader<I>
4740 05 Feb 09 nicklas 46 {
4740 05 Feb 09 nicklas 47
4740 05 Feb 09 nicklas 48   public NullNodeLoader()
4740 05 Feb 09 nicklas 49   {}
4740 05 Feb 09 nicklas 50
4740 05 Feb 09 nicklas 51   /*
4740 05 Feb 09 nicklas 52     From the NodeLoader interface
4740 05 Feb 09 nicklas 53     -----------------------------
4740 05 Feb 09 nicklas 54   */
4740 05 Feb 09 nicklas 55   /**
4740 05 Feb 09 nicklas 56     @return Always "null"
4740 05 Feb 09 nicklas 57   */
4740 05 Feb 09 nicklas 58   @Override
4740 05 Feb 09 nicklas 59   public Node createForwardNode(DbControl dc, OverviewContext context, Node parentNode)
4740 05 Feb 09 nicklas 60   {
4740 05 Feb 09 nicklas 61     return null;
4740 05 Feb 09 nicklas 62   }
4740 05 Feb 09 nicklas 63
4740 05 Feb 09 nicklas 64   /**
4740 05 Feb 09 nicklas 65     @return Always "null"
4740 05 Feb 09 nicklas 66   */
4740 05 Feb 09 nicklas 67   @Override
4740 05 Feb 09 nicklas 68   public Node createPropertyNode(DbControl dc, OverviewContext context, Node parentNode)
4740 05 Feb 09 nicklas 69   {
4740 05 Feb 09 nicklas 70     return null;
4740 05 Feb 09 nicklas 71   }
4740 05 Feb 09 nicklas 72
4740 05 Feb 09 nicklas 73   /**
4740 05 Feb 09 nicklas 74     @return Always "null"
4740 05 Feb 09 nicklas 75   */
4740 05 Feb 09 nicklas 76   @Override
4740 05 Feb 09 nicklas 77   public Node createReverseNode(DbControl dc, OverviewContext context, Node childNode)
4740 05 Feb 09 nicklas 78   {
4740 05 Feb 09 nicklas 79     return null;
4740 05 Feb 09 nicklas 80   }
4740 05 Feb 09 nicklas 81   
4740 05 Feb 09 nicklas 82   /**
4740 05 Feb 09 nicklas 83     @throws UnsupportedOperationException Always
4740 05 Feb 09 nicklas 84   */
4740 05 Feb 09 nicklas 85   @Override
4740 05 Feb 09 nicklas 86   public Node createRootNode(DbControl dc, OverviewContext context, I item)
4740 05 Feb 09 nicklas 87   {
4740 05 Feb 09 nicklas 88     throw new UnsupportedOperationException();
4740 05 Feb 09 nicklas 89   }
4740 05 Feb 09 nicklas 90   
4740 05 Feb 09 nicklas 91   /**
4740 05 Feb 09 nicklas 92     @return Always "false"
4740 05 Feb 09 nicklas 93   */
4740 05 Feb 09 nicklas 94   @Override
4740 05 Feb 09 nicklas 95   public boolean loadChildNodes(DbControl dc, OverviewContext context, Node node)
4740 05 Feb 09 nicklas 96   {
6046 17 Apr 12 nicklas 97     node.setChildrenLoaded();
4740 05 Feb 09 nicklas 98     return false;
4740 05 Feb 09 nicklas 99   }
4740 05 Feb 09 nicklas 100   // -------------------------------------
4740 05 Feb 09 nicklas 101
4740 05 Feb 09 nicklas 102 }

Generated on Sat Oct  7 02:38:42 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)