com.gooddata.executeafm.afm

Class PopMeasureDefinition

java.lang.Object

com.gooddata.executeafm.afm.PopMeasureDefinition

All Implemented Interfaces:

MeasureDefinition, Serializable

Direct Known Subclasses:

VOPopMeasureDefinition

public class PopMeasureDefinition
extends Object
implements MeasureDefinition, Serializable

Definition of so called "period over period" measure

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PopMeasureDefinition(String measureIdentifier, ObjQualifier popAttribute) Creates new definition from given measure identifier referencing another measure in Afm and given attribute qualifier (should qualify date attribute)
PopMeasureDefinition(String measureIdentifier, ObjQualifier popAttribute, Integer offset) Creates new definition from given measure identifier referencing another measure in Afm and given attribute qualifier (should qualify date attribute)

Method Summary

Modifier and Type	Method and Description
String	getMeasureIdentifier()
ObjQualifier	getObjQualifier() Returns the qualifier, qualifying the Metric.
Integer	getOffset() Returns number of periods defined via popAttribute time interval.
ObjQualifier	getPopAttribute()
boolean	isAdHoc()
String	toString()
MeasureDefinition	withObjUriQualifier(UriObjQualifier qualifier) Copy itself using given uri qualifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gooddata.executeafm.afm.MeasureDefinition

getUri

Constructor Detail

PopMeasureDefinition

public PopMeasureDefinition(String measureIdentifier,
                            ObjQualifier popAttribute,
                            Integer offset)

Creates new definition from given measure identifier referencing another measure in Afm and given attribute qualifier (should qualify date attribute)

Parameters:

measureIdentifier - measure identifier

popAttribute - "period over period" date attribute

offset - the number of periods the time window defined by popAttribute is offset about to the past (when value is negative) or future (when value is positive)

PopMeasureDefinition

public PopMeasureDefinition(String measureIdentifier,
                            ObjQualifier popAttribute)

Creates new definition from given measure identifier referencing another measure in Afm and given attribute qualifier (should qualify date attribute)

Parameters:

measureIdentifier - measure identifier

popAttribute - "period over period" date attribute

Method Detail

withObjUriQualifier

public MeasureDefinition withObjUriQualifier(UriObjQualifier qualifier)

Description copied from interface: MeasureDefinition

Copy itself using given uri qualifier

Specified by:

withObjUriQualifier in interface MeasureDefinition

Parameters:

qualifier - qualifier to use for the new filter

Returns:

self copy with given qualifier

isAdHoc

public boolean isAdHoc()

Specified by:

isAdHoc in interface MeasureDefinition

Returns:

always true (PopMeasure is always ad-hoc)

getMeasureIdentifier

public String getMeasureIdentifier()

getPopAttribute

public ObjQualifier getPopAttribute()

getOffset

public Integer getOffset()

Returns number of periods defined via popAttribute time interval.

Returns:

positive or negative number of periods or null when offset was not defined

getObjQualifier

public ObjQualifier getObjQualifier()

Description copied from interface: MeasureDefinition

Returns the qualifier, qualifying the Metric.

Specified by:

getObjQualifier in interface MeasureDefinition

Returns:

qualifier of measure

toString

public String toString()

Overrides:

toString in class Object