src/core/net/sf/basedb/util/overview/NodeAttribute.java

Code
Comments
Other
Rev Date Author Line
5748 19 Sep 11 nicklas 1 /**
5748 19 Sep 11 nicklas 2   $Id$
5748 19 Sep 11 nicklas 3
5748 19 Sep 11 nicklas 4   Copyright (C) 2011 Nicklas Nordborg
5748 19 Sep 11 nicklas 5
5748 19 Sep 11 nicklas 6   This file is part of BASE - BioArray Software Environment.
5748 19 Sep 11 nicklas 7   Available at http://base.thep.lu.se/
5748 19 Sep 11 nicklas 8
5748 19 Sep 11 nicklas 9   BASE is free software; you can redistribute it and/or
5748 19 Sep 11 nicklas 10   modify it under the terms of the GNU General Public License
5748 19 Sep 11 nicklas 11   as published by the Free Software Foundation; either version 3
5748 19 Sep 11 nicklas 12   of the License, or (at your option) any later version.
5748 19 Sep 11 nicklas 13
5748 19 Sep 11 nicklas 14   BASE is distributed in the hope that it will be useful,
5748 19 Sep 11 nicklas 15   but WITHOUT ANY WARRANTY; without even the implied warranty of
5748 19 Sep 11 nicklas 16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
5748 19 Sep 11 nicklas 17   GNU General Public License for more details.
5748 19 Sep 11 nicklas 18
5748 19 Sep 11 nicklas 19   You should have received a copy of the GNU General Public License
5748 19 Sep 11 nicklas 20   along with BASE. If not, see <http://www.gnu.org/licenses/>.
5748 19 Sep 11 nicklas 21 */
5748 19 Sep 11 nicklas 22 package net.sf.basedb.util.overview;
5748 19 Sep 11 nicklas 23
6455 09 May 14 nicklas 24 import java.util.Set;
6455 09 May 14 nicklas 25
5748 19 Sep 11 nicklas 26 import net.sf.basedb.core.Extract;
5748 19 Sep 11 nicklas 27
5748 19 Sep 11 nicklas 28 /**
5748 19 Sep 11 nicklas 29   Defines per-node attributes that can be used to store
5748 19 Sep 11 nicklas 30   extra information together with a node that doesn't fit
5748 19 Sep 11 nicklas 31   the regular properties.
5748 19 Sep 11 nicklas 32
5748 19 Sep 11 nicklas 33   @author Nicklas
5748 19 Sep 11 nicklas 34   @since 3.0
5748 19 Sep 11 nicklas 35   @base.modified $Date$
5748 19 Sep 11 nicklas 36   @see Node#setAttribute(NodeAttribute, Object)
5748 19 Sep 11 nicklas 37   @see Node#getAttribute(NodeAttribute)
5748 19 Sep 11 nicklas 38 */
5748 19 Sep 11 nicklas 39 public class NodeAttribute<T>
5748 19 Sep 11 nicklas 40 {
5748 19 Sep 11 nicklas 41   
5748 19 Sep 11 nicklas 42   /**
5748 19 Sep 11 nicklas 43     Store a reference to an extract on a node. This is used when passing
5748 19 Sep 11 nicklas 44     a common part of the tree so that we later know which branch to follow.
5748 19 Sep 11 nicklas 45     Eg. when starting on a raw bioassay we should only follow the path with 
5748 19 Sep 11 nicklas 46     the same extract from the physical bioassay as is on the raw bioassay.
5748 19 Sep 11 nicklas 47   */
5748 19 Sep 11 nicklas 48   public static NodeAttribute<Extract> EXTRACT = new NodeAttribute<Extract>();
6455 09 May 14 nicklas 49   
6455 09 May 14 nicklas 50   /**
6455 09 May 14 nicklas 51     Store the ID values of extracts that should be followed on
6455 09 May 14 nicklas 52     upstream paths as long as the current extract is not among
6455 09 May 14 nicklas 53     one of the given parent extracts.
6455 09 May 14 nicklas 54     @since 3.3
6455 09 May 14 nicklas 55   */
6455 09 May 14 nicklas 56   public static NodeAttribute<Set<Integer>> EXTRACT_PATH = new NodeAttribute<Set<Integer>>();
5748 19 Sep 11 nicklas 57
5748 19 Sep 11 nicklas 58   
5748 19 Sep 11 nicklas 59 }