com.gooddata.executeafm.afm

Interface MeasureDefinition

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArithmeticMeasureDefinition, DerivedMeasureDefinition, OverPeriodMeasureDefinition, PopMeasureDefinition, PreviousPeriodMeasureDefinition, SimpleMeasureDefinition, VOPopMeasureDefinition, VOSimpleMeasureDefinition

public interface MeasureDefinition
extends Serializable

Method Summary

Modifier and Type	Method and Description
ObjQualifier	getObjQualifier() Deprecated. Use withObjUriQualifiers(ObjQualifierConverter) instead as this method is not supported by all the existing implementations.
Collection<ObjQualifier>	getObjQualifiers() Returns all the qualifiers used by the measure definition and its encapsulated objects.
default String	getUri() Returns the definition in the form of uri of Metric.
boolean	isAdHoc()
MeasureDefinition	withObjUriQualifier(UriObjQualifier qualifier) Deprecated. Use withObjUriQualifiers(ObjQualifierConverter) instead as this method is not supported by all the existing implementations.
MeasureDefinition	withObjUriQualifiers(ObjQualifierConverter objQualifierConverter) Copy itself using the given object qualifier converter in case when IdentifierObjQualifier instances are used in the object otherwise the original object is returned.

Method Detail

getUri

default String getUri()

Returns the definition in the form of uri of Metric. Default implementation throws UnsupportedOperationException

Returns:

uri of the measure

getObjQualifier

@Deprecated
ObjQualifier getObjQualifier()

Deprecated. Use withObjUriQualifiers(ObjQualifierConverter) instead as this method is not supported by all the existing implementations.

Returns the qualifier, qualifying the Metric.

Returns:

qualifier of measure

Throws:

UnsupportedOperationException - The exception is thrown when the method is not supported by the implementation.

getObjQualifiers

Collection<ObjQualifier> getObjQualifiers()

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
MeasureDefinition withObjUriQualifier(UriObjQualifier qualifier)

Deprecated. Use withObjUriQualifiers(ObjQualifierConverter) instead as this method is not supported by all the existing implementations.

Copy itself using given URI qualifier.

Parameters:

qualifier - The qualifier to use by the new object.

Returns:

self copy with given qualifier

Throws:

UnsupportedOperationException - The exception is thrown when the method is not supported by the implementation.

withObjUriQualifiers

MeasureDefinition withObjUriQualifiers(ObjQualifierConverter objQualifierConverter)

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.

Throws:

IllegalArgumentException - The exception is thrown when conversion for the identifier qualifier used by this measure definition could not be made by the provided converter or when provided converter is null.

isAdHoc

boolean isAdHoc()

Returns:

true if this definition represents ad hoc specified measure, false otherwise