Package com.gooddata.md.visualization
Class VisualizationObject
- java.lang.Object
-
- com.gooddata.md.AbstractObj
-
- com.gooddata.md.visualization.VisualizationObject
-
- All Implemented Interfaces:
Obj,Queryable,Updatable,Serializable
public class VisualizationObject extends AbstractObj implements Queryable, Updatable
Complete information about new visualization object that can be stored as MD object (seeObj) to md server. The visualization object is part of new GD UI visualizations situated in AD and KPI dashboards. This object is a persistent form of AFM (Attribute, Measures, Filters) report executions.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.gooddata.md.AbstractObj
meta
-
Fields inherited from interface com.gooddata.md.Obj
CREATE_URI, CREATE_WITH_ID_URI, OBJ_TEMPLATE, OBJ_URI, URI
-
-
Constructor Summary
Constructors Constructor Description VisualizationObject(String title, String visualizationClassUri)Constructor.
-
Method Summary
-
Methods inherited from class com.gooddata.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
-
-
-
-
Constructor Detail
-
VisualizationObject
public VisualizationObject(String title, String visualizationClassUri)
Constructor.- Parameters:
title- title of visualization objectvisualizationClassUri- uri to theVisualizationClass
-
-
Method Detail
-
getMeasures
public List<Measure> getMeasures()
- Returns:
- all measures from all buckets in visualization object
-
getMeasure
public Measure getMeasure(String localIdentifier)
Get measure by local identifier or null if not found- Parameters:
localIdentifier- of measure- Returns:
- measure or null
-
getSimpleMeasures
public List<Measure> getSimpleMeasures()
- Returns:
- all measures from all buckets whose measure definition is instance of
VOSimpleMeasureDefinition
-
getAttributes
public List<VisualizationAttribute> getAttributes()
- Returns:
- all attributes from all buckets in visualization object
-
getAttribute
public VisualizationAttribute getAttribute(String localIdentifier)
-
getAttributeFromCollection
public VisualizationAttribute getAttributeFromCollection(CollectionType type)
Returns attribute from collection bucket, if and only if bucket contains exactly one item of typeVisualizationAttribute, null otherwise- Parameters:
type- of collection which we want to get, stored as local identifier in each bucket- Returns:
- attribute from collection bucket
-
hasMeasures
public boolean hasMeasures()
-
hasDerivedMeasure
public boolean hasDerivedMeasure()
- Returns:
- true if visualization object contains at leas one PoP measure or measure with compute ratio, false otherwise
-
getItemById
public String getItemById(String id)
Method to get uri to requested local identifier from reference items- Parameters:
id- of item- Returns:
- uri of requested item
-
getStack
public VisualizationAttribute getStack()
- Returns:
- attribute from stack collection
-
getView
public VisualizationAttribute getView()
- Returns:
- attribute from view collection
-
getSegment
public VisualizationAttribute getSegment()
- Returns:
- attribute from segment collection
-
getTrend
public VisualizationAttribute getTrend()
- Returns:
- attribute from trend collection
-
getVisualizationClassUri
public String getVisualizationClassUri()
- Returns:
- uri to the
VisualizationClass
-
setBuckets
public void setBuckets(List<Bucket> buckets)
- Parameters:
buckets- replacing previous visualization object's buckets
-
getFilters
public List<FilterItem> getFilters()
- Returns:
- filters from visualization object
-
setFilters
public void setFilters(List<FilterItem> filters)
- Parameters:
filters- replacing previsous visualization object's filters
-
getProperties
public String getProperties()
- Returns:
- json properties of visualization object in form of string
-
setProperties
public void setProperties(String properties)
- Parameters:
properties- to be set to visualization object in form of stringified json
-
getReferenceItems
public Map<String,String> getReferenceItems()
- Returns:
- hash map of references in form localIdentifier:uri
-
setReferenceItems
public void setReferenceItems(Map<String,String> referenceItems)
- Parameters:
referenceItems- is a hash map of references in form localIdentifier:uri to be set to visualization object
-
getVisualizationClass
public UriObjQualifier getVisualizationClass()
- Returns:
- uri to visualizaton class wrapped as
UriObjQualifier
-
setVisualizationClass
public void setVisualizationClass(UriObjQualifier uri)
- Parameters:
uri- to replace previous visualization class's uri, wrapped asUriObjQualifier
-
convertToExecution
public Execution convertToExecution(Function<String,VisualizationClass> visualizationClassgetter)
-
convertToExecution
public Execution convertToExecution(VisualizationClass visualizationClass)
-
convertToAfm
public Afm convertToAfm()
-
convertToResultSpec
public ResultSpec convertToResultSpec(Function<String,VisualizationClass> visualizationClassgetter)
-
convertToResultSpec
public ResultSpec convertToResultSpec(VisualizationClass visualizationClass)
-
-