/* ===========================================================
 
* 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.]
 
*
 
* ------------------------
 
* CategoryLabelEntity.java
 
* ------------------------
 
* (C) Copyright 2006-2011, by Object Refinery Limited and Contributors.
 
*
 
* Original Author:
  
David Gilbert (for Object Refinery Limited);
 
* Contributor(s):
   
-;
 
*
 
* Changes:
 
* --------
 
* 02-Oct-2006 : Version 1 (DG);
 
* 13-Nov-2007 : Added equals() and hashCode() methods (DG);
 
*
 
*/

package org.jfree.chart.entity;

import java.awt.Shape;

import org.jfree.chart.HashUtils;
import org.jfree.chart.axis.CategoryAxis;
import org.jfree.chart.util.ObjectUtils;

/**
 
* An entity to represent the labels on a {@link CategoryAxis}.
 
*
 
* @since 1.0.3
 
*/

public class CategoryLabelEntity extends TickLabelEntity {

    
/** The category key. */
    
private Comparable key;

    
/**
     
* Creates a new entity.
     
*
     
* @param key
  
the category key.
     
* @param area
  
the hotspot.
     
* @param toolTipText
  
the tool tip text.
     
* @param urlText
  
the URL text.
     
*/

    
public CategoryLabelEntity(Comparable key, Shape area,
            
String toolTipText, String urlText) {
        
super(area, toolTipText, urlText);
        
this.key = key;
    
}

    
/**
     
* Returns the category key.
     
*
     
* @return The category key.
     
*/
    
public Comparable getKey() {
        
return this.key;
    
}

    
/**
     
* Tests this instance for equality with an arbitrary object.
     
*
     
* @param obj
  
the object ({@code null} permitted).
     
*
     
* @return A boolean.
     
*/

    
@Override
    
public boolean equals(Object obj) {
        
if (obj == this) {
            
return true;
        
}
        
if (!(obj instanceof CategoryLabelEntity)) {
            
return false;
        
}
        
CategoryLabelEntity that = (CategoryLabelEntity) obj;
        
if (!ObjectUtils.equal(this.key, that.key)) {
            
return false;
        
}
        
return super.equals(obj);
    
}

    
/**
     
* Returns a hash code for this instance.
     
*
     
* @return A hash code.
     
*/
    
@Override
    
public int hashCode() {
        
int result = super.hashCode();
        
result = HashUtils.hashCode(result, this.key);
        
return result;
    
}

    
/**
     
* Returns a string representation of this entity.
  
This is primarily
     
* useful for debugging.
     
*
     
* @return A string representation of this entity.
     
*/

    
@Override
    
public String toString() {
        
StringBuilder sb = new StringBuilder("CategoryLabelEntity: ");
        
sb.append("category=");
        
sb.append(this.key);
        
sb.append(", tooltip=").append(getToolTipText());
        
sb.append(", url=").append(getURLText());
        
return sb.toString();
    
}
}