/******************************************************************************
 * Product: Adempiere ERP & CRM Smart Business Solution                       *
 * Copyright (C) 1999-2006 ComPiere, Inc. All Rights Reserved.                *
 * This program is free software; you can redistribute it and/or modify it    *
 * under the terms version 2 of the GNU General Public License as published   *
 * by the Free Software Foundation. This program 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 General Public License for more details.                       *
 * You should have received a copy of the GNU General Public License along    *
 * with this program; if not, write to the Free Software Foundation, Inc.,    *
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.                     *
 * For the text or an alternative of this public license, you may reach us    *
 * ComPiere, Inc., 2620 Augustine Dr. #245, Santa Clara, CA 95054, USA        *
 * or via info@compiere.org or http://www.compiere.org/license.html           *
 *****************************************************************************/
package org.compiere.dbPort;

import org.compiere.util.Util;

/**
 *  Model for Join Clause.
 *  <pre>
 *  f.AD_Column_ID = c.AD_Column_ID(+)
 *  </pre>
 *  @author     Jorg Janke
 *  @version    $Id: Join.java,v 1.2 2006/07/30 00:55:04 jjanke Exp $
 */
public class Join
{
	/**
	 *  Constructor
	 *  @param joinClause
	 */
	public Join (String joinClause)
	{
		if (joinClause == null)
			throw new IllegalArgumentException("Join - clause cannot be null");
		evaluate (joinClause);
	}   //  Join

	private String  m_joinClause;
	private String  m_mainTable;
	private String  m_mainAlias;
	private String  m_joinTable;
	private String  m_joinAlias;
	private boolean m_left;
	private String  m_condition;

	/**
	 *  Parse join clause.
	 *  <pre>
	 *  e.g.    tb.AD_User_ID(+)=?
	 *          f.AD_Column_ID = c.AD_Column_ID(+)
	 *  </pre>
	 *  @param joinClause
	 */
	private void evaluate (String joinClause)
	{
		m_joinClause = joinClause;
		int indexEqual = joinClause.indexOf('=');
		m_left = indexEqual < joinClause.indexOf("(+)");    //  converts to LEFT if true
		//  get table alias of it
		if (m_left)     //  f.AD_Column_ID = c.AD_Column_ID(+)  => f / c
		{
			m_mainAlias = joinClause.substring
				(0, Util.findIndexOf(joinClause, '.','=')).trim();          //  f
			int end = joinClause.indexOf('.', indexEqual);
			if (end == -1)  //  no alias
				end = joinClause.indexOf('(', indexEqual);
			m_joinAlias  = joinClause.substring(indexEqual+1, end).trim();  //  c
		}
		else            //  f.AD_Column_ID(+) = c.AD_Column_ID  => c / f
		{
			int end = joinClause.indexOf('.', indexEqual);
			if (end == -1)  //  no alias
				end = joinClause.length();
			m_mainAlias  = joinClause.substring(indexEqual+1, end).trim();  //  c
			m_joinAlias = joinClause.substring
				(0, Util.findIndexOf(joinClause, '.','(')).trim();          //  f
		}
		m_condition = Util.replace(joinClause, "(+)", "").trim();
	}   //  evaluate

	/**
	 *  Get original Join Clause.<br/>
	 *  e.g. f.AD_Column_ID = c.AD_Column_ID(+)
	 *  @return Join cluase
	 */
	public String getJoinClause()
	{
		return m_joinClause;
	}   //  getJoinClause

	/**
	 *  Get Main Table Alias
	 *  @return Main Table Alias
	 */
	public String getMainAlias()
	{
		return m_mainAlias;
	}   //  getMainAlias

	/**
	 *  Get Join Table Alias
	 *  @return Join Table Alias
	 */
	public String getJoinAlias()
	{
		return m_joinAlias;
	}   //  getJoinAlias

	/**
	 *  Is Left Outer Join
	 *  @return true if left outer join
	 */
	public boolean isLeft()
	{
		return m_left;
	}   //  isLeft

	/**
	 *  Get Join condition.<br/>
	 *  e.g. f.AD_Column_ID = c.AD_Column_ID
	 *  @return join condition
	 */
	public String getCondition()
	{
		return m_condition;
	}   //  getCondition

	/**
	 *  Set Main Table Name.
	 *  If table name equals alias, the alias is set to "".
	 *  @param mainTable
	 */
	public void setMainTable(String mainTable)
	{
		if (mainTable == null || mainTable.length() == 0)
			return;
		m_mainTable = mainTable;
		if (m_mainAlias.equals(mainTable))
			m_mainAlias = "";
	}   //  setMainTable

	/**
	 *  Get Main Table Name
	 *  @return Main Table Name
	 */
	public String getMainTable()
	{
		return m_mainTable;
	}   //  getMainTable

	/**
	 *  Set Join Table Name.<br/>
	 *  If join table name equals join alias, the join alias is set to ""
	 *  @param joinTable
	 */
	public void setJoinTable(String joinTable)
	{
		if (joinTable == null || joinTable.length() == 0)
			return;
		m_joinTable = joinTable;
		if (m_joinAlias.equals(joinTable))
			m_joinAlias = "";
	}   //  setJoinTable

	/**
	 *  Get Join Table Name
	 *  @return Join Table Name
	 */
	public String getJoinTable()
	{
		return m_joinTable;
	}   //  getJoinTable

	/**
	 *  This Join is a condition of the first Join. <br/>
	 *  e.g. tb.AD_User_ID(+)=?  or tb.AD_User_ID(+)='123'
	 *  @param first
	 *  @return true if condition
	 */
	public boolean isConditionOf (Join first)
	{
		if (m_mainTable == null         //  did not find Table from "Alias"
			&& (first.getJoinTable().equals(m_joinTable)        //  same join table
				|| first.getMainAlias().equals(m_joinTable)))   //  same main table
			return true;
		return false;
	}   //  isConditionOf

	/**
	 *  String representation
	 *  @return info
	 */
	public String toString()
	{
		StringBuilder sb = new StringBuilder ("Join[");
		sb.append(m_joinClause)
			.append(" - Main=").append(m_mainTable).append("/").append(m_mainAlias)
			.append(", Join=").append(m_joinTable).append("/").append(m_joinAlias)
			.append(", Left=").append(m_left)
			.append(", Condition=").append(m_condition)
			.append("]");
		return sb.toString();
	}   //  toString

}   //  Join
