Package com.gooddata.executeafm.afm

Class PreviousPeriodDateDataSet

java.lang.Object

com.gooddata.executeafm.afm.PreviousPeriodDateDataSet

All Implemented Interfaces:

Serializable

public class PreviousPeriodDateDataSet
extends Object
implements Serializable

Definition of the PreviousPeriodMeasureDefinition data set.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PreviousPeriodDateDataSet(ObjQualifier dataSet, Integer periodsAgo)	Create a new instance of PreviousPeriodDateDataSet.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ObjQualifier	getDataSet()	The ObjQualifier of the data set that match one of the DateFilter in the execution.
Integer	getPeriodsAgo()	The number of periods defined by the matching date filter which this period will be shifted about.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PreviousPeriodDateDataSet

public PreviousPeriodDateDataSet(ObjQualifier dataSet,
                                 Integer periodsAgo)

Create a new instance of PreviousPeriodDateDataSet.

Parameters:

dataSet - The ObjQualifier of the data set that match one of the DateFilter in the execution. The parameter must not be null.

periodsAgo - The number of periods defined by the matching date filter which this period will be shifted about. The positive number shifts the period to the past, the negative to the future. The parameter must not be null.

Throws:

IllegalArgumentException - Thrown when one of the required parameter is null.

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getDataSet

public ObjQualifier getDataSet()

The ObjQualifier of the data set that match one of the DateFilter in the execution.

Returns:

The data set for matching of the AFM filter.

getPeriodsAgo

public Integer getPeriodsAgo()

The number of periods defined by the matching date filter which this period will be shifted about. The positive number shifts the period to the past, the negative to the future.

Returns:

The number of periods the data will be shifted about.