Package com.appliedolap.essbase.impl
Class EssCubeViewImpl
java.lang.Object
com.appliedolap.essbase.impl.EssCubeViewImpl
- All Implemented Interfaces:
EssCubeView,EssGrid
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.appliedolap.essbase.EssCubeView
EssCubeView.CellType, EssCubeView.GridPreferences, EssCubeView.Indentation, EssCubeView.MemberPlacement, EssCubeView.ZoomInPreference -
Constructor Summary
ConstructorsConstructorDescriptionEssCubeViewImpl(ApiContext api, String applicationName, String databaseName, com.appliedolap.essbase.client.model.Grid grid) -
Method Summary
Modifier and TypeMethodDescriptiongetCell(int row, int col) getCellType(int row, int col) Classifies the cell at the given position asEssCubeView.CellType.DATAorEssCubeView.CellType.MEMBER.intReads the current session's ad hoc display/navigation preferences.intgetRows()voidkeepOnly(int row, int col) Keeps only the member at the given position.voidpivot(int fromRow, int fromCol, int toRow, int toCol) Swaps the positions of the members at the two given coordinates.voidpivotToPov(int row, int col) Pins the member at the given position into the POV, removing its dimension from whichever axis it currently occupies.voidrefresh()Re-executes the view as-is, picking up any data changes made since it was last retrieved.voidremoveOnly(int row, int col) Removes the member at the given position, keeping the rest.voidsetMembers(List<EssCubeView.MemberPlacement> placements) Replaces the members at the given positions, in one request.voidsetPreferences(EssCubeView.GridPreferences preferences) Replaces the current session's ad hoc display/navigation preferences.voidzoomIn(int row, int col) Zooms in on the member at the given position, using the server's default zoom-in preference.voidzoomOut(int row, int col) Zooms out from the member at the given position.
-
Constructor Details
-
EssCubeViewImpl
public EssCubeViewImpl(ApiContext api, String applicationName, String databaseName, com.appliedolap.essbase.client.model.Grid grid)
-
-
Method Details
-
getRows
public int getRows() -
getColumns
public int getColumns()- Specified by:
getColumnsin interfaceEssGrid
-
getCell
-
getCellType
Description copied from interface:EssCubeViewClassifies the cell at the given position asEssCubeView.CellType.DATAorEssCubeView.CellType.MEMBER. Based on whether the cell's (undocumented by Oracle)typescode is exactly"2"- verified, against a live server, to mark the data-cell position consistently whether or not the cell currently holds a real value (confirmed both with real data present, and later with every data cell blank/missing after a database reload). Deliberately compares by equality rather than treatingtypesas a bitmask: code"7"(blank filler cells) also has bit 2 set, but is not a data position, so a bitwise check misclassifies it.- Specified by:
getCellTypein interfaceEssCubeView- Parameters:
row- the row of the cellcol- the column of the cell- Returns:
- the cell's type
-
setMembers
Description copied from interface:EssCubeViewReplaces the members at the given positions, in one request. Verified live against a real server: this retargets an existing member-position on an existing axis tier to a different member (e.g. changing which Product shows in a given row) - it does not grow the grid to add rows or columns beyond what's already there, and the given member name must be valid for that position's dimension.- Specified by:
setMembersin interfaceEssCubeView- Parameters:
placements- the members to place, and where
-
zoomIn
public void zoomIn(int row, int col) Description copied from interface:EssCubeViewZooms in on the member at the given position, using the server's default zoom-in preference. See the class-level javadoc: this tries "ranges" first and only falls back to "coordinates" if the server itself rejects that shape - not a guess based on inspecting the cell, but a reaction to what the server says about the same literal click either way.- Specified by:
zoomInin interfaceEssCubeView- Parameters:
row- the row of the member to zoom in oncol- the column of the member to zoom in on
-
zoomOut
public void zoomOut(int row, int col) Description copied from interface:EssCubeViewZooms out from the member at the given position. See the class-level javadoc: this describes the click as-is and returns whatever the server does with it, rather than computing a request shaped to force a particular collapse.- Specified by:
zoomOutin interfaceEssCubeView- Parameters:
row- the row of the member to zoom out fromcol- the column of the member to zoom out from
-
keepOnly
public void keepOnly(int row, int col) Description copied from interface:EssCubeViewKeeps only the member at the given position. See the class-level javadoc: this describes the click as-is and returns whatever the server does with it, rather than computing a request shaped to force a particular outcome.- Specified by:
keepOnlyin interfaceEssCubeView- Parameters:
row- the row of the member to keepcol- the column of the member to keep
-
removeOnly
public void removeOnly(int row, int col) Description copied from interface:EssCubeViewRemoves the member at the given position, keeping the rest.Not currently verified to work - every coordinate/range tried against a live server returns "This operation would generate a nonsensical report." See the class-level javadoc.
- Specified by:
removeOnlyin interfaceEssCubeView- Parameters:
row- the row of the member to removecol- the column of the member to remove
-
refresh
public void refresh()Description copied from interface:EssCubeViewRe-executes the view as-is, picking up any data changes made since it was last retrieved.- Specified by:
refreshin interfaceEssCubeView
-
pivot
public void pivot(int fromRow, int fromCol, int toRow, int toCol) Description copied from interface:EssCubeViewSwaps the positions of the members at the two given coordinates.- Specified by:
pivotin interfaceEssCubeView- Parameters:
fromRow- the row of the first memberfromCol- the column of the first membertoRow- the row of the second membertoCol- the column of the second member
-
pivotToPov
public void pivotToPov(int row, int col) Description copied from interface:EssCubeViewPins the member at the given position into the POV, removing its dimension from whichever axis it currently occupies.- Specified by:
pivotToPovin interfaceEssCubeView- Parameters:
row- the row of the member to pin to the POVcol- the column of the member to pin to the POV
-
getPreferences
Description copied from interface:EssCubeViewReads the current session's ad hoc display/navigation preferences.- Specified by:
getPreferencesin interfaceEssCubeView
-
setPreferences
Description copied from interface:EssCubeViewReplaces the current session's ad hoc display/navigation preferences. SeeEssCubeView.GridPreferences: this takes effect for every subsequent grid operation on this connection, not just this view, and persists until changed again.- Specified by:
setPreferencesin interfaceEssCubeView- Parameters:
preferences- the preferences to apply
-