com.rapiddweller.jdbacl.model.DBObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rd-lib-jdbacl Show documentation

'jdbacl' stands for 'Java DataBase ACcess Layer' and provides utilities for accessing JDBC databases from Java programs, retrieving meta information in an object model and querying database data. 'rapiddweller jdbacl' is forked from Databene jdbacl by Volker Bergmann.

There is a newer version: 1.1.17-jdk-11

Show newest version

/*
 * (c) Copyright 2010 by Volker Bergmann. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, is permitted under the terms of the
 * GNU General Public License (GPL).
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS,
 * REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
 * HEREBY EXCLUDED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package com.rapiddweller.jdbacl.model;

import com.rapiddweller.common.Named;

import java.io.Serializable;

/**
 * Abstract parent interface for assembling database objects in a tree using the Composite design pattern.
 * The corresponding interface for Composite objects is {@link CompositeDBObject}.


 * Created: 09.11.2010 11:41:09
 *
 * @author Volker Bergmann
 * @since 0.6.4
 */
public interface DBObject extends Named, Serializable {

  /**
   * Gets object type.
   *
   * @return the type of the DBObject as used in DDL in lower case letters.
   */
  String getObjectType();

  /**
   * Gets doc.
   *
   * @return documentation of the DBObject if available, otherwise null.
   */
  String getDoc();

  /**
   * Gets owner.
   *
   * @return the owner of the DBObject instance or null if no owner has been set.
   */
  CompositeDBObject getOwner();

  /**
   * sets the owner of the DBObject instance.
   *
   * @param owner the owner
   */
  void setOwner(CompositeDBObject owner);

  /**
   * tells if an object has the same definition as another one.
   *
   * @param other the other
   * @return the boolean
   */
  boolean isIdentical(DBObject other);

}