Package com.gooddata.sdk.model.md.visualization

Class 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

    • Constructor Detail

      • VisualizationObject

        public VisualizationObject​(java.lang.String title,
                           java.lang.String visualizationClassUri)
        Constructor.
        Parameters:
        title - title of visualization object
        visualizationClassUri - uri to the VisualizationClass

    • Method Detail

      • 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

      • 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

      • 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

      • setVisualizationClass

        public void setVisualizationClass​(UriObjQualifier uri)
        Parameters:
        uri - to replace previous visualization class's uri, wrapped as UriObjQualifier