MutableDatabase.java

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


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

import schemacrawler.schema.ColumnDataType;
import schemacrawler.schema.Database;
import schemacrawler.schema.DatabaseInfo;
import schemacrawler.schema.JdbcDriverInfo;
import schemacrawler.schema.Procedure;
import schemacrawler.schema.Schema;
import schemacrawler.schema.SchemaCrawlerInfo;
import schemacrawler.schema.Table;

/**
 * Database and connection information. Created from metadata returned
 * by a JDBC call, and other sources of information.
 * 
 * @author Sualeh Fatehi sualeh@hotmail.com
 */
public final class MutableDatabase
  extends BaseNamedObjectMetadata
  implements Database
{

  private static final long serialVersionUID = 4051323422934251828L;

  private final DatabaseInfo databaseInfo;
  private final JdbcDriverInfo jdbcDriverInfo;
  private final SchemaCrawlerInfo schemaCrawlerInfo;
  private final ColumnDataTypes systemColumnDataTypes = new ColumnDataTypes();
  private final List<SchemaReference> schemaRefsCache;

  private MutableDatabase(final DatabaseBuilder builder)
  {
    super(builder);
    databaseInfo = builder.databaseInfo;
    jdbcDriverInfo = builder.jdbcDriverInfo;
    schemaCrawlerInfo = builder.schemaCrawlerInfo;
    schemaRefsCache = builder.schemaRefs;
  }

  public DatabaseInfo getDatabaseInfo()
  {
    return databaseInfo;
  }

  /**
   * {@inheritDoc}
   * 
   * @see schemacrawler.schema.Database#getJdbcDriverInfo()
   */
  public JdbcDriverInfo getJdbcDriverInfo()
  {
    return jdbcDriverInfo;
  }

  /**
   * {@inheritDoc}
   * 
   * @see schemacrawler.schema.Database#getSchema(java.lang.String)
   */
  public MutableSchema getSchema(final String name)
  {
    final Collection<SchemaReference> schemaRefs = getSchemaNames();
    for (final SchemaReference schemaRef: schemaRefs)
    {
      if (schemaRef.getFullName().equals(name))
      {
        return schemaRefsCache.get(schemaRef);
      }
    }
    return null;
  }

  /**
   * {@inheritDoc}
   * 
   * @see schemacrawler.schema.Database#getSchemaCrawlerInfo()
   */
  public SchemaCrawlerInfo getSchemaCrawlerInfo()
  {
    return schemaCrawlerInfo;
  }

  /**
   * {@inheritDoc}
   * 
   * @see schemacrawler.schema.Database#getSchemas()
   */
  public Schema[] getSchemas()
  {
    final List<MutableSchema> schemas = new ArrayList<MutableSchema>(schemaRefsCache);
    Collections.sort(schemas);
    return schemas.toArray(new Schema[schemas.size()]);
  }

  /**
   * {@inheritDoc}
   * 
   * @see schemacrawler.schema.Database#getSystemColumnDataType(java.lang.String)
   */
  public ColumnDataType getSystemColumnDataType(final String name)
  {
    return systemColumnDataTypes.lookup(name);
  }

  /**
   * {@inheritDoc}
   * 
   * @see schemacrawler.schema.Database#getSystemColumnDataTypes()
   */
  public ColumnDataType[] getSystemColumnDataTypes()
  {
    return systemColumnDataTypes.values()
      .toArray(new ColumnDataType[systemColumnDataTypes.size()]);
  }

  void addSystemColumnDataType(final ColumnDataTypeMetadata columnDataType)
  {
    if (columnDataType != null)
    {
      systemColumnDataTypes.add(columnDataType);
    }
  }

  NamedObjectList<MutableProcedure> getAllProcedures()
  {
    final NamedObjectList<MutableProcedure> procedures = new NamedObjectList<MutableProcedure>();
    for (final Schema schema: getSchemas())
    {
      for (final Procedure procedure: schema.getProcedures())
      {
        procedures.add((MutableProcedure) procedure);
      }
    }
    return procedures;
  }

  NamedObjectList<MutableTable> getAllTables()
  {
    final NamedObjectList<MutableTable> tables = new NamedObjectList<MutableTable>();
    for (final Schema schema: getSchemas())
    {
      for (final Table table: schema.getTables())
      {
        tables.add((MutableTable) table);
      }
    }
    return tables;
  }

  MutableSchema getSchema(final SchemaReference schemaRef)
  {
    return schemaRefsCache.get(schemaRef);
  }

  Collection<SchemaReference> getSchemaNames()
  {
    return schemaRefsCache.keySet();
  }

  ColumnDataTypes getSystemColumnDataTypesList()
  {
    return systemColumnDataTypes;
  }

  public static final class DatabaseBuilder
    extends BaseNamedObjectBuilder
  {

    private static final long serialVersionUID = 4051323422934251828L;

    private DatabaseInfo databaseInfo;
    private JdbcDriverInfo jdbcDriverInfo;
    private SchemaCrawlerInfo schemaCrawlerInfo;
    private final ColumnDataTypes systemColumnDataTypes;
    private final List<SchemaReference> schemaRefs;

    public DatabaseBuilder(final String name)
    {
      super(name);
      systemColumnDataTypes = new ColumnDataTypes();
      schemaRefs = new ArrayList<SchemaReference>();
    }

    public DatabaseInfo getDatabaseInfo()
    {
      return databaseInfo;
    }

    public JdbcDriverInfo getJdbcDriverInfo()
    {
      return jdbcDriverInfo;
    }

    public SchemaCrawlerInfo getSchemaCrawlerInfo()
    {
      return schemaCrawlerInfo;
    }

    public Schema[] getSchemas()
    {
      final Schema[] schemaRefsArray = schemaRefs.toArray(new Schema[schemaRefs
        .size()]);
      Arrays.sort(schemaRefsArray);
      return schemaRefsArray;
    }

    /**
     * {@inheritDoc}
     * 
     * @see schemacrawler.schema.Database#getSystemColumnDataTypes()
     */
    public ColumnDataType[] getSystemColumnDataTypes()
    {
      return systemColumnDataTypes.values()
        .toArray(new ColumnDataType[systemColumnDataTypes.size()]);
    }

    public void addSchemaReference(final SchemaReference schemaRef)
    {
      final MutableSchema schema = new MutableSchema(schemaRef);
      schemaRefs.add(schemaRef);
    }

    public void addSchema(final String catalogName, final String schemaName)
    {
      addSchemaReference(new SchemaReference(catalogName, schemaName));
    }

    void addSystemColumnDataType(final ColumnDataType columnDataType)
    {
      if (columnDataType != null)
      {
        systemColumnDataTypes.add(columnDataType);
      }
    }

  }

}