package com.explosion.expfmodules.rdbmsconn.dbom;
   
   import java.util.ArrayList;
   import java.util.HashMap;
   import java.util.Iterator;
   import java.util.List;
   import java.util.Map;
   
   import org.apache.log4j.LogManager;
  import org.apache.log4j.Logger;
  
  
  /*
   * =============================================================================
   * 
   * Copyright 2004 Stephen Cowx
   * 
   * 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.
   * 
   * =============================================================================
   */
  
  /***
   * @author Stephen Cowx
   */
  
  public class DBEntity
  {
  
  	public static final int TYPE_OTHER = 0;
  	public static final int TYPE_SCHEMA = 1;
  	public static final int TYPE_CATALOG = 2;
  	public static final int TYPE_TABLE = 3;
  	public static final int TYPE_VIEW = 4;
  	public static final int TYPE_SYSTEM_TABLE = 5;
  	public static final int TYPE_SYNONYM = 6;
  
  	private String catalogName;
  	private String schemaName;
  	private String entityName;
  	private String ownerName;
  	private int entityType;
  	private Map columns = new HashMap();
  	private List columnsList = new ArrayList();
  	private List pseudoColumns = new ArrayList(); 
  	
  	private DBEntityBuffer dbEntityBuffer = new DBEntityBuffer();
  	
  	private static Logger log = LogManager.getLogger(DBEntity.class);
  
  	public DBEntity(String catalogName, String schemaName, String entityName, int entityType)
  	{
  		this.catalogName = catalogName;
  		this.schemaName = schemaName;
  		this.entityName = check(entityName);
  		this.entityType = entityType;
  	}
  	
  	/***
  	 * This method clears the metadata for this object so that it can be refreshed from the 
  	 * database.  This does not clear the buffered incofmration like sorts and things like
  	 * that.  It only clears column names etc.
  	 */
  	public void clearMetadata()
  	{
  	    columns = new HashMap();
  		columnsList = new ArrayList();
  		pseudoColumns = new ArrayList();    
  	}
  	
  	private String check(String name)
  	{
  	    if (name != null)
  	        return name.replaceAll("/","//");
  	    else
  	        return name;
  	}
  
  	public String getCatalogName()
  	{
  		return catalogName;
  	}
  
  	public String getSchemaName()
  	{
  		return schemaName;
  	}
  
  	public String getEntityName()
  	{
  		return entityName;
  	}
  	
  	public String getOwnerName()
 	{
 	    return ownerName;
 	}
 
 	public int getEntityType()
 	{
 		return entityType;
 	}
 
 	public DBEntityBuffer getDBEntityBuffer()
 	{
 		return dbEntityBuffer;
 	}
 
 	public void setCatalogName(String newCatalogName)
 	{
 		this.catalogName = newCatalogName;
 	}
 
 	public void setSchemaName(String newSchemaName)
 	{
 		this.schemaName = newSchemaName;
 	}
 
 	public void setEntityName(String newEntityName)
 	{
 		this.entityName = newEntityName;
 	}
 	
 	public void setOwnerName(String ownerName)
 	{
 	    this.ownerName = ownerName;
 	}
 
 	public void setEntityType(int newEntityType)
 	{
 		this.entityType = newEntityType;
 	}
 
 	public void setDBEntityBuffer(DBEntityBuffer dbEntityBuffer)
 	{
 		this.dbEntityBuffer = dbEntityBuffer;
 	}
 
 	/***
 	 * Returns the name of this entity (not a fully qualified name)
 	 * @see java.lang.Object#toString()
 	 * @return
 	 */
 	public String toString()
 	{
 		return entityName;
 	}
 
 	/***
 	 * Returns a List of the columns for this entity.
 	 * @return
 	 */
 	public List getColumns()
 	{
 		return this.columnsList;
 	}
 
 	/***
 	 * Adds a column to the Map of columns for this Entity
 	 * 
 	 * @param column
 	 * @return
 	 */
 	public void addColumn(DBEntityColumn column) throws IllegalArgumentException
 	{
 	    columnsList.add(column);
 	    columns.put(column.getColumnName(), column);
 	}
 
 	/***
 	 * Returns the DBEntityColumn for this entity
 	 * 
 	 * @param columnName
 	 * @return
 	 */
 	public DBEntityColumn getColumn(String columnName)
 	{
 		return (DBEntityColumn) columns.get(columnName);
 	}
 
 	/***
 	 * Returns a MNap of PrimaryKeys for this column
 	 * 
 	 * @return
 	 */
 	public List getPrimaryKeyColumns()
 	{
 	    List list = new ArrayList();
 		for (Iterator i = columnsList.iterator(); i.hasNext();)
 		{
 			DBEntityColumn column = (DBEntityColumn) i.next();
 			if (column.isPrimaryKey())
 			    list.add(column);
 		}
 		return list;		
 
 	}
 	
 	/***
 	 * Returns a Lsit of BestRowIDentifiers for entity
 	 * This is as it has been returned from the metadata object of the driver
 	 * 
 	 * @return
 	 */
 	public List getBestRowIdentifierColumns()
 	{
 	    List list = new ArrayList();
 		for (Iterator i = columnsList.iterator(); i.hasNext();)
 		{
 			DBEntityColumn column = (DBEntityColumn) i.next();
 			if (column.isBestRowIdentifier())
 			    list.add(column);
 		}
 		return list;		
 
 	}
 
 	/***
 	 * Returns a Map of ForeignKeys for this column
 	 * 
 	 * @return
 	 */
 	public List getForeignKeyColumns()
 	{
 	    List list = new ArrayList();
 		for (Iterator i = columnsList.iterator(); i.hasNext();)
 		{
 			DBEntityColumn column = (DBEntityColumn) i.next();
 			if (column.isForeignKey())
 			    list.add(column);
 		}
 		return list;
 	}
 	
 	/***
      * This method will work out the best means of identifying a particular row in a table.
      * It will first try the getBestRowIdentifier() method
      * If that fails then it will look for primary keys
      * If that fails it will return all columns in a hope for the best sort of way
      * 
      * This is the BEST and RECOMMENDED way of obtaining a quique set of columns for your
      * application. 
      * 
      * Although you can use the other methods (e.g. getPrimaryKeyColumns() ) independantly
      * try not to as this will provide you a more unified behaviour throughout your application
      */
     public List getDerivedIdentityColumns()
     {
         List list = getBestRowIdentifierColumns();
         if (list.size() < 1)
         {
             list = getPrimaryKeyColumns();
             if (list.size() < 1)
             {
                list = getColumns();
                log.debug("Using all columns as choice for IdentityColumns.");
             }
             else
             {
                 log.debug("Using Primary Key Columns as choice for IdentityColumns.");
             }
         }
         else
         {
             log.debug("Using BestRowIdentifierColumns as choice for IdentityColumns.");
         }
        
         return list;
     }
 	
 }