/* ===========================================================
 
* JFreeChart : a free chart library for the Java(tm) platform
 
* ===========================================================
 
*
 
* (C) Copyright 2000-2016, by Object Refinery Limited and Contributors.
 
*
 
* Project Info:
  
http://www.jfree.org/jfreechart/index.html
 
*
 
* 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.
 
*
 
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 
* Other names may be trademarks of their respective owners.]
 
*
 
* ---------------------------------------
 
* IntervalCategoryItemLabelGenerator.java
 
* ---------------------------------------
 
* (C) Copyright 2004-2008, by Object Refinery Limited.
 
*
 
* Original Author:
  
David Gilbert (for Object Refinery Limited);
 
* Contributor(s):
   
-;
 
*
 
* Changes
 
* -------
 
* 11-May-2004 : Version 1, split from IntervalCategoryItemLabelGenerator (DG);
 
*
 
*/

package org.jfree.chart.labels;

import java.io.Serializable;
import java.text.DateFormat;
import java.text.NumberFormat;
import org.jfree.chart.util.PublicCloneable;

import org.jfree.data.category.CategoryDataset;
import org.jfree.data.category.IntervalCategoryDataset;

/**
 
* A label generator for plots that use data from an
 
* {@link IntervalCategoryDataset}.
 
*/

public class IntervalCategoryItemLabelGenerator
    
extends StandardCategoryItemLabelGenerator
    
implements CategoryItemLabelGenerator, PublicCloneable, Cloneable,
               
Serializable {

    
/** For serialization. */
    
private static final long serialVersionUID = 5056909225610630529L;

    
/** The default format string. */
    
public static final String DEFAULT_LABEL_FORMAT_STRING
        
= "({0}, {1}) = {3} - {4}";

    
/**
     
* Creates a new generator with a default number formatter.
     
*/

    
public IntervalCategoryItemLabelGenerator() {
        
super(DEFAULT_LABEL_FORMAT_STRING, NumberFormat.getInstance());
    
}

    
/**
     
* Creates a new generator with the specified number formatter.
     
*
     
* @param labelFormat
  
the label format string ({@code null} not
     
*
                     
permitted).
     
* @param formatter
  
the number formatter ({@code null} not permitted).
     
*/

    
public IntervalCategoryItemLabelGenerator(String labelFormat,
                                              
NumberFormat formatter) {
        
super(labelFormat, formatter);
    
}

    
/**
     
* Creates a new generator with the specified date formatter.
     
*
     
* @param labelFormat
  
the label format string ({@code null} not
     
*
                     
permitted).
     
* @param formatter
  
the date formatter ({@code null} not permitted).
     
*/

    
public IntervalCategoryItemLabelGenerator(String labelFormat,
                                              
DateFormat formatter) {
        
super(labelFormat, formatter);
    
}

    
/**
     
* Creates the array of items that can be passed to the
     
* {@code MessageFormat} class for creating labels.
     
*
     
* @param dataset
  
the dataset ({@code null} not permitted).
     
* @param row
  
the row index (zero-based).
     
* @param column
  
the column index (zero-based).
     
*
     
* @return The items (never {@code null}).
     
*/

    
@Override
    
protected Object[] createItemArray(CategoryDataset dataset,
                                       
int row, int column) {
        
Object[] result = new Object[5];
        
result[0] = dataset.getRowKey(row).toString();
        
result[1] = dataset.getColumnKey(column).toString();
        
Number value = dataset.getValue(row, column);
        
if (getNumberFormat() != null) {
            
result[2] = getNumberFormat().format(value);
        
}
        
else if (getDateFormat() != null) {
            
result[2] = getDateFormat().format(value);
        
}

        
if (dataset instanceof IntervalCategoryDataset) {
            
IntervalCategoryDataset icd = (IntervalCategoryDataset) dataset;
            
Number start = icd.getStartValue(row, column);
            
Number end = icd.getEndValue(row, column);
            
if (getNumberFormat() != null) {
                
result[3] = getNumberFormat().format(start);
                
result[4] = getNumberFormat().format(end);
            
}
            
else if (getDateFormat() != null) {
                
result[3] = getDateFormat().format(start);
                
result[4] = getDateFormat().format(end);
            
}
        
}
        
return result;
    
}

}