RelationshipImpl.java

/*
Copyright (c) 2008 Health Market Science, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package com.healthmarketscience.jackcess.impl;

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

import com.healthmarketscience.jackcess.Column;
import com.healthmarketscience.jackcess.Relationship;
import com.healthmarketscience.jackcess.Table;

/**
 * Information about a relationship between two tables in the database.
 *
 * @author James Ahlborn
 */
public class RelationshipImpl implements Relationship
{

  /** flag indicating one-to-one relationship */
  public static final int ONE_TO_ONE_FLAG =               0x00000001;
  /** flag indicating no referential integrity */
  public static final int NO_REFERENTIAL_INTEGRITY_FLAG = 0x00000002;
  /** flag indicating cascading updates (requires referential integrity) */
  public static final int CASCADE_UPDATES_FLAG =          0x00000100;
  /** flag indicating cascading deletes (requires referential integrity) */
  public static final int CASCADE_DELETES_FLAG =          0x00001000;
  /** flag indicating cascading null on delete (requires referential
      integrity) */
  public static final int CASCADE_NULL_FLAG =             0x00002000;
  /** flag indicating left outer join */
  public static final int LEFT_OUTER_JOIN_FLAG =          0x01000000;
  /** flag indicating right outer join */
  public static final int RIGHT_OUTER_JOIN_FLAG =         0x02000000;

  /** the name of this relationship */
  private final String _name;
  /** the "from" table in this relationship */
  private final Table _fromTable;
  /** the "to" table in this relationship */
  private final Table _toTable;
  /** the columns in the "from" table in this relationship (aligned w/
      toColumns list) */
  private final List<Column> _toColumns;
  /** the columns in the "to" table in this relationship (aligned w/
      toColumns list) */
  private final List<Column> _fromColumns;
  /** the various flags describing this relationship */
  private final int _flags;

  public RelationshipImpl(String name, Table fromTable, Table toTable, int flags,
                          int numCols)
  {
    this(name, fromTable, toTable, flags, 
         Collections.nCopies(numCols, (Column)null),
         Collections.nCopies(numCols, (Column)null));
  }

  public RelationshipImpl(String name, Table fromTable, Table toTable, int flags,
                          List<? extends Column> fromCols,
                          List<? extends Column> toCols)
  {
    _name = name;
    _fromTable = fromTable;
    _fromColumns = new ArrayList<Column>(fromCols);
    _toTable = toTable;
    _toColumns = new ArrayList<Column>(toCols);
    _flags = flags;
  }

  public String getName() {
    return _name;
  }
  
  public Table getFromTable() {
    return _fromTable;
  }

  public List<Column> getFromColumns() {
    return _fromColumns;
  }

  public Table getToTable() {
    return _toTable;
  }

  public List<Column> getToColumns() {
    return _toColumns;
  }

  public int getFlags() {
    return _flags;
  }

  public boolean isOneToOne() {
    return hasFlag(ONE_TO_ONE_FLAG);
  }

  public boolean hasReferentialIntegrity() {
    return !hasFlag(NO_REFERENTIAL_INTEGRITY_FLAG);
  }

  public boolean cascadeUpdates() {
    return hasFlag(CASCADE_UPDATES_FLAG);
  }
  
  public boolean cascadeDeletes() {
    return hasFlag(CASCADE_DELETES_FLAG);
  }

  public boolean cascadeNullOnDelete() {
    return hasFlag(CASCADE_NULL_FLAG);
  }

  public boolean isLeftOuterJoin() {
    return hasFlag(LEFT_OUTER_JOIN_FLAG);
  }

  public boolean isRightOuterJoin() {
    return hasFlag(RIGHT_OUTER_JOIN_FLAG);
  }

  public JoinType getJoinType() {
    if(isLeftOuterJoin()) {
      return JoinType.LEFT_OUTER;
    } else if(isRightOuterJoin()) {
      return JoinType.RIGHT_OUTER;
    }
    return JoinType.INNER;
  }
  
  private boolean hasFlag(int flagMask) {
    return((getFlags() & flagMask) != 0);
  }

  @Override
  public String toString() {
    return CustomToStringStyle.builder(this)
      .append("name", _name)
      .append("fromTable", _fromTable.getName())
      .append("fromColumns", _fromColumns)
      .append("toTable", _toTable.getName())
      .append("toColumns", _toColumns)
      .append("flags", Integer.toHexString(_flags))
      .toString();
  }
  
}