DataTextFormatOptions.java

/* 
 *
 * SchemaCrawler
 * http://sourceforge.net/projects/schemacrawler
 * Copyright (c) 2000-2009, Sualeh Fatehi.
 *
 * 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.
 *
 */

package schemacrawler.tools.datatext;


import schemacrawler.schemacrawler.Config;
import schemacrawler.schemacrawler.Query;
import schemacrawler.tools.BaseToolOptions;
import schemacrawler.tools.OutputOptions;

/**
 * Data text formatting options.
 * 
 * @author Sualeh Fatehi
 */
public class DataTextFormatOptions
  extends BaseToolOptions
{

  private static final long serialVersionUID = -3031922069348696647L;

  private static final String SHOW_LOBS = "schemacrawler.data.show_lobs";
  private static final String MERGE_ROWS = "schemacrawler.data.merge_rows";

  private boolean mergeRows;
  private boolean showLobs;
  private Query query;

  /**
   * Data text formatting options, defaults.
   */
  public DataTextFormatOptions()
  {
    this(null, null, null);
  }

  /**
   * Data text formatting options from properties.
   * 
   * @param config
   *        Properties
   * @param outputOptions
   *        Page options
   * @param queryName
   *        Query name, in the config
   */
  public DataTextFormatOptions(final Config config,
                               final OutputOptions outputOptions,
                               final String queryName)
  {
    super(outputOptions);

    if (config == null)
    {
      mergeRows = false;
      showLobs = false;
      query = null;
    }
    else
    {
      mergeRows = config.getBooleanValue(MERGE_ROWS);
      showLobs = config.getBooleanValue(SHOW_LOBS);
      if (queryName != null && queryName.length() > 0)
      {
        query = new Query(queryName, config.get(queryName));
      }
      else
      {
        query = null;
      }
    }

  }

  /**
   * Get the query.
   * 
   * @return The query
   */
  public Query getQuery()
  {
    return query;
  }

  /**
   * Whether to merge similar rows.
   * 
   * @return Whether to merge similar rows.
   */
  public boolean isMergeRows()
  {
    return mergeRows;
  }

  /**
   * Whether to show LOBs.
   * 
   * @return Whether to show LOBs.
   */
  public boolean isShowLobs()
  {
    return showLobs;
  }

  /**
   * Whether to merge similar rows.
   * 
   * @param mergeRows
   *        Whether to merge similar rows
   */
  public void setMergeRows(final boolean mergeRows)
  {
    this.mergeRows = mergeRows;
  }

  /**
   * Query.
   * 
   * @param query
   *        Query
   */
  public void setQuery(final Query query)
  {
    if (query == null)
    {
      throw new IllegalArgumentException("Cannot set null Query");
    }
    this.query = query;
  }

  /**
   * Whether to show LOBs.
   * 
   * @param showLobs
   *        Whether to show LOBs
   */
  public void setShowLobs(final boolean showLobs)
  {
    this.showLobs = showLobs;
  }

  /**
   * {@inheritDoc}
   * 
   * @see Object#toString()
   */
  @Override
  public String toString()
  {
    final StringBuilder buffer = new StringBuilder();
    buffer.append("DataTextFormatOptions[");
    buffer.append("mergeRows=").append(mergeRows);
    buffer.append(", showLobs=").append(showLobs);
    buffer.append(", outputOptions=").append(getOutputOptions());
    buffer.append("]");
    return buffer.toString();
  }

}