Package com.appliedolap.essbase.impl

Class EssDrillthroughImpl

java.lang.Object
com.appliedolap.essbase.AbstractEssObject
com.appliedolap.essbase.impl.EssDrillthroughImpl
All Implemented Interfaces:
EssDrillthrough, EssObject
public class EssDrillthroughImpl extends AbstractEssObject implements EssDrillthrough
Represents a drill-through report on a given cube.

  • Constructor Details

    • EssDrillthroughImpl

      public EssDrillthroughImpl(ApiContext api, EssCube cube, com.appliedolap.essbase.client.model.ReportBean reportBean)

  • Method Details

    • getCube

      public EssCube getCube()
      Description copied from interface: EssDrillthrough
      Returns the cube that owns this drill-through object.
      Specified by:
      getCube in interface EssDrillthrough
      Returns:
      the parent cube for this drill-through definition

    • getName

      public String getName()
      Description copied from interface: EssDrillthrough
      Gets the name of this drill-through report.
      Specified by:
      getName in interface EssDrillthrough
      Specified by:
      getName in interface EssObject
      Returns:
      the drill-through name

    • getType

      public EssObject.Type getType()
      Description copied from interface: EssObject
      Gets the type of this object.
      Specified by:
      getType in interface EssDrillthrough
      Specified by:
      getType in interface EssObject
      Returns:
      the object type

    • getUrl

      public String getUrl()
      Description copied from interface: EssDrillthrough
      Gets the URL of this drill-through report (URL-style only!). This API will likely change soon as support for different drill-through types is built out.
      Specified by:
      getUrl in interface EssDrillthrough
      Returns:
      the drill URL if there is one, null otherwise, such as on data source reports

    • getDrillthroughType

      public EssDrillthrough.DrillthroughType getDrillthroughType()
      Description copied from interface: EssDrillthrough
      Gets the type of report, which will be either DATASOURCE or URL. This method causes a fetch to the drill-through report definition endpoint if it hasn't already been fetched.
      Specified by:
      getDrillthroughType in interface EssDrillthrough
      Returns:
      the type
      See Also:

    • setUrl

      public void setUrl(String url)
      Description copied from interface: EssDrillthrough
      Sets the drill (again, likely to change soon)
      Specified by:
      setUrl in interface EssDrillthrough
      Parameters:
      url - the drill URL

    • getDrillableRegions

      public List<String> getDrillableRegions()
      Description copied from interface: EssDrillthrough
      Get the drillable regions.
      Specified by:
      getDrillableRegions in interface EssDrillthrough
      Returns:
      the list of drillable regions

    • setDrillableRegions

      public void setDrillableRegions(List<String> drillableRegions)
      Description copied from interface: EssDrillthrough
      Sets the drillable regions for this report
      Specified by:
      setDrillableRegions in interface EssDrillthrough
      Parameters:
      drillableRegions - the drillable regions

    • isUseTempTables

      public boolean isUseTempTables()
      Description copied from interface: EssDrillthrough
      Gets the useTempTables parameter for this report which is only valid using Oracle DB.
      Specified by:
      isUseTempTables in interface EssDrillthrough
      Returns:
      the use temp tables setting

    • setUseTempTables

      public void setUseTempTables(boolean useTempTables)
      Description copied from interface: EssDrillthrough
      Sets the useTempTables parameter for this report which is only valid using Oracle DB.
      Specified by:
      setUseTempTables in interface EssDrillthrough
      Parameters:
      useTempTables - the use temp tables setting

    • getDataSourceName

      public String getDataSourceName()
      Description copied from interface: EssDrillthrough
      Gets the name of the data source for this report.
      Specified by:
      getDataSourceName in interface EssDrillthrough
      Returns:
      the name of the data source.

    • setDataSourceName

      public void setDataSourceName(String dataSourceName)
      Description copied from interface: EssDrillthrough
      Sets the name of the data source for this report.
      Specified by:
      setDataSourceName in interface EssDrillthrough
      Parameters:
      dataSourceName - the name of the data source

    • getColumns

      public List<String> getColumns()
      Gets a list of column names for this report.
      Returns:
      a list of column names for this report.

    • setColumns

      public void setColumns(List<String> columns)
      Sets the list of column names for this report.
      Parameters:
      columns - a list of column names for this report

    • getColumnMappings

      public Map<String,EssDrillthroughImpl.ColumnMapping> getColumnMappings()
      Gets information about report column mappings.
      Returns:
      information about report column mappings.

    • setColumnMappings

      public void setColumnMappings(Map<String,EssDrillthroughImpl.ColumnMapping> columnMappings)
      Sets a map of column mapping objects to update.
      Parameters:
      columnMappings - a map of column mapping objects to update

    • getParameterMappings

      public Map<String,EssDrillthroughImpl.Parameter> getParameterMappings()
      Gets information about parameter mappings.
      Returns:
      information about parameter mappings.

    • setRunTimeParameters

      public void setRunTimeParameters(Map<String,EssDrillthroughImpl.Parameter> parameters)
      Sets a map of parameter mappings to update.
      Parameters:
      parameters - a map of parameter mappings to update

    • save

      public void save()
      Description copied from interface: EssDrillthrough
      Saves updates to this report
      Specified by:
      save in interface EssDrillthrough

    • delete

      public void delete()
      Description copied from interface: EssDrillthrough
      Deletes this drill-through report
      Specified by:
      delete in interface EssDrillthrough

    • run

      public void run(Map<String,String> pov, OutputStream outputStream)
      Executes a drill-through request for the given POV and sends output to the given output stream. The default EssDrillthroughImpl.Options will be used for output.
      Parameters:
      pov - a mappings of dimensions to members representing the drilled cell.
      outputStream - the stream to output to

    • run

      public void run(Map<String,String> pov, OutputStream outputStream, EssDrillthroughImpl.Options options)
      Executes a drill-through request for the given POV and sends output to the given output stream.
      Parameters:
      pov - a mappings of dimensions to members representing the drilled cell.
      options - custom options for output generation
      outputStream - the stream to output to