biggests.tree
Class Dataset

java.lang.Object
  extended by biggests.tree.Dataset
All Implemented Interfaces:
java.io.Serializable

public class Dataset
extends java.lang.Object
implements java.io.Serializable

Title: Dataset

Description: Defines a dataset information object, which holds all the relevant information about a specific dataset loaded.

Copyright: Copyright (C) 2007 Joana Gonçalves This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Constructor Summary
Dataset(int id)
          Constructs a new Dataset object with the given id.
 
Method Summary
 int generateNewNodeObjectTypeId(int nodeObjectType, boolean update)
          Generates a new id value (within this dataset) for a new node information object with the specified data type.
 int getId()
          Returns the dataset id.
 int getLastBiclusterGroupId()
          Returns the last id given to a bicluster group node information object within the current dataset.
 int getLastDiscretizedId()
          Returns the last id given to a discretized node information object within the current dataset.
 int getLastPostprocessedGroupId()
          Returns the last id given to a post-processed group node information object within the current dataset.
 int getLastPreprocessedId()
          Returns the last id given to a preprocessed node information object within the current dataset.
 java.lang.String getName()
          Returns the name of this dataset.
 java.lang.String toString()
          Overrides toString() method from class Object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

Dataset

public Dataset(int id)
Constructs a new Dataset object with the given id.

Parameters:
id - int the given id
Method Detail

generateNewNodeObjectTypeId

public int generateNewNodeObjectTypeId(int nodeObjectType,
                                       boolean update)
                                throws InvalidNodeObjectTypeException
Generates a new id value (within this dataset) for a new node information object with the specified data type.

Parameters:
nodeObjectType - int the type of the node object:
NodeInfo.PREPROCESSED
NodeInfo.DISCRETIZED
NodeInfo.BICLUSTER_GROUP
NodeInfo.POSTPROCESSED_GROUP
update - boolean true to update the number of nodes created in the tree for this nodeObjectType so far; false if one only wants to know which id is next, without inserting a new node in the tree
Returns:
int the new id value
Throws:
InvalidNodeObjectTypeException - when the node object type is not valid

getName

public java.lang.String getName()
Returns the name of this dataset. Usually the name is only Dataset.

Returns:
the String holding the name of the dataset

getId

public int getId()
Returns the dataset id.

Returns:
int the dataset id

getLastPreprocessedId

public int getLastPreprocessedId()
Returns the last id given to a preprocessed node information object within the current dataset.

Returns:
int the last id given to a preprocessed node information object within the current dataset

getLastDiscretizedId

public int getLastDiscretizedId()
Returns the last id given to a discretized node information object within the current dataset.

Returns:
int the last id given to a discretized node information object within the current dataset

getLastBiclusterGroupId

public int getLastBiclusterGroupId()
Returns the last id given to a bicluster group node information object within the current dataset.

Returns:
int the last id given to a bicluster group node information object within the current dataset

getLastPostprocessedGroupId

public int getLastPostprocessedGroupId()
Returns the last id given to a post-processed group node information object within the current dataset.

Returns:
int the last id given to a post-processed group node information object within the current dataset

toString

public java.lang.String toString()
Overrides toString() method from class Object. Returns a formatted string with the contents that will appear in the tree as node name.

Overrides:
toString in class java.lang.Object
Returns:
String the dataset node name in the tree