NamedObjectList.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.crawl;


import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.SortedSet;
import java.util.TreeSet;

import schemacrawler.schema.DatabaseObject;
import schemacrawler.schema.NamedObject;

/**
 * Ordered list of named objects, that can be searched associatively.
 * 
 * @author Sualeh Fatehi
 */
class NamedObjectList<N extends NamedObject>
  implements Serializable, Iterable<N>
{

  private static final long serialVersionUID = 3257847666804142128L;

  private NamedObjectSort sort;
  /** Needs to be sorted, so serialization does not break. */
  private final SortedSet<N> objects;

  /**
   * Construct an initially empty ordered list of named objects, that
   * can be searched associatively.
   * 
   * @param sort
   *        Comparator for named objects, or null for no sorting
   */
  NamedObjectList(final NamedObjectSort sort)
  {
    this.sort = sort;
    this.objects = new TreeSet<N>();
  }

  /**
   * {@inheritDoc}
   * 
   * @see java.lang.Object#equals(java.lang.Object)
   */
  @SuppressWarnings("unchecked")
  @Override
  public boolean equals(final Object obj)
  {
    if (this == obj)
    {
      return true;
    }
    if (obj == null)
    {
      return false;
    }
    if (!(obj instanceof NamedObjectList))
    {
      return false;
    }
    final NamedObjectList<N> other = (NamedObjectList<N>) obj;
    if (objects == null)
    {
      if (other.objects != null)
      {
        return false;
      }
    }
    else if (!objects.equals(other.objects))
    {
      return false;
    }
    return true;
  }

  /**
   * {@inheritDoc}
   * 
   * @see java.lang.Object#hashCode()
   */
  @Override
  public int hashCode()
  {
    final int prime = 31;
    int result = 1;
    result = prime * result + (objects == null? 0: objects.hashCode());
    return result;
  }

  /**
   * {@inheritDoc}
   * 
   * @see java.lang.Iterable#iterator()
   */
  public Iterator<N> iterator()
  {
    return getAll().iterator();
  }

  /**
   * {@inheritDoc}
   * 
   * @see java.lang.Object#toString()
   */
  @Override
  public String toString()
  {
    return getAll().toString();
  }

  /**
   * Add a named object to the list.
   * 
   * @param namedObject
   *        Named object
   */
  void add(final N namedObject)
  {
    if (namedObject == null || namedObject.getName() == null)
    {
      throw new IllegalArgumentException("Cannot add an object to the list");
    }
    objects.add(namedObject);
  }

  /**
   * Gets all named objects in the list, in sorted order.
   * 
   * @return All named objects
   */
  List<N> getAll()
  {
    final List<N> all = new ArrayList<N>(objects);
    Collections.sort(all, sort);
    return Collections.unmodifiableList(all);
  }

  N lookup(final DatabaseObject databaseObject, final String name)
  {
    final AbstractDatabaseObject parent = new AbstractDatabaseObject(databaseObject
      .getCatalogName(),
      databaseObject.getSchemaName(),
      databaseObject.getName())
    {

      private static final long serialVersionUID = 2521419524823080025L;

    };
    return lookup(new AbstractDependantObject(parent, name)
    {

      private static final long serialVersionUID = -6700397214465123353L;
    });
  }

  /**
   * Looks up a named object by name.
   * 
   * @param name
   *        Name
   * @return Named object
   */
  @SuppressWarnings("serial")
  N lookup(final String name)
  {
    return lookup(new AbstractNamedObject(name)
    {

    });
  }

  /**
   * Looks up a named object by name.
   * 
   * @param name
   *        Name
   * @return Named object
   */
  @SuppressWarnings("serial")
  N lookup(final String catalogName, final String schemaName, final String name)
  {
    return lookup(new AbstractDatabaseObject(catalogName, schemaName, name)
    {

    });
  }

  @SuppressWarnings("serial")
  N remove(final String name)
  {
    return remove(new AbstractNamedObject(name)
    {

    });
  }

  void setSortOrder(final NamedObjectSort sort)
  {
    this.sort = sort;
  }

  /**
   * Returns the number of elements in this list.
   * 
   * @return Number of elements in this list.
   */
  int size()
  {
    return objects.size();
  }

  private N lookup(final NamedObject namedObject)
  {
    if (namedObject == null)
    {
      return null;
    }
    for (final N listItem: objects)
    {
      if (namedObject.equals(listItem))
      {
        return listItem;
      }
    }
    return null;
  }

  private N remove(final NamedObject namedObject)
  {
    if (namedObject == null)
    {
      return null;
    }
    for (final Iterator<N> iterator = objects.iterator(); iterator.hasNext();)
    {
      final N listItem = iterator.next();
      if (namedObject.equals(listItem))
      {
        iterator.remove();
        return listItem;
      }
    }
    return null;
  }

}