com.gooddata.executeafm.afm

Class SimpleMeasureDefinition

java.lang.Object

com.gooddata.executeafm.afm.SimpleMeasureDefinition

All Implemented Interfaces:

MeasureDefinition, Serializable

Direct Known Subclasses:

VOSimpleMeasureDefinition

public class SimpleMeasureDefinition
extends Object
implements MeasureDefinition

Definition of simple measure

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleMeasureDefinition(ObjQualifier item)
SimpleMeasureDefinition(ObjQualifier item, Aggregation aggregation, Boolean computeRatio, FilterItem... filters) Creates new definition
SimpleMeasureDefinition(ObjQualifier item, Aggregation aggregation, Boolean computeRatio, List<FilterItem> filters) Creates new definition
SimpleMeasureDefinition(ObjQualifier item, String aggregation, Boolean computeRatio, List<FilterItem> filters) Creates new definition

Method Summary

Modifier and Type	Method and Description
void	addFilter(FilterItem filter) Apply additional filter
boolean	equals(Object o)
String	getAggregation()
Boolean	getComputeRatio()
List<FilterItem>	getFilters()
ObjQualifier	getItem()
ObjQualifier	getObjQualifier() Deprecated. Use getObjQualifiers() instead.
Collection<ObjQualifier>	getObjQualifiers() Returns all the qualifiers used by the measure definition and its encapsulated objects.
String	getUri() Returns the definition in the form of uri of Metric.
boolean	hasAggregation()
boolean	hasComputeRatio()
boolean	hasFilters()
int	hashCode()
boolean	isAdHoc()
void	setAggregation(Aggregation aggregation) Set additional aggregation applied
void	setAggregation(String aggregation) Set additional aggregation applied
void	setComputeRatio(Boolean computeRatio) Set whether should be shown as ratio
void	setFilters(List<FilterItem> filters) Set additional filters applied
String	toString()
MeasureDefinition	withObjUriQualifier(UriObjQualifier uriQualifier) Deprecated. Use withObjUriQualifiers(ObjQualifierConverter) instead.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMeasureDefinition

public SimpleMeasureDefinition(ObjQualifier item)

SimpleMeasureDefinition

public SimpleMeasureDefinition(ObjQualifier item,
                               String aggregation,
                               Boolean computeRatio,
                               List<FilterItem> filters)

Creates new definition

Parameters:

item - item which is measured, can be attribute, fact or another measure

aggregation - additional aggregation applied

computeRatio - whether should be shown as ratio

filters - additional filters applied

SimpleMeasureDefinition

public SimpleMeasureDefinition(ObjQualifier item,
                               Aggregation aggregation,
                               Boolean computeRatio,
                               List<FilterItem> filters)

Creates new definition

Parameters:

item - item which is measured, can be attribute, fact or another measure

aggregation - additional aggregation applied

computeRatio - whether should be shown as ratio

filters - additional filters applied

SimpleMeasureDefinition

public SimpleMeasureDefinition(ObjQualifier item,
                               Aggregation aggregation,
                               Boolean computeRatio,
                               FilterItem... filters)

Creates new definition

Parameters:

item - item which is measured, can be attribute, fact or another measure

aggregation - additional aggregation applied

computeRatio - whether should be shown as ratio

filters - additional filters applied

Method Detail

withObjUriQualifiers

public MeasureDefinition withObjUriQualifiers(ObjQualifierConverter objQualifierConverter)

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.

Specified by:

withObjUriQualifiers in interface MeasureDefinition

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()

Specified by:

isAdHoc in interface MeasureDefinition

Returns:

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

getUri

public String getUri()

Description copied from interface: MeasureDefinition

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

Specified by:

getUri in interface MeasureDefinition

Returns:

uri of the measure

getObjQualifier

@Deprecated
public ObjQualifier getObjQualifier()

Deprecated. Use getObjQualifiers() instead.

Returns the qualifier used by the Metric.

Specified by:

getObjQualifier in interface MeasureDefinition

Returns:

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

getObjQualifiers

public Collection<ObjQualifier> getObjQualifiers()

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.

Specified by:

getObjQualifiers in interface MeasureDefinition

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.

Specified by:

withObjUriQualifier in interface MeasureDefinition

Parameters:

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

Returns:

self copy with given qualifier

getItem

public ObjQualifier getItem()

Returns:

measured item, can be attribute, fact or another measure

getAggregation

public String getAggregation()

Returns:

additional aggregation applied

setAggregation

public void setAggregation(String aggregation)

Set additional aggregation applied

Parameters:

aggregation - additional aggregation applied

setAggregation

public void setAggregation(Aggregation aggregation)

Set additional aggregation applied

Parameters:

aggregation - additional aggregation applied

getComputeRatio

public Boolean getComputeRatio()

Returns:

true when should be shown as ratio, false otherwise

setComputeRatio

public void setComputeRatio(Boolean computeRatio)

Set whether should be shown as ratio

Parameters:

computeRatio - whether should be shown as ratio

getFilters

public List<FilterItem> getFilters()

Returns:

additional filters applied

setFilters

public void setFilters(List<FilterItem> filters)

Set additional filters applied

Parameters:

filters - additional filters applied

addFilter

public void addFilter(FilterItem filter)

Apply additional filter

Parameters:

filter - filter to be applied

hasFilters

public boolean hasFilters()

Returns:

true when filters are set, false otherwise

hasComputeRatio

public boolean hasComputeRatio()

Returns:

true when computeRatio is set, false otherwise

hasAggregation

public boolean hasAggregation()

Returns:

true when additional aggregation is set, false otherwise

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