configtreemodulenode.java

来自「swing编写的库存管理程序。毕业设计类」· Java 代码 · 共 193 行

/**
 * ========================================
 * JFreeReport : a free Java report library
 * ========================================
 *
 * Project Info:  http://www.jfree.org/jfreereport/index.html
 * Project Lead:  Thomas Morgner ([e-mail]);
 *
 * (C) Copyright 2000-2003, by Simba Management Limited and Contributors.
 *
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * ------------------------------
 * ConfigTreeModuleNode.java
 * ------------------------------
 * (C)opyright 2003, by Thomas Morgner and Contributors.
 *
 * Original Author:  Thomas Morgner;
 * Contributor(s):   David Gilbert (for Simba Management Limited);
 *
 * $Id: ConfigTreeModuleNode.java,v 1.5 2003/11/07 18:33:52 taqua Exp $
 *
 * Changes 
 * -------------------------
 * 28-Aug-2003 : Initial version
 *  
 */

package org.jfree.report.modules.gui.config.model;

import java.util.ArrayList;

import org.jfree.report.modules.Module;
import org.jfree.report.util.ReportConfiguration;

/**
 * The config tree module node is used to represent a module in 
 * the report configuration. Modules collect all task-specific configuration
 * keys and represent a report module from the package manager.
 * <p>
 * It is assumed, that all modules define their keys within the namespace
 * of their package.
 *  
 * @author Thomas Morgner
 */
public class ConfigTreeModuleNode extends AbstractConfigTreeNode
{
  /** The configuration prefix shared for all keys of the module. */
  private final String configurationPrefix;
  /** The module definition from the package manager. */ 
  private final Module module;
  /** The report configuration. */
  private final ReportConfiguration configuration;
  /** A list of keys from that module. */
  private final ArrayList assignedKeys;

  /**
   * Creates a new module node for the given module object and report 
   * configuration.
   * 
   * @param module the module for which to build a tree node.
   * @param config the report configuration from where to read the keys.
   */
  public ConfigTreeModuleNode(final Module module, final ReportConfiguration config)
  {
    super(module.getName());
    this.assignedKeys = new ArrayList();
    this.configuration = config;
    this.module = module;
    configurationPrefix = ModuleNodeFactory.getPackage(this.module.getClass());
  }

  /**
   * Returns the module represented by this node.
   * 
   * @return the module used in this node.
   */
  public Module getModule()
  {
    return module;
  }

  /**
   * Returns the report configuration used to fill the values from this
   * node.
   * 
   * @return the used report configuration instance.
   */
  public ReportConfiguration getConfiguration()
  {
    return configuration;
  }

  /**
   * Returns the configuration prefix of this module.
   * 
   * @return the configuration prefix.
   */
  public String getConfigurationPrefix()
  {
    return configurationPrefix;
  }

  /**
   * Returns a string representation of this object.  
   * @see java.lang.Object#toString()
   * 
   * @return the string representing this object.
   */
  public String toString ()
  {
    final StringBuffer buffer = new StringBuffer();
    buffer.append("ConfigTreeModule={");
    buffer.append(getConfigurationPrefix());
    buffer.append("}");
    return buffer.toString();
  }

  /**
   * Returns true if the receiver is a leaf.
   * 
   * @return true if the receiver is a leaf.
   */
  public boolean isLeaf()
  {
    return true;
  }

  /**
   * Returns true if the receiver allows children.
   * 
   * @return true if the receiver allows children.
   */
  public boolean getAllowsChildren()
  {
    return false;
  }

  /**
   * Adds the given key to the list of assigned keys, if not already added.
   * 
   * @param key the new key to be added
   * @throws NullPointerException if the given key is null.
   */
  public void addAssignedKey (final ConfigDescriptionEntry key)
  {
    if (key == null)
    {
      throw new NullPointerException();
    }
    if (assignedKeys.contains(key) == false)
    {
      assignedKeys.add(key);
    }
  }

  /**
   * Removed the given key description from the list of assigned keys.
   * 
   * @param key the key that should be removed.
   * @throws NullPointerException if the given key is null.
   */
  public void removeAssignedKey (final ConfigDescriptionEntry key)
  {
    if (key == null)
    {
      throw new NullPointerException();
    }
    assignedKeys.remove(key);
  }

  /**
   * Returns the list of assigned keys as object array.
   * 
   * @return the assigned keys as array.
   */
  public ConfigDescriptionEntry[] getAssignedKeys ()
  {
    return (ConfigDescriptionEntry[]) assignedKeys.toArray
        (new ConfigDescriptionEntry[assignedKeys.size()]);
  }
}