org.eclipse.birt.data.engine.api.timefunction
Class TimePeriod

java.lang.Object
  extended by org.eclipse.birt.data.engine.api.timefunction.TimePeriod
All Implemented Interfaces:
ITimePeriod

public class TimePeriod
extends java.lang.Object
implements ITimePeriod


Field Summary
 int countOfUnit
           
 boolean isCurrent
           
 TimePeriodType type
           
 
Constructor Summary
TimePeriod(int countOfUnit, TimePeriodType type)
           
TimePeriod(int countOfUnit, TimePeriodType type, boolean isCurrent)
           
 
Method Summary
 int countOfUnit()
          Represent the number of time period, say, the "N" in "last N Year".
 TimePeriodType getType()
          Represent the basic unit of a time period.
 boolean isCurrent()
          Represent whether it should be calculated in the scope of a current period
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

countOfUnit

public int countOfUnit

type

public TimePeriodType type

isCurrent

public boolean isCurrent
Constructor Detail

TimePeriod

public TimePeriod(int countOfUnit,
                  TimePeriodType type)

TimePeriod

public TimePeriod(int countOfUnit,
                  TimePeriodType type,
                  boolean isCurrent)
Method Detail

countOfUnit

public int countOfUnit()
Description copied from interface: ITimePeriod
Represent the number of time period, say, the "N" in "last N Year".

Specified by:
countOfUnit in interface ITimePeriod
Returns:

getType

public TimePeriodType getType()
Description copied from interface: ITimePeriod
Represent the basic unit of a time period.

Specified by:
getType in interface ITimePeriod
Returns:

isCurrent

public boolean isCurrent()
Description copied from interface: ITimePeriod
Represent whether it should be calculated in the scope of a current period

Specified by:
isCurrent in interface ITimePeriod
Returns:


Copyright © 2008 Actuate Corp. All rights reserved.