/*
    * DynamicJasper: A library for creating reports dynamically by specifying
    * columns, groups, styles, etc. at runtime. It also saves a lot of development
    * time in many cases! (http://sourceforge.net/projects/dynamicjasper)
    *
    * Copyright (C) 2008  FDV Solutions (http://www.fdvsolutions.com)
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
   *
   * License as published by the Free Software Foundation; either
   *
   * version 2.1 of the License, or (at your option) any later version.
   *
   * This library 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
   *
   * Lesser General Public License for more details.
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   *
   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
   *
   *
   */
  
  package ar.com.fdvs.dj.domain.entities.columns;
  
  import ar.com.fdvs.dj.domain.DJBaseElement;
  import ar.com.fdvs.dj.domain.DJCalculation;
  import ar.com.fdvs.dj.domain.DJHyperLink;
  import ar.com.fdvs.dj.domain.Style;
  import ar.com.fdvs.dj.domain.entities.DJColSpan;
  import ar.com.fdvs.dj.domain.entities.Entity;
  
  import java.text.Format;
  import java.util.ArrayList;
  import java.util.List;
  
  /**
   * Abstract Class used as base for the different Column types.
   */
  public abstract class AbstractColumn extends DJBaseElement {
  
  	private static final long serialVersionUID = Entity.SERIAL_VERSION_UID;
  
      /**
       * Internal column name.
       * used to generate expression names related to this column (variables, custom expression, etc)
       * Its name is given in the ColumnRegistrationManager
       */
  	private String name;
  
      /**
       * For internal use only. will be initialized with the report name and subclasses can benefit
       * from it to create expression which needs the report prefix
       */
      private String reportName;
  
  	private String title;
  	private Integer posX = new Integer(0);
  	private Integer posY = new Integer(0);
  	private Integer width = new Integer(100);
  	private Boolean fixedWidth = Boolean.FALSE;
  	private Style style = new Style();
  	private Style headerStyle = null;
  	private String pattern;
  	private Boolean printRepeatedValues = Boolean.TRUE;
  	private Boolean blankWhenNull = Boolean.TRUE;
  	private String truncateSuffix = null;
  	private Format textFormatter;
  
      /**
       * Markup to use in the column data (html, styled, etc)
       */
      private String markup;
  
      /**
       * Markup to use in the column header (html, styled, etc)
       */
      private String headerMarkup;
  
      private DJHyperLink link;
  	
  	private List conditionalStyles = new ArrayList();
  
      private DJColSpan colSpan;
  
  	public List getConditionalStyles() {
  		return conditionalStyles;
  	}
  
  	public void setConditionalStyles(List conditionalStyles) {
  		this.conditionalStyles = conditionalStyles;
  	}
  
 	public String getTitle() {
 		return title;
 	}
 
 	public void setTitle(String label) {
 		this.title = label;
 	}
 
 	public Integer getPosX() {
 		return posX;
 	}
 
 	public void setPosX(Integer posX) {
 		this.posX = posX;
 	}
 
 	public Integer getPosY() {
 		return posY;
 	}
 
 	public void setPosY(Integer posY) {
 		this.posY = posY;
 	}
 
 	public Style getHeaderStyle() {
 		return headerStyle;
 	}
 
 	public void setHeaderStyle(Style headerStyle) {
 		this.headerStyle = headerStyle;
 	}
 
 	public Style getStyle() {
 		return style;
 	}
 
 	public void setStyle(Style style) {
 		this.style = style;
 	}
 
 	public Integer getWidth() {
 		return width;
 	}
 
 	public void setWidth(Integer width) {
 		this.width = width;
 	}
 
 	public String getPattern() {
 		return pattern;
 	}
 
 	public void setPattern(String pattern) {
 		this.pattern = pattern;
 	}
 
 	public Boolean getPrintRepeatedValues() {
 		return printRepeatedValues;
 	}
 
 	public void setPrintRepeatedValues(Boolean printRepeatedValues) {
 		this.printRepeatedValues = printRepeatedValues;
 	}
 
 	public abstract String getTextForExpression();
 
 	public abstract String getValueClassNameForExpression();
 
 	/**
 	 * 
 	 * @param type "FOOTER" or "HEADER"
 	 * @param columnToGroupByProperty
 	 * @return The name of group of variables
 	 */
 	public abstract String getGroupVariableName(String type, String columnToGroupByProperty);
 
 	public abstract String getVariableClassName(DJCalculation op);
 
 	public abstract String getInitialExpression(DJCalculation op);
 
 	public String getName() {
 		return name;
 	}
 
 	public void setName(String name) {
 		this.name = name;
 	}
 
 	public Boolean getBlankWhenNull() {
 		return blankWhenNull;
 	}
 
 	public void setBlankWhenNull(Boolean blankWhenNull) {
 		this.blankWhenNull = blankWhenNull;
 	}
 
 	public Boolean getFixedWidth() {
 		return fixedWidth;
 	}
 
 	public void setFixedWidth(Boolean fixedWidth) {
 		this.fixedWidth = fixedWidth;
 	}
 
 	public String getTruncateSuffix() {
 		return truncateSuffix;
 	}
 
 	public void setTruncateSuffix(String truncateSuffix) {
 		this.truncateSuffix = truncateSuffix;
 	}
 
 	public Format getTextFormatter() {
 		return textFormatter;
 	}
 
 	public void setTextFormatter(Format textFormatter) {
 		this.textFormatter = textFormatter;
 	}
 
 	public DJHyperLink getLink() {
 		return link;
 	}
 
 	public void setLink(DJHyperLink link) {
 		this.link = link;
 	}
 
     public DJColSpan getColSpan() {
         return colSpan;
     }
 
     public void setColSpan(DJColSpan colSpan) {
         this.colSpan = colSpan;
     }
 
     public boolean hasParentCol() {
         return colSpan != null;
     }
 
     public String getReportName() {
         return reportName;
     }
 
     public void setReportName(String reportName) {
         this.reportName = reportName;
     }
 
     public String getMarkup() {
         return markup;
     }
 
     public void setMarkup(String markup) {
         this.markup = markup;
     }
 
     public String getHeaderMarkup() {
         return headerMarkup;
     }
 
     public void setHeaderMarkup(String headerMarkup) {
         this.headerMarkup = headerMarkup;
     }
 }