schemacrawler.crawl.AbstractDependantObject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of schemacrawler-api Show documentation
There is a newer version: 16.24.2
/*
========================================================================
SchemaCrawler
http://www.schemacrawler.com
Copyright (c) 2000-2020, 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.crawl;


import static java.util.Objects.requireNonNull;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

import schemacrawler.schema.DatabaseObject;
import schemacrawler.schema.DependantObject;
import schemacrawler.schemacrawler.Identifiers;

/**
 * Represents the dependent of a database object, such as a column or an index,
 * which are dependents of a table.
 *
 * @author Sualeh Fatehi
 */
abstract class AbstractDependantObject
  extends AbstractDatabaseObject
  implements DependantObject
{

  private static final long serialVersionUID = -4327208866052082457L;

  private final DatabaseObjectReference parent;

  /**
   * Effective Java - Item 17 - Minimize Mutability - Package-private
   * constructors make a class effectively final
   *
   * @param parent
   *   Parent of this object
   * @param name
   *   Name of the named object
   */
  AbstractDependantObject(final DatabaseObjectReference parent,
                          final String name)
  {
    super(requireNonNull(parent, "Parent of dependent object not provided")
            .get()
            .getSchema(), name);
    this.parent = parent;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public final String getFullName()
  {
    return Identifiers.STANDARD.quoteFullName(this);
  }

  @Override
  public List toUniqueLookupKey()
  {
    // Make a defensive copy
    final List lookupKey = new ArrayList<>(parent
                                                     .get()
                                                     .toUniqueLookupKey());
    lookupKey.add(getName());
    return lookupKey;
  }

  @Override
  public final int hashCode()
  {
    final int prime = 31;
    int result = super.hashCode();
    result = prime * result + Objects.hash(parent);
    return result;
  }

  @Override
  public final boolean equals(final Object obj)
  {
    if (this == obj)
    {
      return true;
    }
    if (!super.equals(obj))
    {
      return false;
    }
    if (!(obj instanceof DependantObject))
    {
      return false;
    }
    return Objects.equals(parent, ((DependantObject) obj).getParent());
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public final D getParent()
  {
    // Check if parent is null - this can happen if the object is in an
    // incomplete state during deserialization
    if (parent == null)
    {
      return null;
    }
    return parent.get();
  }

  @Override
  public final String getShortName()
  {
    return Identifiers.STANDARD.quoteShortName(this);
  }

  @Override
  public final boolean isParentPartial()
  {
    return parent.isPartialDatabaseObjectReference();
  }

}