java.lang.Object

com.gooddata.sdk.model.md.AbstractObj

com.gooddata.sdk.model.md.visualization.VisualizationObject

All Implemented Interfaces:: Obj, Queryable, Updatable, java.io.Serializable

public class VisualizationObject
extends AbstractObj
implements Queryable, Updatable

Complete information about new visualization object that can be stored as MD object (see Obj) 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.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

VisualizationObject(java.lang.String title, java.lang.String visualizationClassUri)
Constructor.

Method Summary

Modifier and Type	Method	Description
`Afm`	`convertToAfm()`
`Execution`	`convertToExecution(VisualizationClass visualizationClass)`
`Execution`	`convertToExecution(java.util.function.Function<java.lang.String,VisualizationClass> visualizationClassgetter)`
`ResultSpec`	`convertToResultSpec(VisualizationClass visualizationClass)`
`ResultSpec`	`convertToResultSpec(java.util.function.Function<java.lang.String,VisualizationClass> visualizationClassgetter)`
`VisualizationAttribute`	`getAttribute(java.lang.String localIdentifier)`
`VisualizationAttribute`	`getAttributeFromCollection(CollectionType type)`	Returns attribute from collection bucket, if and only if bucket contains exactly one item of type `VisualizationAttribute`, null otherwise
`java.util.List<VisualizationAttribute>`	`getAttributes()`
`java.util.List<Bucket>`	`getBuckets()`
`java.util.List<ExtendedFilter>`	`getFilters()`
`java.lang.String`	`getItemById(java.lang.String id)`	Method to get uri to requested local identifier from reference items
`Measure`	`getMeasure(java.lang.String localIdentifier)`	Get measure by local identifier or null if not found
`java.util.List<Measure>`	`getMeasures()`
`java.lang.String`	`getProperties()`
`java.util.Map<java.lang.String,java.lang.String>`	`getReferenceItems()`
`VisualizationAttribute`	`getSegment()`
`java.util.List<Measure>`	`getSimpleMeasures()`
`VisualizationAttribute`	`getStack()`
`VisualizationAttribute`	`getTrend()`
`VisualizationAttribute`	`getView()`
`UriObjQualifier`	`getVisualizationClass()`
`java.lang.String`	`getVisualizationClassUri()`
`boolean`	`hasDerivedMeasure()`
`boolean`	`hasMeasures()`
`void`	`setBuckets(java.util.List<Bucket> buckets)`
`void`	`setFilters(java.util.List<ExtendedFilter> filters)`
`void`	`setProperties(java.lang.String properties)`
`void`	`setReferenceItems(java.util.Map<java.lang.String,java.lang.String> referenceItems)`
`void`	`setVisualizationClass(UriObjQualifier uri)`

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 Details
- VisualizationObject
  
  public VisualizationObject(java.lang.String title, java.lang.String visualizationClassUri)
  
  Constructor.
  
  Parameters:
  
  title - title of visualization object
  
  visualizationClassUri - uri to the VisualizationClass
Method Details
- getMeasures
  
  public java.util.List<Measure> getMeasures()
  
  Returns:
  
  all measures from all buckets in visualization object
- getMeasure
  
  public Measure getMeasure(java.lang.String localIdentifier)
  
  Get measure by local identifier or null if not found
  
  Parameters:
  
  localIdentifier - of measure
  
  Returns:
  
  measure or null
- getSimpleMeasures
  
  public java.util.List<Measure> getSimpleMeasures()
  
  Returns:
  
  all measures from all buckets whose measure definition is instance of VOSimpleMeasureDefinition
- getAttributes
  
  public java.util.List<VisualizationAttribute> getAttributes()
  
  Returns:
  
  all attributes from all buckets in visualization object
- getAttribute
  
  public VisualizationAttribute getAttribute(java.lang.String localIdentifier)
- getAttributeFromCollection
  
  public VisualizationAttribute getAttributeFromCollection(CollectionType type)
  
  Returns attribute from collection bucket, if and only if bucket contains exactly one item of type VisualizationAttribute, 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 java.lang.String getItemById(java.lang.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 java.lang.String getVisualizationClassUri()
  
  Returns:
  
  uri to the VisualizationClass
- getBuckets
  
  public java.util.List<Bucket> getBuckets()
  
  Returns:
  
  buckets from visualization object
- setBuckets
  
  public void setBuckets(java.util.List<Bucket> buckets)
  
  Parameters:
  
  buckets - replacing previous visualization object's buckets
- getFilters
  
  public java.util.List<ExtendedFilter> getFilters()
  
  Returns:
  
  filters from visualization object
- setFilters
  
  public void setFilters(java.util.List<ExtendedFilter> filters)
  
  Parameters:
  
  filters - replacing previous visualization object's filters
- getProperties
  
  public java.lang.String getProperties()
  
  Returns:
  
  json properties of visualization object in form of string
- setProperties
  
  public void setProperties(java.lang.String properties)
  
  Parameters:
  
  properties - to be set to visualization object in form of stringified json
- getReferenceItems
  
  public java.util.Map<java.lang.String,java.lang.String> getReferenceItems()
  
  Returns:
  
  hash map of references in form localIdentifier:uri
- setReferenceItems
  
  public void setReferenceItems(java.util.Map<java.lang.String,java.lang.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 visualization class wrapped as UriObjQualifier
- setVisualizationClass
  
  public void setVisualizationClass(UriObjQualifier uri)
  
  Parameters:
  
  uri - to replace previous visualization class's uri, wrapped as UriObjQualifier
- convertToExecution
  
  public Execution convertToExecution(java.util.function.Function<java.lang.String,VisualizationClass> visualizationClassgetter)
  
  See Also:
  
  VisualizationConverter.convertToExecution(VisualizationObject, Function)
- convertToExecution
  
  public Execution convertToExecution(VisualizationClass visualizationClass)
  
  See Also:
  
  VisualizationConverter.convertToExecution(VisualizationObject, VisualizationClass)
- convertToAfm
  
  public Afm convertToAfm()
  
  See Also:
  
  VisualizationConverter.convertToAfm(VisualizationObject)
- convertToResultSpec
  
  public ResultSpec convertToResultSpec(java.util.function.Function<java.lang.String,VisualizationClass> visualizationClassgetter)
  
  See Also:
  
  VisualizationConverter.convertToResultSpec(VisualizationObject, Function)
- convertToResultSpec
  
  public ResultSpec convertToResultSpec(VisualizationClass visualizationClass)
  
  See Also:
  
  VisualizationConverter.convertToResultSpec(VisualizationObject, VisualizationClass)

Class VisualizationObject

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

Method Details