com.gooddata.executeafm.afm

Class PopMeasureDefinition

java.lang.Object

com.gooddata.executeafm.afm.DerivedMeasureDefinition

com.gooddata.executeafm.afm.PopMeasureDefinition

All Implemented Interfaces:

MeasureDefinition, Serializable

Direct Known Subclasses:

VOPopMeasureDefinition

Deprecated.

@Deprecated
public class PopMeasureDefinition
extends DerivedMeasureDefinition

Definition of so called "period over period" measure.

The definition is deprecated. Use OverPeriodMeasureDefinition with OverPeriodDateAttribute.getPeriodsAgo() set to 1 instead.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.gooddata.executeafm.afm.DerivedMeasureDefinition

measureIdentifier

Constructor Summary

Constructors

Constructor and Description
PopMeasureDefinition(String measureIdentifier, ObjQualifier popAttribute) Deprecated. 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
boolean	equals(Object o) Deprecated.
ObjQualifier	getObjQualifier() Deprecated. Use getObjQualifiers() instead.
Collection<ObjQualifier>	getObjQualifiers() Deprecated. Returns all the qualifiers used by the measure definition and its encapsulated objects.
ObjQualifier	getPopAttribute() Deprecated.
int	hashCode() Deprecated.
boolean	isAdHoc() Deprecated. Determine if measure is ad-hoc
String	toString() Deprecated.
MeasureDefinition	withObjUriQualifier(UriObjQualifier uriQualifier) Deprecated. Use withObjUriQualifiers(ObjQualifierConverter) instead.
MeasureDefinition	withObjUriQualifiers(ObjQualifierConverter objQualifierConverter) Deprecated. Copy itself using the given object qualifier converter in case when IdentifierObjQualifier instances are used in the object otherwise the original object is returned.

Methods inherited from class com.gooddata.executeafm.afm.DerivedMeasureDefinition

getMeasureIdentifier

Methods inherited from class java.lang.Object

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

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

getUri

Constructor Detail

PopMeasureDefinition

public PopMeasureDefinition(String measureIdentifier,
                            ObjQualifier popAttribute)

Deprecated.

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

withObjUriQualifiers

public MeasureDefinition withObjUriQualifiers(ObjQualifierConverter objQualifierConverter)

Deprecated.

Description copied from interface: MeasureDefinition

Copy itself using the given object qualifier converter in case when IdentifierObjQualifier instances are used in the object otherwise the original object is returned.

The provided converter must be able to handle the conversion for the qualifiers that are of the IdentifierObjQualifier type that are used by this object or its encapsulated child objects.

Parameters:

objQualifierConverter - The function that converts identifier qualifiers to the matching URI qualifiers. In case when the object uses the identifier qualifiers, it will return a new copy of itself or its encapsulated objects that used URI qualifiers, otherwise the original object is returned. The parameter must not be null.

Returns:

copy of itself with replaced qualifiers in case when some IdentifierObjQualifier were used, otherwise original object is returned.

isAdHoc

public boolean isAdHoc()

Deprecated.

Determine if measure is ad-hoc

Returns:

always true (PopMeasure is always ad-hoc)

getPopAttribute

public ObjQualifier getPopAttribute()

Deprecated.

getObjQualifier

@Deprecated
public ObjQualifier getObjQualifier()

Deprecated. Use getObjQualifiers() instead.

Returns the qualifier used by the Metric.

Returns:

qualifier used by the metric, which is its popAttribute. The null is returned in case when popAttribute was not set.

getObjQualifiers

public Collection<ObjQualifier> getObjQualifiers()

Deprecated.

Description copied from interface: MeasureDefinition

Returns all the qualifiers used by the measure definition and its encapsulated objects.

This information comes handy if it is necessary, for example, to convert the measure definition to use just the URI object qualifiers instead of the identifier object qualifiers. It can be used to gather these for a conversion service.

Returns:

all the qualifiers the measure definition uses, even in its encapsulated objects (apart from the measure filters)

withObjUriQualifier

@Deprecated
public MeasureDefinition withObjUriQualifier(UriObjQualifier uriQualifier)

Deprecated. Use withObjUriQualifiers(ObjQualifierConverter) instead.

Copy itself using given URI qualifier.

Parameters:

uriQualifier - The qualifier to use by the new object instead of the currently used one.

Returns:

self copy with given qualifier

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class DerivedMeasureDefinition

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class DerivedMeasureDefinition

toString

public String toString()

Deprecated.

Overrides:

toString in class Object