com.endeca.navigation.charting
Class Label

java.lang.Object
  extended by com.endeca.navigation.charting.Label

public class Label
extends Object

This class represents a Grid label that came from either a dimension value or a property value. Calling toString will return the label's text, suitable for presenting as a label on an axis of a chart or table. If this is a dimension value, then calling getDimVal will return the dimension value, which may be useful for navigation.


Method Summary
 boolean equals(Object obj)
          Indicates whether this Label has an equivalence to a reference Label specified by obj.
 DimVal getDimVal()
          Returns the dimension value if this is a dimension.
 String getProperty()
          Returns the property value if this is a property.
 int hashCode()
          Returns a unique hash code value of this Label.
 String toString()
          Returns the property value if this is a property.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

toString

public String toString()
Returns the property value if this is a property. Otherwise returns the name of the dimension value.

Overrides:
toString in class Object
Returns:
The property value or the name of the dimension value.

getDimVal

public DimVal getDimVal()
Returns the dimension value if this is a dimension. Otherwise returns null.

Returns:
The dimension value (a DimVal object).

getProperty

public String getProperty()
Returns the property value if this is a property. Otherwise returns null.

Returns:
The property value.

equals

public boolean equals(Object obj)
Indicates whether this Label has an equivalence to a reference Label specified by obj.

Overrides:
equals in class Object
Parameters:
obj - the reference Label with which to compare.
Returns:
true if this Label is the same as the obj argument; false otherwise.

hashCode

public int hashCode()
Returns a unique hash code value of this Label.

Overrides:
hashCode in class Object
Returns:
The hash code value.


2010 Endeca Technologies, Inc.
Endeca Confidential