package com.explosion.expfmodules.rdbmsconn.dbom;
   
   import java.io.Serializable;
   import java.util.HashMap;
   
   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.
   * 
   * =============================================================================
   */
  
  /***
   * A java object which represents a column as it is described by the database
   * MetaData object. It also supports the metadata supplied from the ResultSet
   * object.
   * 
   * You need to be aware that these two sets of data may be populated at
   * different times and so certain methods of this class may work dependant on
   * context.
   * 
   * The context dependant values are
   * 
   * boolean autoIncrement; boolean writable; boolean signed; boolean searchable;
   * boolean readOnly; boolean definitelyWritable; boolean currency; boolean
   * caseSensitive;
   * 
   * @author Stephen Cowx Description:
   *  
   */
  
  public class DBEntityColumn implements Serializable
  {
      private static Logger log = LogManager.getLogger(DBEntityColumn.class);
      private String columnName = null;
      private boolean isSorted = true;
      private int index = -1;
      private int size = 0;
      private String typeName = null;
      private int type;
      private Object defaultValue = null;
      private String remarks = null;
      private boolean primaryKey = false;
      private boolean foreignKey = false;
      private boolean nullable = false;
      private int bufferLength;
      private short decimalDigits;
      private boolean pseudoColumn = false;
      private boolean bestRowIdentifier = false;
      
      /* Some hopefully sensible defaults */
      private boolean autoIncrement = false;
      private boolean writable = true;
      private boolean signed = true;
      private boolean searchable = true;
      private boolean readOnly = false;
      private boolean definitelyWritable = true;
      private boolean currency = false;
      private boolean caseSensitive = false;
  
      /***
       * Returns the columns name
       * 
       * @return
       */
      public String getColumnName()
      {
          return columnName;
      }
  
      /***
       * Sets the columns Name
       * 
       * @param columnName
       */
      public void setColumnName(String columnName)
      {
          this.columnName = columnName;
      }
  
      /***
       * Returns the columns name as a string
       * 
      * @return
      */
     public String toString()
     {
         return this.getColumnName();
     }
 
     /***
      * @return Returns the defaultValue.
      */
     public Object getDefaultValue()
     {
         return defaultValue;
     }
 
     /***
      * @param defaultValue The defaultValue to set.
      */
     public void setDefaultValue(Object defaultValue)
     {
         this.defaultValue = defaultValue;
     }
 
     /***
      * @return Returns the foreignKey.
      */
     public boolean isForeignKey()
     {
         return foreignKey;
     }
 
     /***
      * @param foreignKey The foreignKey to set.
      */
     public void setForeignKey(boolean foreignKey)
     {
         this.foreignKey = foreignKey;
     }
 
     /***
      * @return Returns the columnIndex.
      */
     public int getIndex()
     {
         return index;
     }
 
     /***
      * @param index The index to set.
      */
     public void setIndex(int index)
     {
         this.index = index;
     }
 
     /***
      * @return Returns the isSorted.
      */
     public boolean isSorted()
     {
         return isSorted;
     }
 
     /***
      * @param isSorted The isSorted to set.
      */
     public void setSorted(boolean isSorted)
     {
         this.isSorted = isSorted;
     }
 
     /***
      * @return Returns the primaryKey.
      */
     public boolean isPrimaryKey()
     {
         return primaryKey;
     }
 
     /***
      * @param primaryKey The primaryKey to set.
      */
     public void setPrimaryKey(boolean primaryKey)
     {
         this.primaryKey = primaryKey;
     }
 
     /***
      * @return Returns the remarks.
      */
     public String getRemarks()
     {
         return remarks;
     }
 
     /***
      * @param remarks The remarks to set.
      */
     public void setRemarks(String remarks)
     {
         this.remarks = remarks;
     }
 
     /***
      * @return Returns the size.
      */
     public int getSize()
     {
         return size;
     }
 
     /***
      * @param size The size to set.
      */
     public void setSize(int size)
     {
         this.size = size;
     }
 
     /***
      * @return Returns the typeName.
      */
     public String getTypeName()
     {
         return typeName;
     }
 
     /***
      * @param typeName The typeName to set.
      */
     public void setTypeName(String typeName)
     {
         this.typeName = typeName;
     }
 
     /***
      * @return Returns the type.
      */
     public int getType()
     {
         return type;
     }
 
     /***
      * @param type The type to set.
      */
     public void setType(int type)
     {
         this.type = type;
     }
 
     /***
      * @return Returns the nullable.
      */
     public boolean isNullable()
     {
         return nullable;
     }
 
     /***
      * @param nullable The nullable to set.
      */
     public void setNullable(boolean nullable)
     {
         this.nullable = nullable;
     }
 
     /***
      * Indicates whether the designated column is automatically numbered, thus
      * read-only.
      */
     public boolean isAutoIncrement()
     {
         return autoIncrement;
     }
 
     /*** Indicates whether a column's case matters. */
     public boolean isCaseSensitive()
     {
         return caseSensitive;
     }
 
     /*** Indicates whether the designated column is a cash value. */
     public boolean isCurrency()
     {
         return currency;
     }
 
     /***
      * Indicates whether a write on the designated column will definitely
      * succeed.
      */
     public boolean isDefinitelyWritable()
     {
         return definitelyWritable;
     }
 
     /*** /** Indicates whether the designated column is definitely not writable. */
     public boolean isReadOnly()
     {
         return readOnly;
     }
 
     /*** Indicates whether the designated column can be used in a where clause. */
     public boolean isSearchable()
     {
         return searchable;
     }
 
     /*** Indicates whether values in the designated column are signed numbers. */
     public boolean isSigned()
     {
         return signed;
     }
 
     /***
      * Indicates whether it is possible for a write on the designated column to
      * succeed.
      */
     public boolean isWritable()
     {
         return writable;
     }
 
     /***
      * @param autoIncrement The autoIncrement to set.
      */
     public void setAutoIncrement(boolean autoIncrement)
     {
         this.autoIncrement = autoIncrement;
     }
 
     /***
      * @param caseSensitive The caseSensitive to set.
      */
     public void setCaseSensitive(boolean caseSensitive)
     {
         this.caseSensitive = caseSensitive;
     }
 
     /***
      * @param currency The currency to set.
      */
     public void setCurrency(boolean currency)
     {
         this.currency = currency;
     }
 
     /***
      * @param definitelyWritable The definitelyWritable to set.
      */
     public void setDefinitelyWritable(boolean definitelyWritable)
     {
         this.definitelyWritable = definitelyWritable;
     }
 
     /***
      * @param readOnly The readOnly to set.
      */
     public void setReadOnly(boolean readOnly)
     {
         this.readOnly = readOnly;
     }
 
     /***
      * @param searchable The searchable to set.
      */
     public void setSearchable(boolean searchable)
     {
         this.searchable = searchable;
     }
 
     /***
      * @param signed The signed to set.
      */
     public void setSigned(boolean signed)
     {
         this.signed = signed;
     }
 
     /***
      * @param writable The writable to set.
      */
     public void setWritable(boolean writable)
     {
         this.writable = writable;
     }
 
     /*
      * Indicates whether or not this column cann be sorted by using just the
      * ORDER BY clausew. It decides this based on the columns type
      */
     private static HashMap nonSortableTypes;
     
     public boolean isSortable()
     {
         if (nonSortableTypes == null)
         {
             nonSortableTypes = new HashMap();
             nonSortableTypes.put("java.sql.Types.STRUCT","");
             nonSortableTypes.put("java.sql.Types.ARRAY","");
         }
         
         log.debug(this.getTypeName() + "," + this.getType());
         
         if (nonSortableTypes.get(this.getTypeName()) != null)
             return false;
         else
             return true;
     }
 
     /***
      * @param bufferLength
      */
     public void setBufferLength(int bufferLength)
     {
         this.bufferLength = bufferLength;
     }
 
     /***
      * 
      * @return
      */
     public int getBufferLength()
     {
         return bufferLength;
     }    
     
     /***
      * @param decimalDigits
      */
     public void setDecimalDigits(short decimalDigits)
     {
         this.decimalDigits = decimalDigits; 
     }
 
 	/***
 	 * 
 	 * @return
 	 */
     public short getDecimalDigits()
     {
         return decimalDigits;
     }
     
     /***
      * @param pseudoColumn
      */
     public void setPseudoColumn(boolean pseudoColumn)
     {
         this.pseudoColumn = pseudoColumn;
     }
     
     /***
      * 
      * @return
      */
     public boolean isPseudoColumn()
     {
         return pseudoColumn;
     }
 
     /***
      * Returns true if the database metadata indicates that this is a best row identifier
      * @return
      */
     public boolean isBestRowIdentifier()
     {
         return bestRowIdentifier;
     }
     
     /***
      * Set to true to indicate that this column is a bestRowIdentifier column
      * @return
      */
     public void setBestRowIdentifier(boolean bestRowIdentifier)
     {
         this.bestRowIdentifier = bestRowIdentifier;
     }
 }