Package com.gooddata.sdk.model.md.dashboard

Class Kpi

java.lang.Object

com.gooddata.sdk.model.md.AbstractObj

com.gooddata.sdk.model.md.dashboard.Kpi

All Implemented Interfaces:

Obj, Queryable, Updatable, java.io.Serializable

public class Kpi
extends AbstractObj
implements Queryable, Updatable

Represents KPI (key performance indicator) for analytical dashboard.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.gooddata.sdk.model.md.AbstractObj

meta

Fields inherited from interface com.gooddata.sdk.model.md.Obj

CREATE_URI, CREATE_WITH_ID_URI, OBJ_URI, URI

Constructor Summary

Constructors

Constructor	Description
Kpi(java.lang.String title, java.lang.String metricUri, java.lang.String comparisonType, java.lang.String comparisonDirection, java.util.List<FilterReference> ignoreDashboardFilters, java.lang.String dateDatasetUri)	Creates new KPI for a given metric with some date filter and comparison

Method Summary

Modifier and Type	Method	Description
java.lang.String	getComparisonDirection()
java.lang.String	getComparisonType()
java.lang.String	getDateDatasetUri()
java.util.List<FilterReference>	getIgnoreDashboardFilters()
java.lang.String	getMetricUri()

Methods inherited from class com.gooddata.sdk.model.md.AbstractObj

getAuthor, getCategory, getContributor, getCreated, getFlags, getId, getIdentifier, getSummary, getTags, getTitle, getUpdated, getUri, isDeprecated, isLocked, isProduction, isSharedWithSomeone, isUnlisted, setCategory, setDeprecated, setFlags, setIdentifier, setLocked, setProduction, setSharedWithSomeone, setSummary, setTags, setTitle, setUnlisted, toString, uris

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gooddata.sdk.model.md.Obj

getUri

Constructor Detail

Kpi

public Kpi(java.lang.String title,
           java.lang.String metricUri,
           java.lang.String comparisonType,
           java.lang.String comparisonDirection,
           java.util.List<FilterReference> ignoreDashboardFilters,
           java.lang.String dateDatasetUri)

Creates new KPI for a given metric with some date filter and comparison

Parameters:

title - title of KPI

metricUri - URI of the KPI metric

comparisonType - KPI comparison type (e.g. "lastYear")

comparisonDirection - KPI comparison direction (e.g. "growIsGood")

ignoreDashboardFilters - list of filters which should be ignored for this KPI (can be empty)

dateDatasetUri - KPI date filter dataset URI (optional)

Method Detail

getMetricUri

public java.lang.String getMetricUri()

Returns:

KPI metric URI string

getComparisonType

public java.lang.String getComparisonType()

Returns:

KPI comparison type

getComparisonDirection

public java.lang.String getComparisonDirection()

Returns:

KPI comparison direction

getDateDatasetUri

public java.lang.String getDateDatasetUri()

Returns:

KPI date filter dataset URI

getIgnoreDashboardFilters

public java.util.List<FilterReference> getIgnoreDashboardFilters()

Returns:

list of filter references (containing URIs) of filters which should be ignored for this KPI