schemacrawler.tools.linter.LinterForeignKeyWithNoIndices Maven / Gradle / Ivy

Go to download
/*
 *
 * SchemaCrawler
 * http://sourceforge.net/projects/schemacrawler
 * Copyright (c) 2000-2014, 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.linter;


import static schemacrawler.tools.lint.LintUtility.columns;
import static schemacrawler.tools.lint.LintUtility.foreignKeyColumns;
import static schemacrawler.tools.lint.LintUtility.listStartsWith;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import schemacrawler.schema.ForeignKey;
import schemacrawler.schema.Index;
import schemacrawler.schema.PrimaryKey;
import schemacrawler.schema.Table;
import schemacrawler.schema.View;
import schemacrawler.tools.lint.BaseLinter;
import schemacrawler.tools.lint.LintSeverity;

public class LinterForeignKeyWithNoIndices
extends BaseLinter
{

  public LinterForeignKeyWithNoIndices()
  {
    setSeverity(LintSeverity.low);
  }

  @Override
  public String getDescription()
  {
    return getSummary();
  }

  @Override
  public String getSummary()
  {
    return "foreign key with no index";
  }

  @Override
  protected void lint(final Table table)
  {
    if (table == null)
    {
      throw new IllegalArgumentException("No table provided");
    }

    final List foreignKeysWithoutIndices = findForeignKeysWithoutIndices(table);
    for (final ForeignKey foreignKey: foreignKeysWithoutIndices)
    {
      addLint(table, getSummary(), foreignKey);
    }
  }

  private Collection> allIndexCoumns(final Table table)
  {
    final List> allIndexCoumns = new ArrayList<>();

    final PrimaryKey primaryKey = table.getPrimaryKey();
    final List pkColumns = columns(primaryKey);
    allIndexCoumns.add(pkColumns);

    for (final Index index: table.getIndices())
    {
      final List indexColumns = columns(index);
      allIndexCoumns.add(indexColumns);
    }
    return allIndexCoumns;
  }

  private List findForeignKeysWithoutIndices(final Table table)
  {
    final List foreignKeysWithoutIndices = new ArrayList<>();
    if (!(table instanceof View))
    {
      final Collection> allIndexCoumns = allIndexCoumns(table);
      for (final ForeignKey foreignKey: table.getImportedForeignKeys())
      {
        final List foreignKeyColumns = foreignKeyColumns(foreignKey);
        boolean hasIndex = false;
        for (final List indexColumns: allIndexCoumns)
        {
          if (listStartsWith(indexColumns, foreignKeyColumns))
          {
            hasIndex = true;
            break;
          }
        }
        if (!hasIndex)
        {
          foreignKeysWithoutIndices.add(foreignKey);
        }
      }
    }
    return foreignKeysWithoutIndices;
  }

}