com.jidesoft.scale
Class DefaultPeriodConverter<T>

java.lang.Object
  com.jidesoft.scale.AbstractPeriodConverter<T>
      com.jidesoft.scale.DefaultPeriodConverter<T>

Type Parameters:

T - The base unit of the ScaleModel to render the periods for.

All Implemented Interfaces:

PeriodConverter<T>, Serializable

public class DefaultPeriodConverter<T>
extends AbstractPeriodConverter<T>

DefaultPeriodConverter is a default implementation of PeriodConverter.

See Also:

Serialized Form

Constructor Summary

DefaultPeriodConverter()

DefaultPeriodConverter(String periodName)

Method Summary

String	getDescription(T startInstant, T endInstant) Gets the long text representing the period.
String	getText(T startInstant, T endInstant) Gets the short text representing the period.

Methods inherited from class com.jidesoft.scale.AbstractPeriodConverter

getDisplayName, getPrototypeDisplayValue, setPrototypeDisplayValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPeriodConverter

public DefaultPeriodConverter()

DefaultPeriodConverter

public DefaultPeriodConverter(String periodName)

Method Detail

getText

public String getText(T startInstant,
                      T endInstant)

Description copied from interface: PeriodConverter

Gets the short text representing the period. It can be used as the scale area header text.

Parameters:

startInstant - the start instance of the period

endInstant - the end instance of the period

Returns:

the short text representing the period.

getDescription

public String getDescription(T startInstant,
                             T endInstant)

Description copied from interface: PeriodConverter

Gets the long text representing the period. It can be used as the scale area header tooltip.

Parameters:

startInstant - the start instance of the period

endInstant - the end instance of the period

Returns:

the long text representing the period.