schemacrawler.schemacrawler.InformationSchemaViewsBuilder Maven / Gradle / Ivy

Go to download
/*
========================================================================
SchemaCrawler
http://www.schemacrawler.com
Copyright (c) 2000-2021, Sualeh Fatehi .
All rights reserved.
------------------------------------------------------------------------

SchemaCrawler 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.

SchemaCrawler and the accompanying materials are made available under
the terms of the Eclipse Public License v1.0, GNU General Public License
v3 or GNU Lesser General Public License v3.

You may elect to redistribute this code under any of these licenses.

The Eclipse Public License is available at:
http://www.eclipse.org/legal/epl-v10.html

The GNU General Public License v3 and the GNU Lesser General Public
License v3 are available at:
http://www.gnu.org/licenses/

========================================================================
*/

package schemacrawler.schemacrawler;

import static java.util.Objects.requireNonNull;
import static us.fatehi.utility.IOUtility.readResourceFully;
import static us.fatehi.utility.Utility.isBlank;

import java.sql.Connection;
import java.util.EnumMap;
import java.util.HashMap;
import java.util.Map;
import java.util.function.BiConsumer;

import us.fatehi.utility.ObjectToString;
import us.fatehi.utility.TemplatingUtility;

/** The database specific views to get additional database metadata in a standard format. */
public final class InformationSchemaViewsBuilder
    implements OptionsBuilder {

  public static InformationSchemaViewsBuilder builder() {
    return new InformationSchemaViewsBuilder();
  }

  public static InformationSchemaViewsBuilder builder(
      final InformationSchemaViews informationSchemaViews) {
    return new InformationSchemaViewsBuilder().fromOptions(informationSchemaViews);
  }

  public static InformationSchemaViews newInformationSchemaViews() {
    return new InformationSchemaViews();
  }

  private final Map informationSchemaQueries;

  private InformationSchemaViewsBuilder() {
    informationSchemaQueries = new EnumMap<>(InformationSchemaKey.class);
  }

  @Override
  public InformationSchemaViewsBuilder fromOptions(
      final InformationSchemaViews informationSchemaViews) {
    if (informationSchemaViews == null) {
      return this;
    }

    informationSchemaQueries.putAll(informationSchemaViews.getAllInformationSchemaViews());

    return this;
  }

  /**
   * Information schema views from a map.
   *
   * @param classpath Classpath location for SQL queries.
   * @return Builder
   */
  public InformationSchemaViewsBuilder fromResourceFolder(final String classpath) {
    if (isBlank(classpath)) {
      return this;
    }

    for (final InformationSchemaKey key : InformationSchemaKey.values()) {
      final String resource;
      if (classpath == null) {
        resource = key + ".sql";
      } else {
        resource = String.format("%s/%s.sql", classpath, key);
      }
      final String sql = readResourceFully(resource);
      if (!isBlank(sql)) {
        informationSchemaQueries.put(key, sql);
      }
    }

    return this;
  }

  public void substituteAll(final String templateKey, final String templateValue) {
    final Map map = new HashMap<>();
    map.put(templateKey, templateValue);
    for (final Map.Entry query :
        informationSchemaQueries.entrySet()) {
      String sql = query.getValue();
      sql = TemplatingUtility.expandTemplate(sql, map);
      query.setValue(sql);
    }
  }

  @Override
  public InformationSchemaViews toOptions() {
    return new InformationSchemaViews(informationSchemaQueries);
  }

  @Override
  public String toString() {
    return ObjectToString.toString(informationSchemaQueries);
  }

  public InformationSchemaViewsBuilder withFunction(
      final BiConsumer
          informationSchemaViewsBuilderForConnection,
      final Connection connection) {
    if (informationSchemaViewsBuilderForConnection != null) {
      informationSchemaViewsBuilderForConnection.accept(this, connection);
    }
    return this;
  }

  /**
   * Sets definitions SQL.
   *
   * @param key SQL query key
   * @param sql Definitions SQL.
   * @return Builder
   */
  public InformationSchemaViewsBuilder withSql(final InformationSchemaKey key, final String sql) {
    requireNonNull(key, "No key provided");
    if (isBlank(sql)) {
      informationSchemaQueries.remove(key);
    } else {
      informationSchemaQueries.put(key, sql);
    }
    return this;
  }
}