safetaglist.java

Java的Web报表库

/**
 * ========================================
 * JFreeReport : a free Java report library
 * ========================================
 *
 * Project Info:  http://www.jfree.org/jfreereport/index.html
 * Project Lead:  Thomas Morgner;
 *
 * (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.
 *
 * ----------------
 * SafeTagList.java
 * ----------------
 * (C)opyright 2003, by Thomas Morgner and Contributors.
 *
 * Original Author:  Thomas Morgner;
 * Contributor(s):   David Gilbert (for Simba Management Limited);
 *
 * $Id: SafeTagList.java,v 1.5.2.1 2003/08/24 14:18:10 taqua Exp $
 *
 * Changes
 * -------
 * 21-Feb-2003 : Added standard header and Javadocs (DG);
 *
 */
package com.jrefinery.report.io.ext.writer;

import java.util.HashMap;

/**
 * A container for information relating to the tags in the JFreeReport XML report files.  Some tags
 * cannot be spread across multiple lines, because it causes problems for the parser.
 *
 * @author Thomas Morgner.
 */
public class SafeTagList
{
  /** Storage for the tag information. */
  private HashMap safeTags;

  /**
   * A tag description.
   */
  private static class SafeDescription
  {
    /** A flag indicating whether or not it is safe to put a new line after the open tag. */
    private boolean open;

    /** A flag indicating whether or not it is safe to put a new line before the close tag. */
    private boolean close;

    /**
     * Creates a new tag description.
     *
     * @param open  the 'open' flag.
     * @param close  the 'close' flag.
     */
    public SafeDescription(final boolean open, final boolean close)
    {
      this.open = open;
      this.close = close;
    }

    /**
     * Returns the 'open' flag.
     *
     * @return <code>true</code> or <code>false</code>.
     */
    public boolean isOpen()
    {
      return open;
    }

    /**
     * Returns the 'close' flag.
     *
     * @return <code>true</code> or <code>false</code>.
     */
    public boolean isClose()
    {
      return close;
    }
  }

  /**
   * Creates a new list.
   */
  public SafeTagList()
  {
    safeTags = new HashMap();
  }

  /**
   * Adds a tag with both the 'open' and 'close' flags set to <code>true</code>.
   *
   * @param tag  the tag name.
   */
  public void add(final String tag)
  {
    safeTags.put(tag, new SafeDescription(true, true));
  }

  /**
   * Adds a tag.
   *
   * @param tag  the tag name.
   * @param open  the 'open' flag.
   * @param closed  the 'close' flag.
   */
  public void add(final String tag, final boolean open, final boolean closed)
  {
    safeTags.put(tag, new SafeDescription(open, closed));
  }

  /**
   * Returns <code>true</code> if it is safe to start a new line immediately after an open tag.
   *
   * @param tag  the tag name.
   *
   * @return A boolean.
   */
  public boolean isSafeForOpen(final String tag)
  {
    final SafeDescription sd = (SafeDescription) safeTags.get(tag);
    if (sd == null)
    {
      return false;
    }
    return sd.isOpen();
  }

  /**
   * Returns <code>true</code> if it is safe to start a new line immediately before a close tag.
   *
   * @param tag  the tag name.
   *
   * @return A boolean.
   */
  public boolean isSafeForClose(final String tag)
  {
    final SafeDescription sd = (SafeDescription) safeTags.get(tag);
    if (sd == null)
    {
      return false;
    }
    return sd.isClose();
  }
}