Skip navigation links


com.essbase.api.dataquery
Interface IEssOpZoomIn

All Superinterfaces:
IEssBaseObject, IEssOperation

public interface IEssOpZoomIn
extends IEssOperation

The IEssOpZoomIn interface.

Version:
1.0, 04/04/2001
Author:
Srini Ranga

Nested Class Summary
static class IEssOpZoomIn.EEssZoomInPreference
          The EEssZoomInPreference class is an enumeration of zoom in preferences.

 

Nested classes/interfaces inherited from interface com.essbase.api.dataquery.IEssOperation
IEssOperation.EEssOperationType

 

Method Summary
 void addCell(int startRow, int startColumn)
          Adds a cell to operate on.
 void addRange(int startRow, int startColumn, int countRows, int countColumns)
          Adds range of cells to zoom-in.
 int getCountRanges()
          Gets the count of cell ranges to zoom-in.
 IEssOpZoomIn.EEssZoomInPreference getPreference()
          Gets the zoom in preference.
 IEssCubeView.EEssQueryGrammar getQueryGrammar()
          Gets the grammar for the query/report specification.
 java.lang.String getQuerySpec()
          Gets the query/report specification relating to the condition for retrieval.
 IEssIterator getRanges()
          Gets the list of cell ranges to zoom-in.
 boolean isConditionalZoomIn()
          Checks if the operation is conditional zoom-in.
 boolean isNoAttributes()
          Checks if to obtain attributes for the resulting cell values.
 boolean isZoomDown()
          Checks if any page/title dimensions selected will be zoomed down.
 void setNoAttributes(boolean noAttributes)
          Sets if to obtain attributes for the resulting cell values.
 void setPreference(boolean zoomDown, IEssOpZoomIn.EEssZoomInPreference pref)
          Sets the zoom-in preference.
 void setQuery(boolean zoomDown, java.lang.String querySpec, IEssCubeView.EEssQueryGrammar queryGrammar)
          Sets the query/report specification relating to the conditional zoom-in.
 void setZoomDown(boolean zoomDown)
          Sets if any page/title dimensions selected will be zoomed down.

 

Methods inherited from interface com.essbase.api.dataquery.IEssOperation
getOperationType

 

Method Detail

addCell

void addCell(int startRow,
             int startColumn)
             throws com.essbase.api.base.EssException
Adds a cell to operate on. This method in turn calls addRange by passing 1 to both countRows and countColumns.
Parameters:
startRow - The start row.
startColumn - The start column.
Throws:
com.essbase.api.base.EssException - if an error occurs.

addRange

void addRange(int startRow,
              int startColumn,
              int countRows,
              int countColumns)
              throws com.essbase.api.base.EssException
Adds range of cells to zoom-in. (NOTE: This must be a single cell for conditional zoom-in and there can be only one range in that case.)
Parameters:
startRow - The start row.
startColumn - The start column.
countRows - The count of rows.
countColumns - The count of columns.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountRanges

int getCountRanges()
                   throws com.essbase.api.base.EssException
Gets the count of cell ranges to zoom-in.
Returns:
The count of cell ranges to zoom-in.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getRanges

IEssIterator getRanges()
                       throws com.essbase.api.base.EssException
Gets the list of cell ranges to zoom-in.
Returns:
The list of cell ranges to zoom-in.
Throws:
com.essbase.api.base.EssException - if an error occurs

getPreference

IEssOpZoomIn.EEssZoomInPreference getPreference()
                                                throws com.essbase.api.base.EssException
Gets the zoom in preference.
Returns:
The zoom in preference.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setPreference

void setPreference(boolean zoomDown,
                   IEssOpZoomIn.EEssZoomInPreference pref)
                   throws com.essbase.api.base.EssException
Sets the zoom-in preference. (NOTE: For conditional zoom-in use setQuery() method.)
Parameters:
zoomDown - true, if any page/title dimensions will be zoomed down. false, if they will be zoomed across.
pref - The zoom-in preference.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getQuerySpec

java.lang.String getQuerySpec()
                              throws com.essbase.api.base.EssException
Gets the query/report specification relating to the condition for retrieval.
Returns:
The report specification.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getQueryGrammar

IEssCubeView.EEssQueryGrammar getQueryGrammar()
                                              throws com.essbase.api.base.EssException
Gets the grammar for the query/report specification.
Returns:
The query/report specification.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setQuery

void setQuery(boolean zoomDown,
              java.lang.String querySpec,
              IEssCubeView.EEssQueryGrammar queryGrammar)
              throws com.essbase.api.base.EssException
Sets the query/report specification relating to the conditional zoom-in. (NOTE: Use this only for conditional zoom-in. For conditional zoom in the range should be only 1 and should point to a single cell.)
Parameters:
querySpec - The query/report specification.
queryGrammar - The query/report specification grammar type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isZoomDown

boolean isZoomDown()
                   throws com.essbase.api.base.EssException
Checks if any page/title dimensions selected will be zoomed down.
Returns:
true if to zoom down. false, if to zoom across.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setZoomDown

void setZoomDown(boolean zoomDown)
                 throws com.essbase.api.base.EssException
Sets if any page/title dimensions selected will be zoomed down.
Parameters:
zoomDown - true if to zoom down. false if to zoom across.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isConditionalZoomIn

boolean isConditionalZoomIn()
                            throws com.essbase.api.base.EssException
Checks if the operation is conditional zoom-in.
Returns:
true if the operation is conditional zoom-in.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isNoAttributes

boolean isNoAttributes()
                       throws com.essbase.api.base.EssException
Checks if to obtain attributes for the resulting cell values.
Returns:
true, if to obtain attributes for the resulting cell values.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setNoAttributes

void setNoAttributes(boolean noAttributes)
                     throws com.essbase.api.base.EssException
Sets if to obtain attributes for the resulting cell values. Default behavior is to obtain attributes for the resulting cell values. This option is applicable only if it is a conditional zoom-in operation. IEssCubeView.performOperation() will throw an exception if this option is set to true and it is not a conditional zoom-in operation.
Parameters:
noAttributes - true, if to obtain attributes for the resulting cell values.
Throws:
com.essbase.api.base.EssException - if an error occurs.

Skip navigation links