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

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

public class TimeFunction
extends java.lang.Object
implements ITimeFunction


Constructor Summary
TimeFunction()
           
 
Method Summary
 ITimePeriod getBaseTimePeriod()
          Get the type of time function.
 IReferenceDate getReferenceDate()
          Get the reference date of a time function.
 ITimePeriod getRelativeTimePeriod()
          Get the relative time period of a time function.
 java.lang.String getTimeDimension()
          Get the time dimension based on which the time function will be calculated against.
 void setBaseTimePeriod(ITimePeriod timePeriod)
          Set the type of time function.
 void setReferenceDate(IReferenceDate referenceDate)
          Set the reference date of a time function.
 void setRelativeTimePeriod(ITimePeriod relativeTimePeriod)
          Set the relative time period of a time function.
 void setTimeDimension(java.lang.String timeDimension)
          Set the reference date of a time function.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TimeFunction

public TimeFunction()
Method Detail

setBaseTimePeriod

public void setBaseTimePeriod(ITimePeriod timePeriod)
                       throws org.eclipse.birt.data.engine.core.DataException
Description copied from interface: ITimeFunction
Set the type of time function.

Specified by:
setBaseTimePeriod in interface ITimeFunction
Throws:
org.eclipse.birt.data.engine.core.DataException

getBaseTimePeriod

public ITimePeriod getBaseTimePeriod()
                              throws org.eclipse.birt.data.engine.core.DataException
Description copied from interface: ITimeFunction
Get the type of time function.

Specified by:
getBaseTimePeriod in interface ITimeFunction
Throws:
org.eclipse.birt.data.engine.core.DataException

setTimeDimension

public void setTimeDimension(java.lang.String timeDimension)
                      throws org.eclipse.birt.data.engine.core.DataException
Description copied from interface: ITimeFunction
Set the reference date of a time function.

Specified by:
setTimeDimension in interface ITimeFunction
Throws:
org.eclipse.birt.data.engine.core.DataException

getTimeDimension

public java.lang.String getTimeDimension()
                                  throws org.eclipse.birt.data.engine.core.DataException
Description copied from interface: ITimeFunction
Get the time dimension based on which the time function will be calculated against.

Specified by:
getTimeDimension in interface ITimeFunction
Returns:
Throws:
org.eclipse.birt.data.engine.core.DataException

setReferenceDate

public void setReferenceDate(IReferenceDate referenceDate)
                      throws org.eclipse.birt.data.engine.core.DataException
Description copied from interface: ITimeFunction
Set the reference date of a time function.

Specified by:
setReferenceDate in interface ITimeFunction
Throws:
org.eclipse.birt.data.engine.core.DataException

getReferenceDate

public IReferenceDate getReferenceDate()
                                throws org.eclipse.birt.data.engine.core.DataException
Description copied from interface: ITimeFunction
Get the reference date of a time function.

Specified by:
getReferenceDate in interface ITimeFunction
Returns:
Throws:
org.eclipse.birt.data.engine.core.DataException

setRelativeTimePeriod

public void setRelativeTimePeriod(ITimePeriod relativeTimePeriod)
                           throws org.eclipse.birt.data.engine.core.DataException
Description copied from interface: ITimeFunction
Set the relative time period of a time function.

Specified by:
setRelativeTimePeriod in interface ITimeFunction
Throws:
org.eclipse.birt.data.engine.core.DataException

getRelativeTimePeriod

public ITimePeriod getRelativeTimePeriod()
                                  throws org.eclipse.birt.data.engine.core.DataException
Description copied from interface: ITimeFunction
Get the relative time period of a time function.

Specified by:
getRelativeTimePeriod in interface ITimeFunction
Returns:
Throws:
org.eclipse.birt.data.engine.core.DataException


Copyright © 2008 Actuate Corp. All rights reserved.