hep.analysis
Class HistogramFolder

java.lang.Object
  |
  +--hep.analysis.AbstractNamedObject
        |
        +--hep.analysis.Folder
              |
              +--hep.analysis.HistogramFolder

All Implemented Interfaces:

NamedObject, java.io.Serializable

public class HistogramFolder

extends Folder

Use this class to organize Histogram objects into folders. To store a Histogram in a folder, pass a folder to the Histogram constructor. Folders can be stored in other folders. Simply pass to the HistogramFolder constructor the parent HistogramFolder.

See Also:

Histogram, Serialized Form

Inner classes inherited from class hep.analysis.NamedObject

NamedObject.RenameException

Fields inherited from class hep.analysis.AbstractNamedObject

m_parent

Constructor Summary

HistogramFolder(java.lang.String name)
Creates a new folder in which you can store histograms and other histogram folders.

HistogramFolder(java.lang.String name, HistogramFolder parent)
Creates a new folder in which you can store histograms and other histogram folders, and stores the new folder in another folder.

Method Summary

boolean	canSetClearOnRewind()
void	clear() Clears (resets) all of the histograms in this folder
static HistogramFolder	getDefaultFolder()
protected Folder	getDefaultParent() Get default parent is called when an object is read in with no parent Folder.
Partition	getDefaultPartition()
boolean	isClearOnRewind()
void	setClearOnRewind(boolean value) Set the "clearOnRewind" flag.
static void	setDefaultFolder(HistogramFolder f)
static void	setDefaultFolder(java.lang.String path)
void	setDefaultPartition(Partition partition)
void	setStyle(HistogramStyle style)

Methods inherited from class hep.analysis.Folder

add, find, findSubfolder, getChildren, remove, rename, toString

Methods inherited from class hep.analysis.AbstractNamedObject

delete, getFolder, getName, rename

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HistogramFolder

public HistogramFolder(java.lang.String name)

Creates a new folder in which you can store histograms and other histogram folders.

Parameters:

name - the name for the folder. If a folder with the same name already exists, this object will operate on the same folder (i.e., there won't be two with the same name).

HistogramFolder

public HistogramFolder(java.lang.String name,
                       HistogramFolder parent)

Creates a new folder in which you can store histograms and other histogram folders, and stores the new folder in another folder.

Parameters:

name - the name for the folder. If a folder with the same name already exists, this object will operate on the same folder (i.e., there won't be two with the same name).

parent - the folder to store the new folder in

Method Detail

getDefaultFolder

public static HistogramFolder getDefaultFolder()

setDefaultFolder

public static void setDefaultFolder(HistogramFolder f)

setDefaultFolder

public static void setDefaultFolder(java.lang.String path)

setStyle

public void setStyle(HistogramStyle style)

Parameters:

style - The default style to be used for histograms in this folder

setDefaultPartition

public void setDefaultPartition(Partition partition)

Parameters:

partition - The default partition to be used for histograms in this folder

getDefaultPartition

public Partition getDefaultPartition()

getDefaultParent

protected Folder getDefaultParent()

Description copied from class: AbstractNamedObject

Get default parent is called when an object is read in with no parent Folder. Concrete classes must provide an implementation of this method.

Overrides:

getDefaultParent in class AbstractNamedObject

clear

public void clear()

Clears (resets) all of the histograms in this folder

setClearOnRewind

public void setClearOnRewind(boolean value)

Set the "clearOnRewind" flag. A histogram will only be cleared if the clearOnRewind in all of its parent folders is set.

isClearOnRewind

public boolean isClearOnRewind()

canSetClearOnRewind

public boolean canSetClearOnRewind()