GrepOptions.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.grep;


import schemacrawler.schemacrawler.InclusionRule;
import schemacrawler.tools.schematext.SchemaTextOptions;

/**
 * Additional options needed for grep.
 * 
 * @author Sualeh Fatehi
 */
public class GrepOptions
  extends SchemaTextOptions
{

  private static final long serialVersionUID = -1606027815351884928L;

  private InclusionRule tableInclusionRule;
  private InclusionRule tableColumnInclusionRule;
  private InclusionRule procedureInclusionRule;
  private InclusionRule procedureColumnInclusionRule;
  private boolean invertMatch;

  /**
   * Creates default options.
   */
  public GrepOptions()
  {
    tableInclusionRule = InclusionRule.INCLUDE_ALL_RULE;
    tableColumnInclusionRule = InclusionRule.EXCLUDE_ALL_RULE;

    procedureInclusionRule = InclusionRule.INCLUDE_ALL_RULE;
    procedureColumnInclusionRule = InclusionRule.EXCLUDE_ALL_RULE;

    invertMatch = false;
  }

  /**
   * Gets the column inclusion rule.
   * 
   * @return Column inclusion rule.
   */
  public InclusionRule getProcedureColumnInclusionRule()
  {
    return procedureColumnInclusionRule;
  }

  /**
   * Gets the procedure inclusion rule.
   * 
   * @return Procedure inclusion rule.
   */
  public InclusionRule getProcedureInclusionRule()
  {
    return procedureInclusionRule;
  }

  /**
   * Gets the column inclusion rule.
   * 
   * @return Column inclusion rule.
   */
  public InclusionRule getTableColumnInclusionRule()
  {
    return tableColumnInclusionRule;
  }

  /**
   * Gets the table inclusion rule.
   * 
   * @return Table inclusion rule.
   */
  public InclusionRule getTableInclusionRule()
  {
    return tableInclusionRule;
  }

  /**
   * Whether to invert matches.
   * 
   * @return Whether to invert matches.
   */
  public boolean isInvertMatch()
  {
    return invertMatch;
  }

  /**
   * Set whether to invert matches.
   * 
   * @param invertMatch
   *        Whether to invert matches.
   */
  public void setInvertMatch(final boolean invertMatch)
  {
    this.invertMatch = invertMatch;
  }

  /**
   * Sets the column inclusion rule.
   * 
   * @param procedureColumnInclusionRule
   *        Column inclusion rule.
   */
  public void setProcedureColumnInclusionRule(final InclusionRule procedureColumnInclusionRule)
  {
    if (procedureColumnInclusionRule == null)
    {
      this.procedureColumnInclusionRule = InclusionRule.EXCLUDE_ALL_RULE;
    }
    else
    {
      this.procedureColumnInclusionRule = procedureColumnInclusionRule;
    }
  }

  /**
   * Sets the procedure inclusion rule.
   * 
   * @param procedureInclusionRule
   *        Procedure inclusion rule.
   */
  public void setProcedureInclusionRule(final InclusionRule procedureInclusionRule)
  {
    if (procedureInclusionRule == null)
    {
      this.procedureInclusionRule = InclusionRule.INCLUDE_ALL_RULE;
    }
    else
    {
      this.procedureInclusionRule = procedureInclusionRule;
    }
  }

  /**
   * Sets the column inclusion rule.
   * 
   * @param tableColumnInclusionRule
   *        Column inclusion rule.
   */
  public void setTableColumnInclusionRule(final InclusionRule tableColumnInclusionRule)
  {
    if (tableColumnInclusionRule == null)
    {
      this.tableColumnInclusionRule = InclusionRule.EXCLUDE_ALL_RULE;
    }
    else
    {
      this.tableColumnInclusionRule = tableColumnInclusionRule;
    }
  }

  /**
   * Sets the table inclusion rule.
   * 
   * @param tableInclusionRule
   *        Table inclusion rule.
   */
  public void setTableInclusionRule(final InclusionRule tableInclusionRule)
  {
    if (tableInclusionRule == null)
    {
      this.tableInclusionRule = InclusionRule.INCLUDE_ALL_RULE;
    }
    else
    {
      this.tableInclusionRule = tableInclusionRule;
    }
  }

  /**
   * {@inheritDoc}
   * 
   * @see Object#toString()
   */
  @Override
  public String toString()
  {
    final StringBuffer buffer = new StringBuffer();
    buffer.append("GrepOptions[");
    buffer.append("invertMatch=").append(invertMatch);
    buffer.append(", tableInclusionRule=").append(tableInclusionRule);
    buffer.append(", tableColumnInclusionRule=")
      .append(tableColumnInclusionRule);
    buffer.append(", procedureInclusionRule=").append(procedureInclusionRule);
    buffer.append(", procedureColumnInclusionRule=")
      .append(procedureColumnInclusionRule);
    buffer.append("textFormatOptions=").append(super.toString());
    buffer.append("]");
    return buffer.toString();
  }

}