com.gooddata.executeafm.afm

Class OverPeriodDateAttribute

java.lang.Object

com.gooddata.executeafm.afm.OverPeriodDateAttribute

All Implemented Interfaces:

Serializable

public class OverPeriodDateAttribute
extends Object
implements Serializable

Definition of the OverPeriodMeasureDefinition attribute.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OverPeriodDateAttribute(ObjQualifier attribute, Integer periodsAgo) Create a new instance of OverPeriodDateAttribute.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ObjQualifier	getAttribute() The ObjQualifier of the attribute from the date data set that defines the PoP period.
Integer	getPeriodsAgo() The number of periods defined by the attribute about 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

OverPeriodDateAttribute

public OverPeriodDateAttribute(ObjQualifier attribute,
                               Integer periodsAgo)

Create a new instance of OverPeriodDateAttribute.

Parameters:

attribute - The ObjQualifier of the attribute from the date data set that defines the PoP period and date data set. The parameter must not be null.

periodsAgo - The number of periods defined by the attribute about 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

getAttribute

public ObjQualifier getAttribute()

The ObjQualifier of the attribute from the date data set that defines the PoP period.

Returns:

The date data set attribute that defines the PoP attribute.

getPeriodsAgo

public Integer getPeriodsAgo()

The number of periods defined by the attribute about 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.