com.gooddata.executeafm.afm

Class SimpleMeasureDefinition

java.lang.Object

com.gooddata.executeafm.afm.SimpleMeasureDefinition

All Implemented Interfaces:

MeasureDefinition

public class SimpleMeasureDefinition
extends Object
implements MeasureDefinition

Definition of simple measure

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
String	getAggregation()
Boolean	getComputeRatio()
List<FilterItem>	getFilters()
ObjQualifier	getItem()
ObjQualifier	getObjQualifier() Returns the qualifier, qualifying the Metric.
String	getUri() Returns the definition in the form of uri of Metric.
boolean	hasAggregation()
boolean	hasComputeRatio()
boolean	hasFilters()
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 qualifier) Copy itself using given uri qualifier

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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

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:

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

public ObjQualifier getObjQualifier()

Description copied from interface: MeasureDefinition

Returns the qualifier, qualifying the Metric.

Specified by:

getObjQualifier in interface MeasureDefinition

Returns:

qualifier of measure

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

toString

public String toString()

Overrides:

toString in class Object