DataBlox (IBM Alphablox V9.5.1 Blox API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

IBM Alphablox V9.5.1 Blox API Reference

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.alphablox.blox
Class DataBlox

java.lang.Object
  BloxImpl
      com.alphablox.blox.AbstractBlox
          com.alphablox.blox.DataBlox

All Implemented Interfaces:: BookmarkableBlox

public class DataBlox
extends AbstractBlox
implements BookmarkableBlox

The server-side DataBlox. DataBlox provides a means to access and query data, serves as a data source for the user interface Blox (such as PresentBlox, GridBlox, or ChartBlox), and enables application scripting such as dynamically setting the query. In addition, it returns a resultset object and a metadata object:

The resultset returned involves actual data values from a query and enables you to perform tasks such calculations or custom data view. To get the resultset object, use the DataBlox getResultSet method.
The metadata object contains information on the cubes, dimensions, and members (outline) of the data source. To get the metadata object, use the DataBlox getMetaData method.

See Also:: Serialized Form

Field Summary
`static int`	`PARENT_DEFAULT` The int representing the default parent orientation flag.
`static int`	`PARENT_FIRST` The int representing the parent first orientation flag.
`static int`	`PARENT_LAST` The int representing the parent last orientation flag.

Fields inherited from class com.alphablox.blox.AbstractBlox

RENDER_DHTML, RENDER_NONE, RENDER_PRINTER, RENDER_XML

Constructor Summary
`DataBlox()` Default constructor

Method Summary
`void`	`addBookmarkDeleteFilter(BookmarkDeleteFilter filter)` Deprecated. use addEventFilter()
`void`	`addBookmarkLoadFilter(BookmarkLoadFilter filter)` Deprecated. use addEventFilter()
`void`	`addBookmarkRenameFilter(BookmarkRenameFilter filter)` Deprecated. use addEventFilter()
`void`	`addBookmarkSaveFilter(BookmarkSaveFilter filter)` Deprecated. use addEventFilter()
`void`	`addCollapseFilter(CollapseFilter filter)` Deprecated. Use addEventFilter()
`void`	`addDataChangedEventListener(DataChangedEventListener listener)`
`void`	`addDrillDownFilter(DrillDownFilter filter)` Deprecated. Use addEventFilter()
`void`	`addDrillThroughFilter(DrillThroughFilter filter)` Deprecated. Use addEventFilter()
`void`	`addDrillUpFilter(DrillUpFilter filter)` Deprecated. Use addEventFilter()
`void`	`addEventFilter(DataFilter dataFilter)` Addes the dataFilter to the list of filters to be notified prior to data events being processed.
`void`	`addExpandFilter(ExpandFilter filter)` Deprecated. Use addEventFilter()
`void`	`addHideOnlyFilter(HideOnlyFilter filter)` Deprecated. Use addEventFilter()
`void`	`addKeepOnlyFilter(KeepOnlyFilter filter)` Deprecated. Use addEventFilter()
`void`	`addMemberSelectFilter(MemberSelectFilter filter)` Deprecated. Use addEventFilter()
`void`	`addPivotFilter(PivotFilter filter)` Deprecated. Use addEventFilter()
`void`	`addQueryFilter(QueryFilter filter)` Deprecated. Use addEventFilter()
`void`	`addRemoveOnlyFilter(RemoveOnlyFilter filter)` Deprecated. Use addEventFilter()
`void`	`addSelectedMembers(Member[] members)` Add to the selected members for the given dimension.
`void`	`addShowAllFilter(ShowAllFilter filter)` Deprecated. Use addEventFilter()
`void`	`addShowOnlyFilter(ShowOnlyFilter filter)` Deprecated. Use addEventFilter()
`void`	`addSwapAxisFilter(SwapAxisFilter filter)` Deprecated. Use addEventFilter()
`void`	`clearClientCache()` Call this method to clear the client cache used by MSOLAP connection; for Microsoft Analysis Services data sources only.
`void`	`clearResultSet()` Clears and deletes the current result set for this DataBlox.
`void`	`commitData()` Writes the current data set back to the database.
`void`	`connect()` If currently connected, disconnect and clear the current result set.
`void`	`connect(boolean executeTextualQuery)` If currently connected, disconnect and clear the current result set.
`void`	`deleteBlox()`
`void`	`deleteBookmark(int visibility, java.lang.String owner, java.lang.String bookmarkName)` Deprecated. Use `com.alphablox.internal.common.peer.BookmarkImpl#delete()`
`void`	`disconnect(boolean clearResultSet)` Disconnects from the data source and releases the back end connection.
`void`	`drillDown(TupleMember member)` Drills down on the specified member.
`RDBResultSet`	`drillThrough(int columnCoordinate, int rowCoordinate)` Perform a drill through operation at the specified cell.
`RDBResultSet`	`drillThrough(int columnCoordinate, int rowCoordinate, int timeout)` Perform a drill through operation at the specified cell.
`RDBResultSet`	`drillThrough(java.lang.String reportName, int columnCoordinate, int rowCoordinate)` Performs a drill through operation at the specified cell using the specified reportName.
`RDBResultSet`	`drillThrough(Tuple[] coordinates)` Perform a drill through operation at the specified cell.
`RDBResultSet`	`drillThrough(Tuple[] coordinates, int timeout)` Perform a drill through operation at the specified cell.
`void`	`drillToAllDescendants(TupleMember member)` Drills down to all descendants for the specified member.
`void`	`drillUp(TupleMember member)` Drills up on the specified member.
`void`	`executeCustomCalc(java.lang.String calcScript)` Executes a calculation script on an Essbase database (for example,"CALC ALL;").
`void`	`executeNamedDBCalcScript(java.lang.String calcScript)` Executes the named Essbase calculation script.
`void`	`freeConnection()` Frees this DataBlox's connection and puts it back onto the connection pool.
`java.lang.String`	`generateQuery()` Generates and returns a textual query reflecting the current state of the result set, in the query language of the data source (e.g., MDX).
`IQueryModel`	`generateQueryModel()` Generates and returns an IQueryModel object that reflects the current state of the result set.
`java.lang.String`	`getAliasTable()` Identifies the aliase table used for the current Essbase data source
`java.lang.Object`	`getASCSConnection()` This method is used only by the Symphony adapter.
`java.lang.String`	`getBookmarkFilter()` Returns the default location from which to store and load bookmarks.
`java.lang.String`	`getCalculatedMembers()` Gets the string that generates the calculated members
`Calculation[]`	`getCalculations()`
`java.lang.String`	`getCatalog()` Gets the name of the database catalog.
`java.lang.String`	`getColumnSort()` Identifies how to sort data values for members on the column axis.
`CommentsBlox`	`getCommentsBlox()`
`java.lang.String`	`getDataSourceName()` Gets the name of the data source.
`java.lang.String`	`getDimensionRoot()` Identifies the dimension and one or more members used as the root.
`Member[]`	`getDimensionRoot(Dimension dimension)` Returns an array of members used as the root members for the specified dimension.
`int`	`getDrillDownOption()` Specifies the type of drill operation to perform.
`java.lang.String[]`	`getDrillThroughReportNames(int columnCoordinate, int rowCoordinate)` Returns the list of drillthrough reports found at the specified cell.
`java.lang.Object`	`getExternalMDConnection()` This method is only used by implementations of external data sources and is not meant for public consumption.
`java.lang.Class[]`	`getFilterClasses()` Returns the allowable filter classes for this blox
`java.lang.String`	`getHiddenMembers()` Gets the hidden members.
`Member`	`getHiddenMembers(MDBMetaData mdbMetaData, int i, java.lang.String cubeName)` Returns the hidden member with the specified index for the array of hidden members.
`Member[]`	`getHiddenMembers(MDBMetaData mdbMetaData, java.lang.String cubeName)` Returns an array of hidden members.
`Column[]`	`getHiddenMembers(RDBMetaData rdbMetaData)` Returns an array containing the hidden colummns (members).
`Column`	`getHiddenMembers(RDBMetaData rdbMetaData, int i)` Returns the hidden column (member) with the specifed index for the array of hidden columns (members).
`java.lang.String`	`getHiddenTuples()` Gets the current hiddenTuples
`java.lang.Class[]`	`getListenerClasses()` Returns the allowable listener classes for this blox
`java.util.HashMap`	`getMDXForDimensions()` Returns the HashMap of MDX set statements for a particular dimensions.
`java.lang.String`	`getMemberNameRemovePrefix()` Identifies the start point of a member name when returned from the data source.
`java.lang.String`	`getMemberNameRemoveSuffix()` Identifies the end point of a member name when returned from the data source.
`java.lang.String`	`getMergedDimensions()` Returns a comma-delimited String representing the names of the "logical" dimensions to merge in the Other Axis of the DataLayoutPanel.
`java.lang.String`	`getMergedHeaders()` Gets a string of the dimensions on the same axis whose headers are merged.
`MetaData`	`getMetaData()` Returns a read-only copy of the metadata.
`int`	`getParentFirst()` Returns an int value representing the parent first setting, either default, parent first or parent last.
`java.lang.String`	`getProvider()` [OLE DB for OLAP datasource only] Return the OLE DB for OLAP provider string
`java.lang.String`	`getQuery()` Gets the data query.
`IResultSetHandler`	`getQueryPassthrough()` Applies to relational data only.
`ResultSet`	`getRawResultSet()` Returns a read-only copy of the result set.
`ResultSet`	`getResultSet()` Returns a read-only copy of the result set.
`java.lang.String`	`getRowSort()` Identifies row members for multidimensional data sources are sorted.
`java.lang.String`	`getSchema()` Gets the name of the database schema.
`Dimension[]`	`getSelectableSlicerDimensions()` Returns an array containing the dimensions that appear on the page axis in the PageBlox.
`Dimension`	`getSelectableSlicerDimensions(int i)` Returns the ith dimension on the page axis in the PageBlox.
`Member[]`	`getSelectedMembers(Dimension dimension)` Returns the selected members for the given dimension.
`java.lang.String`	`getUserName()` Gets the database user name used to access the data source.
`AASCubeXMLDocument`	`getXMLResultSet()` Returns a read-only copy of the result set as XML DOM.
`void`	`hideMembers(Column[] columns)` Hides the columns (members) in the specified array.
`void`	`hideMembers(Member[] members)` Specifies the members to hide.
`void`	`hideMembers(java.lang.String membersToHide)` Specifies the members to hide.
`void`	`hideTuples(java.lang.String selectedTuples)` Hides specified tuples
`boolean`	`init(BloxContext bloxContext, java.lang.String bloxName)` Initializes the DataBlox.
`boolean`	`isAASUserAuthorizationEnabled()` Identifies if the username and password entered during Alphablox login for authentication should be used to access an Essbase data source
`boolean`	`isApplyPropertiesAfterBookmark()` Identifies whether, after retrieving a bookmark, the Blox properties should override those in the bookmark.
`boolean`	`isAutoConnect()` Identifies if the DataBlox is allowed to connect to the database automatically whenever it needs database access.
`boolean`	`isAutoDisconnect()` Identifies if the DataBlox is allowed to disconnect from the database automatically whenever a data access operation is complete.
`boolean`	`isConnected()` Returns `true` when the data source is connected, `false` if not.
`boolean`	`isConnectOnStartup()` Identifies if the DataBlox will automatically connect to its data source upon Blox instantiation.
`boolean`	`isDrillKeepSelectedMember()` Identifies whether the member being drilled on should be retained or removed.
`boolean`	`isDrillRemoveUnselectedMembers()` Identifies whether to remove all members that are not being drilled on.
`boolean`	`isEnableKeepRemove()` Identifies whether the Keep Only and Remove Only options are available to the end user in the context menus of both the GridBlox and ChartBlox.
`boolean`	`isEnableShowHide()` Identifies whether the Show Only, Show All, and Hide Only options are available to end users in the context menus of both the GridBlox and ChartBlox.
`boolean`	`isInternalSortEnabled()` Gets whether or not the internal sort is enabled.
`boolean`	`isLeafDrillDownAvailable()` Identifies if the user should be allowed to drill down on a leaf member.
`boolean`	`isOnErrorClearResultSet()` Identifies whether the existing result set should be cleared if a subsequent database operation fails
`boolean`	`isPerformInAllGroups()` Identifies whether a drill operation is performed on all occurrences of the selected member in each outer nested group containing the dimension, or only on the single selected occurrence of the member.
`boolean`	`isRetainSlicerMemberSet()` Return the persistence of page filter selections after a member is selected.
`boolean`	`isShowShortHierarchyNames()` A flag that determines how to generate dimension display names for dimensions with multiple hierarchies.
`boolean`	`isShowSuppressDataDialog()` Identifies if a warning dialog should pop up when the `useOlapDrillOptimization` property is set to `true` and either `suppressMissingColumns` or `suppressMissingRows` is also set to `true`.
`boolean`	`isSuppressDuplicates()` Identifies whether to remove from the grid those rows or columns containing duplicate header values.
`boolean`	`isSuppressMissing()`
`boolean`	`isSuppressMissingColumns()` Identifies whether columns containing no data at all should be removed from the grid.
`boolean`	`isSuppressMissingRows()` Identifies whether rows containing no data at all should be removed from the grid.
`boolean`	`isSuppressNoAccess()` Identifies whether to remove from the grid those rows or columns containing data the users cannot access.
`boolean`	`isSuppressZeros()` Identifies whether to remove from the grid those rows or columns containing all zeros.
`boolean`	`isTextualQueryEnabled()` Identifies if the textual query rather than the serialized object should be used to restore a bookmark.
`boolean`	`isUseAliases()` Identifies if aliases are used for the Essbase data source in use
`boolean`	`isUseOlapDrillOptimization()` Identifies if drill optimization is enabled for Microsoft Analysis Services data sources.
`void`	`keepOnly(TupleMember member)` Keeps only the specified member.
`void`	`keepOnly(TupleMember[] members)` Keeps only the members found in the specified array.
`java.lang.String[][]`	`listBookmarks(int visibility, java.lang.String owner)` Deprecated. Use `BookmarksBlox.listBookmarks()`, `BookmarksBlox.listBookmarks(com.alphablox.blox.repository.BookmarkMatcher)`
`void`	`loadBookmark(Bookmark bookmark)`
`void`	`loadBookmark(int visibility, java.lang.String owner, java.lang.String bookmarkName)` Loads a bookmark into this Blox.
`void`	`loadRDBResultSet(java.sql.ResultSet storeProcedureResultSet)`
`void`	`lockCurrentDataSet()` Locks the called upon result set.
`void`	`pivot(AxisDimension dimension, int newAxisIndex, int newNestLevel)` Pivots the specified dimension to another position in the schema, either from axis to axis, slicer to axis, or axis to slicer.
`void`	`pivot(int oldAxisIndex, int oldNestLevel, int newAxisIndex, int newNestLevel)` Pivots the specified dimension to another position in the schema, either from axis to axis, slicer to axis, or axis to slicer.
`void`	`refresh()` Refreshes the data set.
`void`	`removeBookmarkDeleteFilter(BookmarkDeleteFilter filter)` Deprecated. use removeEventFilter()
`void`	`removeBookmarkLoadFilter(BookmarkLoadFilter filter)` Deprecated. use removeEventFilter()
`void`	`removeBookmarkRenameFilter(BookmarkRenameFilter filter)` Deprecated. use removeEventFilter()
`void`	`removeBookmarkSaveFilter(BookmarkSaveFilter filter)` Deprecated. use removeEventFilter()
`void`	`removeCollapseFilter(CollapseFilter filter)` Deprecated. Use removeEventFilter()
`void`	`removeColumnSort()` Removes the column sort.
`void`	`removeDataChangedEventListener(DataChangedEventListener listener)`
`void`	`removeDrillDownFilter(DrillDownFilter filter)` Deprecated. Use removeEventFilter()
`void`	`removeDrillThroughFilter(DrillThroughFilter filter)` Deprecated. Use removeEventFilter()
`void`	`removeDrillUpFilter(DrillUpFilter filter)` Deprecated. Use removeEventFilter()
`void`	`removeEventFilter(DataFilter dataFilter)` Removes the dataFilter from the list of filters to notify prior to data events being processed.
`void`	`removeExpandFilter(ExpandFilter filter)` Deprecated. Use removeEventFilter()
`void`	`removeHideOnlyFilter(HideOnlyFilter filter)` Deprecated. Use removeEventFilter()
`void`	`removeKeepOnlyFilter(KeepOnlyFilter filter)` Deprecated. Use removeEventFilter()
`void`	`removeMemberSelectFilter(MemberSelectFilter filter)` Deprecated. Use removeEventFilter()
`void`	`removeOnly(TupleMember member)` Removes only the specified member.
`void`	`removeOnly(TupleMember[] members)` Removes the members found in specified array of members.
`void`	`removePivotFilter(PivotFilter filter)` Deprecated. Use removeEventFilter()
`void`	`removeQueryFilter(QueryFilter filter)` Deprecated. Use removeEventFilter()
`void`	`removeRemoveOnlyFilter(RemoveOnlyFilter filter)` Deprecated. Use removeEventFilter()
`void`	`removeRowSort()` Removes row sort.
`void`	`removeShowAllFilter(ShowAllFilter filter)` Deprecated. Use removeEventFilter()
`void`	`removeShowOnlyFilter(ShowOnlyFilter filter)` Deprecated. Use removeEventFilter()
`void`	`removeSwapAxisFilter(SwapAxisFilter filter)` Deprecated. Use removeEventFilter()
`void`	`renameBookmark(int visibility, java.lang.String owner, java.lang.String oldBookmarkName, java.lang.String newBookmarkName, java.lang.String description)` Deprecated. Use `BookmarksBlox.getBookmark(Blox, String, String)`, `BookmarksBlox.getBookmark(String, String, String, String, String)`, `com.alphablox.internal.common.peer.BookmarkImpl#setName(String)`, `com.alphablox.internal.common.peer.BookmarkImpl#saveAll()`
`void`	`restoreBookmark(int visibility, java.lang.String owner, java.lang.String bookmarkName)` Deprecated. Use `loadBookmark(int, String, String)`
`void`	`saveBookmark(int visibility, java.lang.String owner, java.lang.String bookmarkName, java.lang.String description)` Saves a bookmark.
`void`	`saveBookmarkHidden(int visibility, java.lang.String owner, java.lang.String bookmarkName, java.lang.String description)`
`void`	`setAASUserAuthorizationEnabled(boolean useAASUserAuthorization)` Specifies whether to use the username and password entered during Alphablox login for authentication to an Essbase data source.
`void`	`setAliasTable(java.lang.String aliasTable)` Specifies the Hyperion Essbase alias table to use with the data source.
`void`	`setApplyPropertiesAfterBookmark(boolean applyPropertiesAfterBookmark)` Specifies whether, after retrieving a bookmark, the Blox properties should override those in the bookmark.
`void`	`setAutoConnect(boolean autoConnect)` Enabling this property will cause the DataBlox to reconnect to the data source automatically in all cases except during startup.
`void`	`setAutoDisconnect(boolean autoDisconnect)` Enabling this property will cause the DataBlox to disconnect from the data source automatically when the application no longer requires a connection without erasing the current result set.
`void`	`setBookmarkFilter(java.lang.String bookmarkFilter)` Specifies a default location from which to store and load bookmarks.
`void`	`setCalculatedMembers(java.lang.String calculatedMembers)` Specifies one or more new members to be calculated by Alphablox using the result set retrieved from the data source.
`void`	`setCatalog(java.lang.String catalog)` Specifies the data catalog.
`void`	`setColumnSort(ResultColumn column, boolean ascending)` Specifies how to sort column members for relational data sources.
`void`	`setColumnSort(java.lang.String sortString)` Specifies how to sort column members for multidimensional data sources.
`void`	`setColumnSort(java.lang.String sortString, java.lang.String[] headerMembers, java.lang.String[] footerMembers)`
`void`	`setColumnSort(Tuple tuple, AxisDimension dimension, boolean ascending)` Specifies how to sort column members for multi-dimensional data sources.
`void`	`setColumnSort(Tuple tuple, AxisDimension dimension, boolean ascending, boolean preserveHierarchy)` Specifies how to sort column members for multi-dimensional data sources.
`void`	`setColumnSort(Tuple tuple, AxisDimension dimension, boolean ascending, boolean preserveHierarchy, TupleMember[] headerMbrs, TupleMember[] footerMbrs)` Specifies how to sort column members for multi-dimensional data sources.
`void`	`setCommentsBlox(CommentsBlox commentsBlox)`
`void`	`setConnectOnStartup(boolean connectOnStartup)` Specifies whether the DataBlox will automatically connect to its data source upon Blox instantiation.
`void`	`setCredential(java.lang.Object credential)` Specifies a credential object to be used with the given datasource instead of a username and password.
`void`	`setDataSourceName(java.lang.String dataSourceName)` The data source name must be defined in Alphablox.
`void`	`setDataValues(Tuple[][] coordinates, java.lang.String[] values)` Changes data values in the result set at the coordinates specified.
`void`	`setDimensionRoot(Dimension dimension, Member member)` Deprecated.
`void`	`setDimensionRoot(Dimension dimension, Member[] members)` Specifies the dimension and members to use as the root.
`void`	`setDimensionRoot(java.lang.String dimensionRoot)` Specifies the dimension and one or more members to use as the root
`void`	`setDrillDownOption(int drillDownOption)` Specifies the type of drill operation to perform.
`void`	`setDrillKeepSelectedMember(boolean drillKeepSelectedMember)` Specifies whether the member being drilled on should be retained or removed.
`void`	`setDrillRemoveUnselectedMembers(boolean drillRemoveUnselectedMembers)` Specifies whether to remove all members that are not being drilled on.
`void`	`setEnableKeepRemove(boolean enableKeepRemove)` Specifies whether the Keep Only and Remove Only options are available to the end user in the context menus of both the GridBlox and ChartBlox.
`void`	`setEnableShowHide(boolean enableShowHide)` Specifies whether the Show Only, Show All, and Hide Only options are available to end users in the context menus of both the GridBlox and ChartBlox.
`void`	`setHiddenMembers(Column[] columns)` Hides the specified columns (members).
`void`	`setHiddenMembers(Member[] members)` Hides the members in the specified array.
`void`	`setHiddenMembers(java.lang.String hiddenMembers)` Specifies the members to hide.
`void`	`setHiddenTuples(java.lang.String selectedTuples)` Sets hiddenTuples parameter to the specified selectedTuples it will replace the existing hiddenTuples
`void`	`setInitialProperty(java.lang.String propertyName, java.lang.String propertyValue)`
`void`	`setInternalSortEnabled(boolean enable)` Sets whether or not the internal sort is enabled.
`void`	`setLeafDrillDownAvailable(boolean leafDrillDownAvailable)` Specifies if the user should be allowed to drill down on a leaf member.
`void`	`setMDXForDimensions(java.util.HashMap map)` Sets the MDX set statement for particular dimensions.
`void`	`setMemberNameRemovePrefix(java.lang.String prefix)` Specifies the start point of a member name when returned from the data source.
`void`	`setMemberNameRemoveSuffix(java.lang.String suffix)` Specifies the end point of a member name when returned from the data source.
`void`	`setMergedDimensions(java.lang.String mergedDimensions)` Sets the dimensions to appear "merged" on the Other Axis of the Data Layout panel and in the Dimension Explorer/Member Filter.
`void`	`setMergedHeaders(java.lang.String mergedHeaders)` Specifies the dimensions on the same axis whose headers are to be merged.
`void`	`setOnErrorClearResultSet(boolean clearResultSet)` Specifies whether the existing result set should be cleared if a subsequent database operation fails.
`void`	`setParentFirst(int parentFirst)` Specifies how the parents are returned relative to the children.
`void`	`setPassword(java.lang.String password)` Specifies the database password to use when accessing the data source.
`void`	`setPerformInAllGroups(boolean performInAllGroups)` Specifies whether a drill operation is performed on all occurrences of the selected member in each outer nested group containing the dimension, or only on the single selected occurrence of the member.
`void`	`setProperty(java.lang.String propertyName, java.lang.String propertyValue)`
`void`	`setProvider(java.lang.String provider)` [OLE DB for OLAP only] Sets the provider string to use to access the data source.
`void`	`setQuery(java.lang.String query)` Sets the query.
`void`	`setQueryModel(IQueryModel queryModel)` Sets the query based on an IQueryModel object.
`void`	`setQueryPassthrough(IResultSetHandler passThroughHandler)` For relational data only.
`void`	`setRetainSlicerMemberSet(boolean persistentMemberSelection)` Specifies the persistence of page filter selections after a member is selected.
`void`	`setRowSort(java.lang.String sortString)` Specifies how to sort row members for multidimensional data sources.
`void`	`setRowSort(java.lang.String sortString, java.lang.String[] headerMembers, java.lang.String[] footerMembers)`
`void`	`setRowSort(Tuple tuple, AxisDimension dimension, boolean ascending)` Specifies how to sort row members for multi-dimensional data sources.
`void`	`setRowSort(Tuple tuple, AxisDimension dimension, boolean ascending, boolean preserveHierarchy)` Specifies how to sort row members for multi-dimensional data sources.
`void`	`setRowSort(Tuple tuple, AxisDimension dimension, boolean ascending, boolean preserveHierarchy, TupleMember[] headerMembers, TupleMember[] footerMembers)` Specifies how to sort row members for multi-dimensional data sources.
`void`	`setSchema(java.lang.String schema)` Specifies the data schema to access.
`void`	`setSelectableSlicerDimensions(Dimension[] dimensions)` Sets the data source dimensions that appear on the page axis, acting as filters to the data appearing in the grid.
`void`	`setSelectableSlicerDimensions(java.lang.String selectableSlicerDimensions)` Specifies the dimensions that appear on the page (slicer) axis.
`void`	`setSelectedMembers(Member[] members)` Sets the selected members for the given dimension.
`void`	`setShowShortHierarchyNames(boolean showShortHierarchyNames)` A flag that determines how to generate dimension display names for dimensions with multiple hierarchies.
`void`	`setShowSuppressDataDialog(boolean showDialog)` Specifies if a warning dialog should pop up when the `useOlapDrillOptimization` property is set to `true` and either `suppressMissingColumns` or `suppressMissingRows` is also set to `true`.
`void`	`setSuppressDuplicates(boolean suppressDuplicates)` Specifies whether to remove from the grid those rows or columns containing duplicate header values.
`void`	`setSuppressMissing(boolean suppressMissing)` Deprecated. Use `setSuppressMissingColumns` and/or `setSuppressMissingRows` instead.
`void`	`setSuppressMissingColumns(boolean suppressMissingColumns)` Specifies whether to remove columns containing no data at all from the grid.
`void`	`setSuppressMissingRows(boolean suppressMissingRows)` Specifies whether to remove rows containing no data at all from the grid.
`void`	`setSuppressNoAccess(boolean suppressNoAccess)` Specifies whether to remove from the grid those rows or columns containing data the users cannot access.
`void`	`setSuppressZeros(boolean suppressZero)` Specifies whether to remove from the grid those rows or columns containing all zeros.
`void`	`setTextualQueryEnabled(boolean textualQuery)` When `true`, use the textual query, not the serialized query, when restoring a bookmark.
`void`	`setUseAliases(boolean useAliases)` Specifies whether to use aliases for Hyperion Essbase data sources.
`void`	`setUseOlapDrillOptimization(boolean useOptimization)` Specifies whether drill optimization should be enabled for Microsoft Analysis Services data sources.
`void`	`setUserName(java.lang.String userName)` Sets the user name to use to access the data source.
`void`	`showMembers(Column[] columns)` Shows the previously hidden columns (members) in the specified array.
`void`	`showMembers(Member[] members)` Shows members in the specified array that were previously hidden.
`void`	`showMembers(java.lang.String membersToShow)` Shows the previously hidden members in the specified string.
`void`	`showOnlyTuples(java.lang.String selectedTuples)` Shows only the specified selectedTuples.
`void`	`showOnlyTuples(Tuple[] tuples)` Show only the specified selectedTuples.
`void`	`showTuples(java.lang.String selectedTuples)` Shows or unhides specified selectedTuples if they are hidden.
`void`	`swapRowAndColumnAxes()` Swaps the members on the row axis with the members on the column axes.
`void`	`unlockAll()` Unlocks any data that was previously locked in the Essbase database.
`void`	`updateResultSet()` Applies the properties to the textual or serialized query (depending on which query is most recent) and creates a new result set.
`void`	`writeback(java.lang.Object coordinates, java.lang.Object values, java.lang.String command)` Combines into a single method the actions performed by the lockCurrentDataSet, commitData, setDataValues, unlockAll, executeCustomCalc, and refresh methods.

Methods inherited from class com.alphablox.blox.AbstractBlox

addEventFilter, addEventListener, addPortletLinkDefinition, display, exportToExcel, exportToExcel, getApplicationName, getHeight, getLastAppliedApplicationStateName, getPortletLink, getPortletLinkDefinition, getProperty, getPropertyNames, getRender, getServerContextPath, getWidth, handleReport, init, isReadEnabled, isReadyToSendReport, isReport, isTopLevel, isVisible, isWriteEnabled, removeEventFilter, removeEventListener, removePortletLinkDefinition, render, render, render, renderHtmlHeader, renderHtmlHeader, setHeight, setRender, setVisible, setWidth

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARENT_DEFAULT

public static final int PARENT_DEFAULT

The int representing the default parent orientation flag. For an Essbase datasource, the default is that the parent member comes after the child members. For a Microsoft Analysis Services data source, the default is that the parent member comes before the child members.

See Also:: Constant Field Values

PARENT_FIRST

public static final int PARENT_FIRST

The int representing the parent first orientation flag. The orientation has been explicitly set to parent first.

See Also:: Constant Field Values

PARENT_LAST

public static final int PARENT_LAST

The int representing the parent last orientation flag. The orientation has been explicitly set to parent last.

See Also:: Constant Field Values

Constructor Detail

DataBlox

public DataBlox()

Default constructor

Method Detail

deleteBlox

public void deleteBlox()
                throws ServerBloxException

Overrides:: deleteBlox in class AbstractBlox

Throws:: ServerBloxException

addBookmarkLoadFilter

public void addBookmarkLoadFilter(BookmarkLoadFilter filter)
                           throws ServerBloxException

Deprecated. use addEventFilter()

Add a filter event that will register a class to be called when a bookmark is loaded

Specified by:: addBookmarkLoadFilter in interface BookmarkableBlox

Parameters:: filter - the class to call when the bookmark is loaded
Throws:: ServerBloxException - if there is any problem registering the filter event

removeBookmarkLoadFilter

public void removeBookmarkLoadFilter(BookmarkLoadFilter filter)
                              throws ServerBloxException

Deprecated. use removeEventFilter()

Remove a load filter event

Specified by:: removeBookmarkLoadFilter in interface BookmarkableBlox

Parameters:: filter - the class to remove from this event
Throws:: ServerBloxException - if there is any problem unregistering the filter event

addBookmarkSaveFilter

public void addBookmarkSaveFilter(BookmarkSaveFilter filter)
                           throws ServerBloxException

Deprecated. use addEventFilter()

Add a filter event that will register a class to be called when a bookmark is saved

Specified by:: addBookmarkSaveFilter in interface BookmarkableBlox

Parameters:: filter - the class to call when the bookmark is saved
Throws:: ServerBloxException - if there is any problem registering the filter event

removeBookmarkSaveFilter

public void removeBookmarkSaveFilter(BookmarkSaveFilter filter)
                              throws ServerBloxException

Deprecated. use removeEventFilter()

Remove a save filter event

Specified by:: removeBookmarkSaveFilter in interface BookmarkableBlox

Parameters:: filter - the class to remove from this event
Throws:: ServerBloxException - if there is any problem unregistering the filter event

addBookmarkRenameFilter

public void addBookmarkRenameFilter(BookmarkRenameFilter filter)
                             throws ServerBloxException

Deprecated. use addEventFilter()

Add a filter event that will register a class to be called when a bookmark is renamed

Specified by:: addBookmarkRenameFilter in interface BookmarkableBlox

Parameters:: filter - the class to call when the bookmark is renamed
Throws:: ServerBloxException - if there is any problem registering the filter event

removeBookmarkRenameFilter

public void removeBookmarkRenameFilter(BookmarkRenameFilter filter)
                                throws ServerBloxException

Deprecated. use removeEventFilter()

Remove a rename filter event

Specified by:: removeBookmarkRenameFilter in interface BookmarkableBlox

Parameters:: filter - the class to remove from this event
Throws:: ServerBloxException - if there is any problem unregistering the filter event

addBookmarkDeleteFilter

public void addBookmarkDeleteFilter(BookmarkDeleteFilter filter)
                             throws ServerBloxException

Deprecated. use addEventFilter()

Add a filter event that will register a class to be called when a bookmark is deleted

Specified by:: addBookmarkDeleteFilter in interface BookmarkableBlox

Parameters:: filter - the class to call when the bookmark is deleted
Throws:: ServerBloxException - if there is any problem registering the filter event

removeBookmarkDeleteFilter

public void removeBookmarkDeleteFilter(BookmarkDeleteFilter filter)
                                throws ServerBloxException

Deprecated. use removeEventFilter()

Remove a delete filter event

Specified by:: removeBookmarkDeleteFilter in interface BookmarkableBlox

Parameters:: filter - the class to remove from this event
Throws:: ServerBloxException - if there is any problem unregistering the filter event

getListenerClasses

public java.lang.Class[] getListenerClasses()

Description copied from class: AbstractBlox

Returns the allowable listener classes for this blox

Overrides:: getListenerClasses in class AbstractBlox

Returns:: the list of allowed listener classes for this blox

getFilterClasses

public java.lang.Class[] getFilterClasses()

Description copied from class: AbstractBlox

Returns the allowable filter classes for this blox

Overrides:: getFilterClasses in class AbstractBlox

Returns:: the list of allowed filter classes for this blox

init

public boolean init(BloxContext bloxContext,
                    java.lang.String bloxName)
             throws InvalidParameterException,
                    ServerBloxException

Initializes the DataBlox.

Overrides:: init in class AbstractBlox

Parameters:: bloxContext - the BloxContext in which this blox belongs; bloxName - The name of DataPeer object to bind to.
Returns:: True if the peer was created, False otherwise.
Throws:: InvalidParameterException; ServerBloxException

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.String propertyValue)
                 throws InvalidBloxPropertyNameException,
                        InvalidBloxPropertyValueException,
                        ServerBloxException

Overrides:: setProperty in class AbstractBlox

Throws:: InvalidBloxPropertyNameException; InvalidBloxPropertyValueException; ServerBloxException

setInitialProperty

public void setInitialProperty(java.lang.String propertyName,
                               java.lang.String propertyValue)
                        throws InvalidBloxPropertyNameException,
                               InvalidBloxPropertyValueException,
                               ServerBloxException

Overrides:: setInitialProperty in class AbstractBlox

Throws:: InvalidBloxPropertyNameException; InvalidBloxPropertyValueException; ServerBloxException

isTextualQueryEnabled

public boolean isTextualQueryEnabled()
                              throws ServerBloxException

Identifies if the textual query rather than the serialized object should be used to restore a bookmark.

Returns:: true if query should be saved as a text string.
Throws:: ServerBloxException
See Also:: setTextualQueryEnabled(boolean)

isApplyPropertiesAfterBookmark

public boolean isApplyPropertiesAfterBookmark()
                                       throws ServerBloxException

Identifies whether, after retrieving a bookmark, the Blox properties should override those in the bookmark.

Returns:: true if Blox properties should override those in the bookmark; false otherwise.
Throws:: ServerBloxException
See Also:: setApplyPropertiesAfterBookmark(boolean)

getDataSourceName

public java.lang.String getDataSourceName()
                                   throws ServerBloxException

Gets the name of the data source.

Throws:: ServerBloxException
See Also:: setDataSourceName(String)

getCatalog

public java.lang.String getCatalog()
                            throws ServerBloxException

Gets the name of the database catalog.

Throws:: ServerBloxException
See Also:: setCatalog(String)

getSchema

public java.lang.String getSchema()
                           throws ServerBloxException

Gets the name of the database schema.

Throws:: ServerBloxException
See Also:: setSchema(String)

getUserName

public java.lang.String getUserName()
                             throws ServerBloxException

Gets the database user name used to access the data source.

Returns:: String database user name used to access the data source
Throws:: ServerBloxException
See Also:: setUserName(String)

isAASUserAuthorizationEnabled

public boolean isAASUserAuthorizationEnabled()
                                      throws ServerBloxException

Identifies if the username and password entered during Alphablox login for authentication should be used to access an Essbase data source

Returns:: true if Alphablox login username and password should be used to access an Essbase data source. The default is false.
Throws:: ServerBloxException

getQuery

public java.lang.String getQuery()
                          throws ServerBloxException

Gets the data query.

Returns:: String data query
Throws:: ServerBloxException

getSelectableSlicerDimensions

public Dimension getSelectableSlicerDimensions(int i)
                                        throws ServerBloxException,
                                               java.lang.ArrayIndexOutOfBoundsException

Returns the ith dimension on the page axis in the PageBlox. If metaData in this DataBlox is null, new copies of the dimension will be created. This method is relevant for multi-dimensional data sources only.

Parameters:: i - The index of the specified dimension on the page axis.
Returns:: The ith dimension on the page axis.
Throws:: ServerBloxException - When unable to connect to the database, when the metadata is corrupted, or when the connection has gone bad.; java.lang.ArrayIndexOutOfBoundsException - When the index is negative, or greater than or equal to the total number of dimensions on the page axis.

getSelectableSlicerDimensions

public Dimension[] getSelectableSlicerDimensions()
                                          throws ServerBloxException

Returns an array containing the dimensions that appear on the page axis in the PageBlox. If metaData in this DataBlox is null, new copies of dimension will be created. This method is relevant for multi-dimensional data sources only.

Returns:: An array of dimensions.
Throws:: ServerBloxException - When unable to connect to the database, when the metadata is corrupted, or when the connection has gone bad.

getMergedDimensions

public java.lang.String getMergedDimensions()
                                     throws ServerBloxException

Returns a comma-delimited String representing the names of the "logical" dimensions to merge in the Other Axis of the DataLayoutPanel. This method is relevant for multi-dimensional OLAP data sources which support multiple hierarchies only.

Returns:: A comma-delimited String representing the names of the "logical" dimensions to merge in the Other Axis of the DataLayoutPanel.
Throws:: ServerBloxException - When unable to connect to the database, when the metadata is corrupted, or when the connection has gone bad.

isOnErrorClearResultSet

public boolean isOnErrorClearResultSet()
                                throws ServerBloxException

Identifies whether the existing result set should be cleared if a subsequent database operation fails

Returns:: true if the existing result set should be cleared. The default is false.
Throws:: ServerBloxException
See Also:: setOnErrorClearResultSet(boolean)

getDrillDownOption

public int getDrillDownOption()
                       throws ServerBloxException

Specifies the type of drill operation to perform.

Returns:

an int from 1 to 5. The default is 1.

1 - Drill down to next generation
2 - Drill down to all descendants (same as an expand all operation)
3 - Drill down to bottom generation
4 - Drill to siblings
5 - Drill to same generation

Throws:

ServerBloxException

isDrillKeepSelectedMember

public boolean isDrillKeepSelectedMember()
                                  throws ServerBloxException

Identifies whether the member being drilled on should be retained or removed.

Returns:: true to retain the member being drilled on; false otherwise.
Throws:: ServerBloxException
See Also:: setDrillKeepSelectedMember(boolean)

isDrillRemoveUnselectedMembers

public boolean isDrillRemoveUnselectedMembers()
                                       throws ServerBloxException

Identifies whether to remove all members that are not being drilled on.

Returns:: true if all other members should be removed; false otherwise.
Throws:: ServerBloxException
See Also:: setDrillRemoveUnselectedMembers(boolean)

isPerformInAllGroups

public boolean isPerformInAllGroups()
                             throws ServerBloxException

Identifies whether a drill operation is performed on all occurrences of the selected member in each outer nested group containing the dimension, or only on the single selected occurrence of the member.

Returns:: true to perform the drill operation in all groups; false to perform the drill operation only on the single selected occurrence of this member. The default is true.
Throws:: ServerBloxException

isUseAliases

public boolean isUseAliases()
                     throws ServerBloxException

Identifies if aliases are used for the Essbase data source in use

Returns:: true if aliases are used.
Throws:: ServerBloxException
See Also:: setUseAliases(boolean)

getAliasTable

public java.lang.String getAliasTable()
                               throws ServerBloxException

Identifies the aliase table used for the current Essbase data source

Returns:: a string of the aliase table name
Throws:: ServerBloxException
See Also:: setAliasTable(String)

getMemberNameRemoveSuffix

public java.lang.String getMemberNameRemoveSuffix()
                                           throws ServerBloxException

Identifies the end point of a member name when returned from the data source.

Returns:: String end point of a member name when returned from the data source
Throws:: ServerBloxException
See Also:: setMemberNameRemoveSuffix(String)

getMemberNameRemovePrefix

public java.lang.String getMemberNameRemovePrefix()
                                           throws ServerBloxException

Identifies the start point of a member name when returned from the data source.

Returns:: String start point of a member name when returned from the data source
Throws:: ServerBloxException
See Also:: setMemberNameRemovePrefix(String)

isSuppressMissingRows

public boolean isSuppressMissingRows()
                              throws ServerBloxException

Identifies whether rows containing no data at all should be removed from the grid.

Returns:: true to remove rows that have no data; false otherwise. Default is false.
Throws:: ServerBloxException
See Also:: setSuppressMissingRows(boolean)

isSuppressMissingColumns

public boolean isSuppressMissingColumns()
                                 throws ServerBloxException

Identifies whether columns containing no data at all should be removed from the grid.

Returns:: true to remove columns that have no data; false otherwise. Default is false.
Throws:: ServerBloxException
See Also:: setSuppressMissingColumns(boolean)

isSuppressMissing

public boolean isSuppressMissing()
                          throws ServerBloxException

Throws:: ServerBloxException

isSuppressNoAccess

public boolean isSuppressNoAccess()
                           throws ServerBloxException

Identifies whether to remove from the grid those rows or columns containing data the users cannot access.

Returns:: true if data the users cannot access is suppressed; false otherwise.
Throws:: ServerBloxException
See Also:: setSuppressNoAccess(boolean)

isSuppressZeros

public boolean isSuppressZeros()
                        throws ServerBloxException

Identifies whether to remove from the grid those rows or columns containing all zeros.

Returns:: true if data columns or rows containing all zeross are suppressed; false otherwise.
Throws:: ServerBloxException
See Also:: setSuppressZeros(boolean)

isSuppressDuplicates

public boolean isSuppressDuplicates()
                             throws ServerBloxException

Identifies whether to remove from the grid those rows or columns containing duplicate header values.

Returns:: true if data columns or rows containing duplicate header values are suppressed; false otherwise. Default is true.
Throws:: ServerBloxException
See Also:: setSuppressDuplicates(boolean)

getCalculatedMembers

public java.lang.String getCalculatedMembers()
                                      throws ServerBloxException

Gets the string that generates the calculated members

Returns:: the String that generates the calculated members
Throws:: ServerBloxException

getMergedHeaders

public java.lang.String getMergedHeaders()
                                  throws ServerBloxException

Gets a string of the dimensions on the same axis whose headers are merged.

Returns:: a colon-separated string of dimensionString:matchPatterns:drillableDim. See setMergedHeaders(String) for details.
Throws:: ServerBloxException
See Also:: setMergedHeaders(String)

getBookmarkFilter

public java.lang.String getBookmarkFilter()
                                   throws ServerBloxException

Returns the default location from which to store and load bookmarks.

Returns:

a string containing the subdirectory name (a subdirectory under the Alphablox repository, or a comma-separated string in the following format:

 subDirectory, name=BloxID, application=AppContext, user=UserName

Throws:

ServerBloxException

See Also:

setBookmarkFilter(String)

getParentFirst

public int getParentFirst()
                   throws ServerBloxException

Returns an int value representing the parent first setting, either default, parent first or parent last. The value will be one of three values:
DataBlox.PARENT_DEFAULT
DataBlox.PARENT_FIRST
Datablox.PARENT_LAST

Returns:: An int representing the orientation of the parent members in relation to the child members.
Throws:: ServerBloxException

getRowSort

public java.lang.String getRowSort()
                            throws ServerBloxException

Identifies row members for multidimensional data sources are sorted.

Returns:: String of 4 comma-separated items, consisting of tupleIndex, groupingNestLevel, direction, and preserveHierarchy. See the setRowSort method for details.
Throws:: ServerBloxException

getColumnSort

public java.lang.String getColumnSort()
                               throws ServerBloxException

Identifies how to sort data values for members on the column axis.

Returns:: a String of 4 comma-separated items consisting of tupleIndex, groupingNestLevel, direction, and preserveHierarchy. See setColumnSort for details.
Throws:: ServerBloxException

getDimensionRoot

public java.lang.String getDimensionRoot()
                                  throws ServerBloxException

Identifies the dimension and one or more members used as the root.

Returns:

A String consisting of the dimensions and their new root members. The String is in the form:


 DimA:NewRootMemberA1,NewRootMemberA2;DimB:NewRootMemberB1,NewRootMemeberB2;...

Note:If you specify a dimension without new root members, the dimension root is reset to the database default root member for that dimension.

Throws:

ServerBloxException

getDimensionRoot

public Member[] getDimensionRoot(Dimension dimension)
                          throws ServerBloxException

Returns an array of members used as the root members for the specified dimension. It is possible with the setDimensionRoot method to set the desired dimension root. When the specified dimension appears in a page filter or in the Dimension Explorer, the specified root members act as the roots of the dimension. This method is relevant for multi-dimensional data source only.

Parameters:: dimension - The dimension containing the desired root members.
Returns:: An array of members representing the roots of the specified dimension.
Throws:: ServerBloxException - When the connection has gone bad, when the specified dimension is invalid, or when unable to create the root member array.

isEnableKeepRemove

public boolean isEnableKeepRemove()
                           throws ServerBloxException

Identifies whether the Keep Only and Remove Only options are available to the end user in the context menus of both the GridBlox and ChartBlox.

Returns:: true to enalbe the Keep Only and Remove Only options in the context menu; false to disable them. Default is true.
Throws:: ServerBloxException

isEnableShowHide

public boolean isEnableShowHide()
                         throws ServerBloxException

Identifies whether the Show Only, Show All, and Hide Only options are available to end users in the context menus of both the GridBlox and ChartBlox.

Returns:: true if the Show Only, Show All, and Hide Only options are enabled; false if not. Default is true.
Throws:: ServerBloxException

isLeafDrillDownAvailable

public boolean isLeafDrillDownAvailable()
                                 throws ServerBloxException

Identifies if the user should be allowed to drill down on a leaf member.

Returns:: true or false
Throws:: ServerBloxException
See Also:: setLeafDrillDownAvailable(boolean)

getHiddenMembers

public java.lang.String getHiddenMembers()
                                  throws ServerBloxException

Gets the hidden members.

Returns:

A string in the following format:


 DimensionName1:MemberNameA,MemberNameB;

 DimensionName2:MemberNameC,MemberNameD;

 ...                                    

 DimensionNameN:MemberNameX,MemberNameY

Throws:

ServerBloxException

getHiddenTuples

public java.lang.String getHiddenTuples()
                                 throws ServerBloxException

Gets the current hiddenTuples

Returns:

The hidden tuple list is in the form of the following example:

{Year,Product:Qtr3,Audio;Qtr4,Visual}, {Accounts, Market:Profit,East}

Each tuple list contains the dimension names separated by commas, followed by a colon, followed by the list of tuples. Each member of the tuple is separated by a comma and each tuple is separated by a semi-colon

Throws:

ServerBloxException

isAutoConnect

public boolean isAutoConnect()
                      throws ServerBloxException

Identifies if the DataBlox is allowed to connect to the database automatically whenever it needs database access.

Throws:: ServerBloxException
See Also:: setAutoConnect(boolean)

isAutoDisconnect

public boolean isAutoDisconnect()
                         throws ServerBloxException

Identifies if the DataBlox is allowed to disconnect from the database automatically whenever a data access operation is complete.

Throws:: ServerBloxException
See Also:: setAutoDisconnect(boolean)

isConnectOnStartup

public boolean isConnectOnStartup()
                           throws ServerBloxException

Identifies if the DataBlox will automatically connect to its data source upon Blox instantiation. See setConnectOnStartup for more information.

Returns:: true if the DataBlox automatically connects to the data source when it is instantiated; false if not.
Throws:: ServerBloxException
See Also:: setConnectOnStartup(boolean)

isUseOlapDrillOptimization

public boolean isUseOlapDrillOptimization()
                                   throws ServerBloxException

Identifies if drill optimization is enabled for Microsoft Analysis Services data sources.

Returns:: true when query optimization is turned on
Throws:: ServerBloxException
See Also:: setUseOlapDrillOptimization(boolean)

isShowSuppressDataDialog

public boolean isShowSuppressDataDialog()
                                 throws ServerBloxException

Identifies if a warning dialog should pop up when the useOlapDrillOptimization property is set to true and either suppressMissingColumns or suppressMissingRows is also set to true.

Returns:: true to pop up an alert dialog; false to suppress the pop-up dialog.
Throws:: ServerBloxException
See Also:: setShowSuppressDataDialog(boolean), setUseOlapDrillOptimization(boolean), setSuppressMissingColumns(boolean), setSuppressMissingRows(boolean)

isRetainSlicerMemberSet

public boolean isRetainSlicerMemberSet()
                                throws ServerBloxException

Return the persistence of page filter selections after a member is selected. When true (default), the page filter selections will not change when a the filter is changed. When false, the page filters will show the children of the selected member as the page filter selections. Neither of these settings affect how the selected page filter is applied. They only affect the selections in the page filter available after the page filter is applied.

Returns:: boolean true if page filter selections are persistent after selection
Throws:: ServerBloxException

getProvider

public java.lang.String getProvider()
                             throws ServerBloxException

[OLE DB for OLAP datasource only] Return the OLE DB for OLAP provider string

Returns:: a String representing the provider value for this DataBlox's connection
Throws:: ServerBloxException

isInternalSortEnabled

public boolean isInternalSortEnabled()
                              throws ServerBloxException

Gets whether or not the internal sort is enabled. If the sort is disabled then the UI will still show a sort, but no sort will acutally be performed.

Returns:: boolean
Throws:: ServerBloxException

isShowShortHierarchyNames

public boolean isShowShortHierarchyNames()
                                  throws ServerBloxException

A flag that determines how to generate dimension display names for dimensions with multiple hierarchies.

Returns:: A false value will generate the usual "dimension (hierarchy)" format. A true value will set the format to be "hierarchy".
Throws:: ServerBloxException

setRetainSlicerMemberSet

public void setRetainSlicerMemberSet(boolean persistentMemberSelection)
                              throws InvalidBloxPropertyValueException,
                                     ServerBloxException

Specifies the persistence of page filter selections after a member is selected. When true (default), the page filter selections will not change when a the filter is changed. When false, the page filters will show the children of the selected member as the page filter selections. Neither of these settings affect how the selected page filter is applied. They only affect the selections in the page filter available after the page filter is applied.

Parameters:: persistentMemberSelection - true if page filter selections should be persistent
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setTextualQueryEnabled

public void setTextualQueryEnabled(boolean textualQuery)
                            throws InvalidBloxPropertyValueException,
                                   ServerBloxException

When true, use the textual query, not the serialized query, when restoring a bookmark. This allows the deveoloper to save textual queries to the bookmark and restore them without using the serialized version.

Parameters:: textualQuery -
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setApplyPropertiesAfterBookmark

public void setApplyPropertiesAfterBookmark(boolean applyPropertiesAfterBookmark)
                                     throws InvalidBloxPropertyValueException,
                                            ServerBloxException

Specifies whether, after retrieving a bookmark, the Blox properties should override those in the bookmark. The DataBlox dataSourceName property ignores the applyPropertiesAfterBookmark() setting. If data source A is currently used by a PresentBlox on a page and the user loads a bookmark that was saved on data source B, data source B will be used and loaded even if applyPropertiesAfterBookmark is set to true.

Parameters:: applyPropertiesAfterBookmark - true to have Blox properties override those in the bookmark. The default is false.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setDataSourceName

public void setDataSourceName(java.lang.String dataSourceName)
                       throws InvalidBloxPropertyValueException,
                              ServerBloxException

The data source name must be defined in Alphablox. If a data source is not specified, the Blox loads with no initial data source. This feature enables the data source to be set programmatically, perhaps based on user properties or actions. However, to prevent an error message appearing to the user, be sure to set the value of the autoConnect property to false.

This method also reads in the properties of the data source such as username, password, catalog, schema, query, and dimensions on page axis. Therefore, if you want to set any of these properties using the Java methods such as setUserName and setPassword, set them after the setDataSourceName() method. The order these data source properties are set is not an issue if you use the Blox tags. The tags are designed to enforce that the data source is set before the call to set the other data source properties, the side effect is taken care for you.

Parameters:: dataSourceName - name of the data source
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setCatalog

public void setCatalog(java.lang.String catalog)
                throws InvalidBloxPropertyValueException,
                       ServerBloxException

Specifies the data catalog.

Parameters:: catalog - Name of the data catalog
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setSchema

public void setSchema(java.lang.String schema)
               throws InvalidBloxPropertyValueException,
                      ServerBloxException

Specifies the data schema to access. The value for schema is one of the values provided when defining a data source to Alphablox. If you do not specify the schema property for a DataBlox, the value is taken from the data source definition. A schema is a "database" in Essbase terminology.

Parameters:: schema - Name of the schema
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setUserName

public void setUserName(java.lang.String userName)
                 throws InvalidBloxPropertyValueException,
                        ServerBloxException

Sets the user name to use to access the data source.

The default user name is specified when defining the data source to Alphablox. If the userName property is not specified for a DataBlox, the value is taken from the data source definition.

If you use this method in conjunction with setDataSourceName method, you should set the user name after calling setDataSourceName(). Otherwise, the DataBlox will connect with all the properties in the data source specified and override any properties set earlier. This is because the setDataSourceName() method also reads in the properties of the data source such as username, password, catalog, schema, query, and dimensions on page axis. The order these data source properties are set is not an issue if you use the Blox tags. The tags are designed to enforce that the data source is set before the call to set the other data source properties, the side effect is taken care for you.

Parameters:: userName - the username to use to access the data source. Default is the username specified when defining the data source to Alphablox.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setProvider

public void setProvider(java.lang.String provider)
                 throws InvalidBloxPropertyValueException,
                        ServerBloxException

[OLE DB for OLAP only] Sets the provider string to use to access the data source.

The default provider string is specified when defining the data source to Alphablox. If the provider property is not specified for a DataBlox, the value is taken from the data source definition.

If you use this method in conjunction with setDataSourceName method, you should set the provider string after calling setDataSourceName(). Otherwise, the DataBlox will connect with all the properties in the data source specified and override any properties set earlier. This is because the setDataSourceName() method also reads in the properties of the data source such as username, password, catalog, schema, query, and dimensions on page axis. The order these data source properties are set is not an issue if you use the Blox tags. The tags are designed to enforce that the data source is set before the call to set the other data source properties, the side effect is taken care for you.

Parameters:: provider - the provider string to use to access the data source. Default is the provider specified when defining the data source to Alphablox.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setInternalSortEnabled

public void setInternalSortEnabled(boolean enable)
                            throws InvalidBloxPropertyValueException,
                                   ServerBloxException

Sets whether or not the internal sort is enabled. If the sort is disabled then the UI will still show a sort, but no sort will acutally be performed.

Parameters:: enable -
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setAASUserAuthorizationEnabled

public void setAASUserAuthorizationEnabled(boolean useAASUserAuthorization)
                                    throws InvalidBloxPropertyValueException,
                                           ServerBloxException

Specifies whether to use the username and password entered during Alphablox login for authentication to an Essbase data source.

Parameters:: useAASUserAuthorization - true to use the Alphablox login information for Essbase authentication; false to use the normal authentication process
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setPassword

public void setPassword(java.lang.String password)
                 throws InvalidBloxPropertyValueException,
                        ServerBloxException

Specifies the database password to use when accessing the data source.

Parameters:: password - the password to use
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setQuery

public void setQuery(java.lang.String query)
              throws InvalidBloxPropertyValueException,
                     ServerBloxException

Sets the query. To execute the query call updateResultSet() or connect().

Parameters:: query - The query to be executed.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setQueryModel

public void setQueryModel(IQueryModel queryModel)
                   throws InvalidBloxPropertyValueException,
                          ServerBloxException

Sets the query based on an IQueryModel object. From the IQueryModel object Alphablox generates the query as a textual string and calls DataBlox.setQuery(String query).

If the IQueryModel object is an IMDXQueryModel object, then Alphablox will use dimension expressions (IMDXDimensionExpression objects) from the IMDXQueryModel to optimize MDX queries generated in the future.

To execute the query call updateResultSet() or connect().

Parameters:: queryModel - An IQueryModel object that contains the query as a data structure.
Throws:: InvalidBloxPropertyValueException; ServerBloxException
See Also:: setUseOlapDrillOptimization(boolean useOptimization)

setSelectableSlicerDimensions

public void setSelectableSlicerDimensions(java.lang.String selectableSlicerDimensions)
                                   throws InvalidBloxPropertyValueException,
                                          ServerBloxException

Specifies the dimensions that appear on the page (slicer) axis. The slicer dimensions act as filters on the data.

Parameters:: selectableSlicerDimensions - a comma-separated string of unique dimension names.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setMergedDimensions

public void setMergedDimensions(java.lang.String mergedDimensions)
                         throws ServerBloxException

Sets the dimensions to appear "merged" on the Other Axis of the Data Layout panel and in the Dimension Explorer/Member Filter. For example, if your cube has the following multiple hierarchies: [Time].[Fiscal], [Time].[Calendar], [Products].[Type] and [Products].[Seasonality]. Instead of having all four dimensions appear as selectable options in the Other Axis of the Data Layout panel, the call setMergedDimensions("[Time],[Products]") will cause the Data Layout panel to display only two selectable dimension options (Time and Products) on the Data Layout panel. This method is relevant for multidimensional OLAP data sources which support multiple hierarchies only.

Parameters:: mergedDimensions - the dimensions to be "merged." The dimension names should be comma-delimited.
Throws:: ServerBloxException

setSelectableSlicerDimensions

public void setSelectableSlicerDimensions(Dimension[] dimensions)
                                   throws ServerBloxException

Sets the data source dimensions that appear on the page axis, acting as filters to the data appearing in the grid. The call setSelectableSlicerDimension has no effect on dimensions that already reside on the row or column axis. It can only operate on dimensions that currently on the "Other" (unused) axis. This method is relevant for multi-dimensional data sources only.

Parameters:: dimensions - The dimensions to appear on the page axis.
Throws:: ServerBloxException - When a runtime error occurs.

setOnErrorClearResultSet

public void setOnErrorClearResultSet(boolean clearResultSet)
                              throws InvalidBloxPropertyValueException,
                                     ServerBloxException

Specifies whether the existing result set should be cleared if a subsequent database operation fails.

Parameters:: clearResultSet - true to clear the existing result set. The default is false.
Throws:: ServerBloxException; InvalidBloxPropertyValueException
See Also:: isOnErrorClearResultSet()

setDrillDownOption

public void setDrillDownOption(int drillDownOption)
                        throws InvalidBloxPropertyValueException,
                               ServerBloxException

Specifies the type of drill operation to perform.

Parameters:

drillDownOption - an integer from 1 to 5 specifying the level to drill down to. Possible values are:

1 - Drill down to next generation. The default.
2 - Drill down to all descendants (same as an expand all operation)
3 - Drill down to bottom generation
4 - Drill to siblings
5 - Drill to same generation

Throws:

InvalidBloxPropertyValueException

ServerBloxException

setDrillKeepSelectedMember

public void setDrillKeepSelectedMember(boolean drillKeepSelectedMember)
                                throws InvalidBloxPropertyValueException,
                                       ServerBloxException

Specifies whether the member being drilled on should be retained or removed.

Parameters:: drillKeepSelectedMember - true to retain the member being drilled on; false otherwise. The default is true.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setDrillRemoveUnselectedMembers

public void setDrillRemoveUnselectedMembers(boolean drillRemoveUnselectedMembers)
                                     throws InvalidBloxPropertyValueException,
                                            ServerBloxException

Specifies whether to remove all members that are not being drilled on.

Parameters:: drillRemoveUnselectedMembers - true if all other members should be removed; false otherwise. The default is false.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setPerformInAllGroups

public void setPerformInAllGroups(boolean performInAllGroups)
                           throws InvalidBloxPropertyValueException,
                                  ServerBloxException

Specifies whether a drill operation is performed on all occurrences of the selected member in each outer nested group containing the dimension, or only on the single selected occurrence of the member.

Parameters:: performInAllGroups - true to perform the drill operation in all groups; false to perform the drill operation only on the single selected occurrence of this member. The default is true.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setUseAliases

public void setUseAliases(boolean useAliases)
                   throws InvalidBloxPropertyValueException,
                          ServerBloxException

Specifies whether to use aliases for Hyperion Essbase data sources.

Parameters:: useAliases - true to use aliases. Default is false.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setAliasTable

public void setAliasTable(java.lang.String aliasTable)
                   throws InvalidBloxPropertyValueException,
                          ServerBloxException

Specifies the Hyperion Essbase alias table to use with the data source. If no aliasTable property is specified on a DataBlox and the useAliases property is set to true, the value is taken from the corresponding data source definition, if the value is present.

Parameters:: aliasTable - the name of an alias table
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setCredential

public void setCredential(java.lang.Object credential)
                   throws InvalidBloxPropertyValueException,
                          ServerBloxException

Specifies a credential object to be used with the given datasource instead of a username and password. If the credential is set to anything but null, any username and password settings will be ignored. This property will not be saved with any bookmark.

Parameters:: credential - The credential object to send to the datasource. Consult the documentation of the database for the given datasource to see the actual type of object required for the credential.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setMemberNameRemoveSuffix

public void setMemberNameRemoveSuffix(java.lang.String suffix)
                               throws InvalidBloxPropertyValueException,
                                      ServerBloxException

Specifies the end point of a member name when returned from the data source.

This method only affects the result set, not the metadata. That is, subsequent metadata calls to get the display name of a member will still include the suffix.

This property is of particular use with Essbase data sources where member names must be unique. Unique names are often created by adding unique strings as suffixes or prefixes on member names. Using this property enables stripping off the suffix strings before displaying the member names. The removal can only be applied to member names; it cannot be applied to dimension names. Additionally, properties and methods that take member names as arguments will use the unique member name prior to the prefix or suffix removal.

For example, if a member has a name of "123##Year", with setMemberNameRemoveSuffix("##"), the returned member name becomes "123".

Parameters:: suffix - the text indicating the end point of a member name
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setMemberNameRemovePrefix

public void setMemberNameRemovePrefix(java.lang.String prefix)
                               throws InvalidBloxPropertyValueException,
                                      ServerBloxException

Specifies the start point of a member name when returned from the data source.

This method removes the text from a member name string returned from a data source beginning with and including the specified string.

This method only affects the result set, not the metadata. That is, subsequent metadata calls to get the display name of a member will still include the prefix. This property is of particular use with Essbase data sources where member names must be unique. Unique names are often created by adding unique strings as suffixes or prefixes on member names. Using this property enables stripping off the prefix strings before displaying the member names. The removal can only be applied to member names; it cannot be applied to dimension names. Additionally, properties and methods that take member names as arguments will use the unique member name prior to the prefix or suffix removal.

For example, if a member has a name of "123##Year", with setMemberNameRemovePrefix("##"), the returned member name becomes "Year".

Parameters:: prefix - the text indicating the starting point of a member name
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setSuppressMissing

public void setSuppressMissing(boolean suppressMissing)
                        throws InvalidBloxPropertyValueException,
                               ServerBloxException

Deprecated. Use setSuppressMissingColumns and/or setSuppressMissingRows instead.

Throws:: InvalidBloxPropertyValueException; ServerBloxException

setSuppressMissingRows

public void setSuppressMissingRows(boolean suppressMissingRows)
                            throws InvalidBloxPropertyValueException,
                                   ServerBloxException

Specifies whether to remove rows containing no data at all from the grid.

Use the setMissingValueString() method on GridBlox to specify what to display in cells with no value.

When the data source is Microsoft Analysis Services, this method should be used with care in conjunction with the setUseOlapDrillOptimization()method. When both are set to true, users may only see partial data when they drill down and then perform other actions such as changing page filters, drilling up, or using Dimension Explorer/Member Filter. See setUserOlapDrillOptimization for more information.

To suppress duplicate shared members in Essbase result sets, use the SUPSHARE command in your report script query. To learn more about this command, refer to your Essbase documentation.

Parameters:: suppressMissingRows - true to remove rows that have no data; false otherwise. Default is false.
Throws:: InvalidBloxPropertyValueException; ServerBloxException
See Also:: setUseOlapDrillOptimization(boolean)

setSuppressMissingColumns

public void setSuppressMissingColumns(boolean suppressMissingColumns)
                               throws InvalidBloxPropertyValueException,
                                      ServerBloxException

Specifies whether to remove columns containing no data at all from the grid.

Use the setMissingValueString() method on GridBlox to specify what to display in cells with no value.

When the data source is Microsoft Analysis Services, this method should be used with care in conjunction with the setUseOlapDrillOptimization()method. When both are set to true, users may only see partial data when they drill down and then perform other actions such as changing page filters, drilling up, or using the Member Filter. See setUserOlapDrillOptimization for more information.

To suppress duplicate shared members in Essbase result sets, use the SUPSHARE command in your report script query. To learn more about this command, refer to your Essbase documentation.

Parameters:: suppressMissingColumns - true to remove columns that have no data; false otherwise. Default is false.
Throws:: InvalidBloxPropertyValueException; ServerBloxException
See Also:: setUseOlapDrillOptimization(boolean)

setSuppressNoAccess

public void setSuppressNoAccess(boolean suppressNoAccess)
                         throws InvalidBloxPropertyValueException,
                                ServerBloxException

Specifies whether to remove from the grid those rows or columns containing data the users cannot access.

To suppress duplicate shared members in Essbase result sets, use the SUPSHARE command in your report script query. To learn more about this command, refer to your Essbase documentation.

Parameters:: suppressNoAccess - true to suppress data the users cannot access; false to leave it. Default is false.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setSuppressZeros

public void setSuppressZeros(boolean suppressZero)
                      throws InvalidBloxPropertyValueException,
                             ServerBloxException

Specifies whether to remove from the grid those rows or columns containing all zeros.

Parameters:: suppressZero - true to suppress data columns or rows containing all zeross; false to leave them. Default is false.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setSuppressDuplicates

public void setSuppressDuplicates(boolean suppressDuplicates)
                           throws InvalidBloxPropertyValueException,
                                  ServerBloxException

Specifies whether to remove from the grid those rows or columns containing duplicate header values.

Parameters:: suppressDuplicates - true to suppress data columns or rows containing duplicate header values; false to leave them. Default is true.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setCalculatedMembers

public void setCalculatedMembers(java.lang.String calculatedMembers)
                          throws InvalidBloxPropertyValueException,
                                 ServerBloxException

Specifies one or more new members to be calculated by Alphablox using the result set retrieved from the data source. Members used in calculation have to exist in the result set or the calculated member will not show.

The string is a comma-delimited list of one or more calculated member definitions. Specify each definition as shown below:

dim:calc{refMember:gen:missingIsZero:drillDownMember:drillUpMember}=
 expression{scopeDim:scopeMember}

where:

definition string Component	Description
`dim`	The name of the dimension on which to create a calculated member. If you are merging headers using the `mergedHeaders` property, you should still use the original dimension name rather than the merged dimension header since `calculatedMembers` is performed before the dimension headers are merged.
`calc`	The name of calculated member. The name could be the same as an existing member or dimension name since a calculated member has an internal unique name in the form `ABXCalc_`dimName`_` calc`.` For example, if a "Total" calculated member is added to the Product dimension, it has a unique name of ABXCalc_Product_Total. This is used internally and the only time it is displayed to the user is when the user turns on unique names in the Dimension Explorer. It never shows in the grid, even when the use aliases data option is turned off.
`refMember`	The name of an existing member, including other calculated members, before which this calculated member is to be placed. Specify the reference member is optional. You must place double quotes around member names that contain special characters. For example: calculatedMembers="Product:\"Profit %\"{missingIsZero} = Gross Margin/Sales100" The calculated member calc* will be placed before refMember in the grid. If you do not specify a reference member, the calculated member calc will be placed in the last row or column. If the user drills on or hides the reference member, the calculated member retains its position. However, if the user removes the reference member, the calculated member moves to the last row or column.
`gen`	The generation number of the calculated member. Specifying a generation number is optional. Generation can be defined as either absolute or relative to the `refMember`, and it determines the indentation of the calculated member on the axis. The default generation number is 1. To specify absolute generation, define gen as a positive integer. A colon is required before the generation number even if there is no reference member defined. To specify relative generation, define gen as a + (plus) or - (minus) operator followed by an integer. The calculated member's generation will be the reference member's generation number plus or minus the integer defined in `gen`. A reference member must be defined in order to use relative generation, and the two must be separated by a colon.
`missingIsZero`	Optional keyword (case-insensitive) to use if you want all missing values for members involved in the calculation to be treated as zero. By default, all missing values in the calculation are treated as missing. To change the default behavior, use this special keyword. The following example will treat all missing values in Product1, Product2, and Product3 as zero. Product:Total Sales{missingIsZero} = Product1 + Product2 + Product3 This keyword only affects calculations using member variables. It has no effect on calculation functions.
`drillDownMember`	Optional. The real member to drill down when users try to drill down on this calculated member.
`drillUpMember`	Optional. The real member to drill up when users try to drill up from this calculated member. For example: Year:Total{:::Qtr3:Jul} = sum() This would drill down on Qtr3 and drill up on Jul from the calculated member "Total". Notice that when the optional refMember, gen, and `MissingIsZero` are not specified inside the curly braces, you should include the colons so the drillDownMember will not be taken as the refMember.
`expression`	The arithmetic expression involving members of dim or values from other dimensions. For example, `calculatedMembers="All Products:Products 1 and 2 = Product1 + Product2"` adds a calculated member called "Products 1 and 2" in the "All Products" dimension. This expression involves only members from the same dimension where the calculated member is added. If the calculation involves values from the intersection of multiple dimensions, you should specify the dimension where each member is from by separating the dimension and member name with a colon, and then separate each dimesnion:memberpair with a semi-colon: dim1:member1;dim2:member2;...;dimN:memberN where: at least one dimension is from the row axis at least one dimension is from the column axis for each semi-colon delimited dimension:member pair, the dimension name has to be supplied, followed by a colon and the member of that dimension In the following example, a calculated member "Percentage of Total" is added to the All Products dimension with values from the intersection of All Products and All Locations as dividers: `calculatedMembers="All Products: Percentage of Total= All Products / All Locations:All Locations; All Products:All Products` For functions supported in calculations, see the DataBlox Section in the Developer's Referencefor a detailed listing and description.
`scopeDim: scopeMember`	Defines the dimension and members for which the calculated member is displayed. Additional scope members are separated by commas. Additional pairs are divided within the braces by a semicolon. Specifying a scope is optional. Member names that contain special characters should be enclosed in double quotes (note that you need to escape inner double quotes). When a scope is defined, the calculated member appears only for the members specified in the scope. However, if the calculated member and a scope member are on different axes, intersecting cells that do not fall in the scope are still drawn. Their value is determined by the `missingValueString` GridBlox property. If no scope is defined, the calculated member is displayed wherever the members involved in the expression appear. Four member search functions are available for specifying the level of members the calculated member should be displayed for: `Leaf()`: the leaf-level descendants of the specified member. Example: {`Market: leaf(East)}` `Child()`: the children of the specified member. Example: `{Market: child(East)}` `Gen()`: all members of the specified generation. Example: `{Market: gen(2)}` `Not()`: members to which the calculation should not be applied. Example: {`Market: not(East, West)}`

The following restrictions apply to calculated members:

Double quotes must be placed around member names that contain special characters such as commas.
Relative positions for calculated members cannot be specified in Expand/Collapse mode.
The values used in the calculation need to be in the result set in order for the added calculated member to display. For example, if a calculation involves generation 3 members, the calculated member will not display unless generation 3 members are in the result set.
With Microsoft OLAP/Analysis Services, MicroStrategy, and Alphablox cubes, the syntax must use unique member names.
With relational data sources, the available dimensions are Record # and Columns.

For detailed syntax, functions supported, and examples, see the DataBlox Reference section in the Developer's Reference.

Parameters:: calculatedMembers - the string to generate the calculated members
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setBookmarkFilter

public void setBookmarkFilter(java.lang.String bookmarkFilter)
                       throws InvalidBloxPropertyValueException,
                              ServerBloxException

Specifies a default location from which to store and load bookmarks.

You can use this location to provide grouping and visibility for bookmarks, giveing you control over the set of bookmarks available to end users. The filter you specify causes the bookmarks to be stored in the subdirectory defined in the string bookmarkFilter under the usual bookmark directory (public, private, or group) in the Alphablox repository.

Additionally, the setBookmarkFilter method can allow bookmarks to be shared across multiple Blox and/or multiple applications.

Parameters:

bookmarkFilter - name of the subdirectory, or a comma separated list of the form:

 subDirectory, name=BloxID, application=AppContext, user=UserName

where name, application, and user clauses are optional, and the subDirectory clause is required.

Throws:

InvalidBloxPropertyValueException

ServerBloxException

setParentFirst

public void setParentFirst(int parentFirst)
                    throws InvalidBloxPropertyValueException,
                           ServerBloxException

Specifies how the parents are returned relative to the children.

Parameters:

parentFirst - integer (using constants). Valid values are:

DataBlox.PARENT_DEFAULT: the order of the members returned from the query should be respected
DataBlox.PARENT_FIRST: parent members should come before their child members regardless of the order of the members returned from the query
DataBlox.PARENT_LAST: parent members should come after their child members regardless of the order of the members returned from the query

Notes:

If you are using the Blox tags, specify true to place the parents before the children; false to place children first. If this tag attribute is not specified, the order of the members returned from the query is respected.
If you want to use the GridBlox's expand/collapse mode (expandCollapseMode ="true") and want parents to display first, use the value of this method to DataBlox.PARENT_DEFAULT rather than do so in the query. This is to ensure the expand/collapse mode can search through the result set correctly to determine the base members and shared members.
If you set to have parent members come before or after the members returned, you cannot reset to respect the default order.

Throws:

InvalidBloxPropertyValueException

ServerBloxException

setRowSort

public void setRowSort(java.lang.String sortString,
                       java.lang.String[] headerMembers,
                       java.lang.String[] footerMembers)
                throws InvalidBloxPropertyValueException,
                       ServerBloxException

Throws:: InvalidBloxPropertyValueException; ServerBloxException

setRowSort

public void setRowSort(java.lang.String sortString)
                throws InvalidBloxPropertyValueException,
                       ServerBloxException

Specifies how to sort row members for multidimensional data sources.

The String sortString consists of either two, three or four comma delimited elements:

The four element syntax allows the tupleIndex, groupingNestLevel, direction (ascending or descending) and whether the hierarchy should be preserved (preserveHierarchy), to be specified.
The two element syntax allows the tupleIndex, and direction to be specified, and defaults the groupingNestLevel to -1, sorting without regard to row groupings.
The three element syntax allows the tupleIndex, direction and the groupingNestLevel to be specified, and defaults preserveHierarchy to FALSE.

Where:

tupleIndex and groupingNestLevel: string representations of integers. A groupingNestLevel of 1 sorts within the current group; -1, sorts without regard to row groupings.
direction: a case-insensitive string, either Ascending, Asc, Descending or Desc.
preserveHierarchy: true to keep members with their parents after a sort is performed.

The following examples demonstrate this syntax:

 "1,0,asc,FALSE"
 "2,-1,desc"
 "2,asc"
 "0, descending"

Parameters:: sortString - A comma delimited string representing the sort.
Throws:: InvalidBloxPropertyValueException - When the sortString has an incorrect format.; ServerBloxException - When a runtime error occurs.

setColumnSort

public void setColumnSort(java.lang.String sortString)
                   throws InvalidBloxPropertyValueException,
                          ServerBloxException

Specifies how to sort column members for multidimensional data sources. The String sortString consists of either two, three or four comma delimited elements:

The four element syntax allows the tupleIndex, groupingNestLevel, direction (ascending or descending) and whether the hierarchy should be preserved (preserveHierarchy, to be specified.
The two element syntax allows the tupleIndex, and direction to be specified, and defaults the groupingNestLevel to -1, sorting regardless of column groupings.
The three element syntax allows the tupleIndex, direction and the groupingNestLeverl to be specified, and defaults preserveHierarchy to false.

Where:

tupleIndex and groupingNestLevel - string representations of integers. A groupingNestLevel of 1 sorts within the current group; -1, sorts without regard to column groupings.
direction is a case-insensitive string, either Ascending, Asc, Descending or Desc.
preserveHierarchy - true or false. This specifies whether to keep members with their parents after a sort is performed.

The following examples demonstrate this syntax:

 "1,0,asc,FALSE"
 "2,-1,desc"
 "2,asc"
 "0, descending"

Parameters:: sortString - A comma delimited string representing the sort.
Throws:: InvalidBloxPropertyValueException - When the sortString has an incorrect format.; ServerBloxException - When a runtime error occurs.

setColumnSort

public void setColumnSort(java.lang.String sortString,
                          java.lang.String[] headerMembers,
                          java.lang.String[] footerMembers)
                   throws InvalidBloxPropertyValueException,
                          ServerBloxException

Throws:: InvalidBloxPropertyValueException; ServerBloxException

setDimensionRoot

public void setDimensionRoot(java.lang.String dimensionRoot)
                      throws InvalidBloxPropertyValueException,
                             ServerBloxException

Specifies the dimension and one or more members to use as the root

Parameters:

dimensionRoot - A String which specifies the new root members for the specified dimension or dimensions. The String is in the form:


 DimA:NewRootMemberA1,NewRootMemberA2;DimB:NewRootMemberB1,NewRootMemberB1;...

A unique name (base name in Hyperion Essbase) or display name can be used for the dimension and member names string specified in the property value. This allows you to differentiate between different members or dimensions with the same display names. In Hyperion Essbase, you can specify a member, regardless of the alias table in use, by using the base name.
When using the dimensionRoot property, the initial query specified for the DataBlox component must not contain any members that are above the dimensionRoot member in the hierarchy, or the dimensionRoot property will be ignored.
When using IBM Cubing Services or Microsoft Analysis Services, use the fully qualified member name. For example:

setDimensionRoot("[ACCOUNT].[ACCOUNT_TYPE]:[ACCOUNT].[ACCOUNT TYPE].[All ACCOUNT TYPE].[ACCOUNT_TYPE]");

Note:If you specify a dimension without new root members, the dimension root is reset to the database default root member for that dimension.

Throws:

InvalidBloxPropertyValueException

ServerBloxException

setDimensionRoot

public void setDimensionRoot(Dimension dimension,
                             Member[] members)
                      throws ServerBloxException

Specifies the dimension and members to use as the root. If the named dimension appears in a page filter or the Dimension Explorer, the selected members act as the roots of the dimension. If member is null, the database uses its default dimension root. If there is conflict between this parameter value and the query, the query overrides the parameter.

Parameters:: dimension - the dimension to set as the root member.; members - the root members. If this parameter is null, or of zero length, dimension root resets to the database default.
Throws:: ServerBloxException

setDimensionRoot

public void setDimensionRoot(Dimension dimension,
                             Member member)
                      throws ServerBloxException

Deprecated.

Specifies the dimension and a single member to use as the root. If the named dimension appears in a page filter or the Dimension Explorer, the selected member acts as the root of the dimension. If member is null, the database uses its default dimension root. If there is conflict between this parameter value and the query, the query overrides the parameter.
This method is deprecated. Please use the setDimensionRoot(Dimension, Member[]) method.

Parameters:: dimension - the dimension to set as the root member.; member - the root member. If this parameter is null, dimension root resets to the database default.
Throws:: ServerBloxException

setEnableKeepRemove

public void setEnableKeepRemove(boolean enableKeepRemove)
                         throws InvalidBloxPropertyValueException,
                                ServerBloxException

Specifies whether the Keep Only and Remove Only options are available to the end user in the context menus of both the GridBlox and ChartBlox.

Parameters:: enableKeepRemove - true to enable the Keep Only and Remove Only options in the context menu, false to disable them. Default is true.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setEnableShowHide

public void setEnableShowHide(boolean enableShowHide)
                       throws InvalidBloxPropertyValueException,
                              ServerBloxException

Specifies whether the Show Only, Show All, and Hide Only options are available to end users in the context menus of both the GridBlox and ChartBlox.

Parameters:: enableShowHide - true to enable the Show Only, Show All, and Hide Only options; false to disable them. Default is true.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setLeafDrillDownAvailable

public void setLeafDrillDownAvailable(boolean leafDrillDownAvailable)
                               throws InvalidBloxPropertyValueException,
                                      ServerBloxException

Specifies if the user should be allowed to drill down on a leaf member.

Parameters:: leafDrillDownAvailable - true to allow the user to drill down on a leaf member
Throws:: InvalidBloxPropertyValueException; ServerBloxException
See Also:: isLeafDrillDownAvailable()

setMergedHeaders

public void setMergedHeaders(java.lang.String mergedHeaders)
                      throws InvalidBloxPropertyValueException,
                             ServerBloxException

Specifies the dimensions on the same axis whose headers are to be merged.

Parameters:

mergedHeaders -

a colon-separated string of dimensionString:matchPatterns:drillableDim, where:

dimensionString: This string specifies the dimensions whose headers are to be merged and the new member name for the merged header, in the format of:

dimensionList = newMemberName

dimensionList is a comma-separated list of dimensions whose headers are to be merged. newMemberName is the name of the merged header. This is the name to use if you want to hide a member, row, or tuple (using DataBlox's hiddenMembers or hiddenTuples property). By default, the merged header adds a space as a separator among the merged dimension headers. For example, if the headers for Scenario and Measures are merged, the new header is "Scenario Measures," with a space in between.

The order of the dimension specification has to be the same as that in the result set, and they must be consecutive. For example, if you have a query that returns All Time Periods, Measures, and Scenario in that sequence, then the following examples are valid:
```
 mergedHeaders="All Time Periods, Measures, Scenario = Measures and Scenario by Year"
 mergedHeaders="Measures, Scenario = Measures & Scenario"
 
```
But the following are not:
```
 mergedHeaders="All Time Periods, Scenario = Scenario by Period" (dimensions are not consecutive)
 mergedHeaders="Measures, All Time Periods = Measures by Period" (order is not correct)
 
```
Note: Calculated member (specified using the calculatedMembers property (or the setCalculatedMembers(String) method) is performed before the headers are merged. Therefore, when you need to add a calculated member or members, use the original dimension names. hiddenMembers and hiddenTuples, on the contrary, are performed after mergedHeaders, and therefore the newly merged header should be used.
matchPatterns: Optional; A comma-separated list of pairs of the header pattern to match and the replacing header. Each pair of old header and new header should be in the format of:

olderHeader = newHeader

The following example merges the headers for Measures and All Time Periods, and replaces the string "Qtr 1" found in any header with the string "Q1," "Qtr 2" with "Q2," "Qtr 3" with "Q3," and "Qtr 4" with "Q4."
```
 mergedHeaders="All Time Periods, Measures = Measures by Period: Qtr 1 = Q1, Qtr 2 = Q2, Qtr 3 = Q3, Qtr 4 = Q4"
 
```
As a result, Qtr 1 00 Sales becomes Q1 00 Sales and Qtr 1 01 Forecast becomes Q1 01 Forecast.
drillableDim: Optional; The dimension that is drillable when users drill on the merged header. If a drillable dimension is not specified, the first dimension listed in the dimensionString is by default the drillable dimension. If a drillable dimension is specified without any match patterns, the colon separating the two strings should still be included. For example:
```
 mergedHeaders="Measures, Scenario::Scenario"
 
```
Note: There can only be one drillable dimension when headers are merged. Setting a drillable dimension makes the other dimensions in the dimensionString not drillable.

Throws:

InvalidBloxPropertyValueException

ServerBloxException

setHiddenMembers

public void setHiddenMembers(java.lang.String hiddenMembers)
                      throws InvalidBloxPropertyValueException,
                             ServerBloxException

Specifies the members to hide. This creates a new list of members to be hidden, therefore previously hidden members will no longer be hidden.

Parameters:: hiddenMembers - A comma delimited string specifying the members to hide. The members are grouped by dimension. Each group of members is proceeded by the name of the dimension followed by a colon. Separate each group with a semicolon. For example, DimensionName1:MemberNameA,MemberNameB; DimensionName2:MemberNameC,MemberNameD;
Throws:: ServerBloxException - When an error occurred while trying to hide members; InvalidBloxPropertyValueException - When the argument string is formatted incorrectly.

setAutoConnect

public void setAutoConnect(boolean autoConnect)
                    throws InvalidBloxPropertyValueException,
                           ServerBloxException

Enabling this property will cause the DataBlox to reconnect to the data source automatically in all cases except during startup. The default value is false. If enabled and the user performs an operation that requires a data source connection, the DataBlox will connect to the datasource, restore the current query, and execute the operation. This property is usually used in conjuction with autoDisconnect. This only works with relational datasources.

Connecting to a data source and restoring a query are time-intensive processes. The autoConnect and autoDisconnect properties should be used only in certain cases, such as when the number of connections to a database is limited.

If autoConnect is disabled and autoDisconnect is enabled, the user will not be able to perform operations on the result set after the initial disconnect.

Parameters:: autoConnect - set to true to enable automatically connecting, set false to disable automatically connecting.
Throws:: InvalidBloxPropertyValueException; ServerBloxException
See Also:: setAutoDisconnect(boolean)

setAutoDisconnect

public void setAutoDisconnect(boolean autoDisconnect)
                       throws InvalidBloxPropertyValueException,
                              ServerBloxException

Enabling this property will cause the DataBlox to disconnect from the data source automatically when the application no longer requires a connection without erasing the current result set. The default value is false. This property is usually used in conjuction with autoDisconnect. This only works with relational or Microsoft Analysis Services data sources.

Connecting to a data source and restoring a query are time intensive processes. The autoConnect and autoDisconnect properties should be used only in certain cases, such as when you are experiencing scalability problems with Microsoft Analysis Services due to large client cache memory consuption per connection. In this case, if you have custom code that performs metadata operations such as a for loop with thousands of resolveMember calls, you should call the clearClientCache method afterwards to free up the memory.

The autoDisconnect property does not apply to the RDB metadata object on a server-side DataBlox. The DataBlox will not disconnect from an RDB data source after a metadata request, even if autoDisconnect is set to true. The application must explicitly disconnect when it is through with the object. However, you can still use setAutoConnect to reconnect to the data source on future metadata requests.

If autoDisconnect is enabled and autoConnect is disabled, the user will not be able to perform operations on the result set after the initial disconnect.

Parameters:: autoDisconnect - set to true to enable automatically disconnecting, set false to disable automatically disconnecting.
Throws:: InvalidBloxPropertyValueException; ServerBloxException
See Also:: setAutoConnect(boolean)

setConnectOnStartup

public void setConnectOnStartup(boolean connectOnStartup)
                         throws InvalidBloxPropertyValueException,
                                ServerBloxException

Specifies whether the DataBlox will automatically connect to its data source upon Blox instantiation.

To prevent a DataBlox from connecting to a data source, set this method to false. When the data query is set later, you need to call the connect() method to connect to the data source.

When connectOnStartup is set to true, it overrides the autoConnect property. The connectOnStartup property causes a database connection, even if no query is defined. Note that the visible property only specifies whether an applet should be sent to the client. If the DataBlox's visible property is set to false, it still connects to the data source unless connectOnStartup is set to false.

Parameters:: connectOnStartup - true to automatically connect to the data source when the Blox is instantiated; false to not connect.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setUseOlapDrillOptimization

public void setUseOlapDrillOptimization(boolean useOptimization)
                                 throws InvalidBloxPropertyValueException,
                                        ServerBloxException

Specifies whether drill optimization should be enabled for Microsoft Analysis Services data sources.

By default, the useOlapDrillOptimization property is set to true for Microsoft Analysis Services data sources for better query performance. Use this property with care in conjunction with the suppressMissingColumns or suppressMissingRows property. When both properties are set to true, users may only see partial data when they drill down and then perform other actions such as changing page filters, drilling up, or using Dimension Explorer/Member Filter. When this sequence of user actions occur, a dialog will pop up that alerts the users of this possibility and recommends the users to turn off Suppress Missing. This dialog can be turned off with the showSuppressDataDialog property.

Parameters:: useOptimization - true to use the query optimization
Throws:: InvalidBloxPropertyValueException; ServerBloxException
See Also:: setShowSuppressDataDialog(boolean)

setShowSuppressDataDialog

public void setShowSuppressDataDialog(boolean showDialog)
                               throws InvalidBloxPropertyValueException,
                                      ServerBloxException

Specifies if a warning dialog should pop up when the useOlapDrillOptimization property is set to true and either suppressMissingColumns or suppressMissingRows is also set to true. This method only applies to Microsoft Analysis Services data sources.

This dialog alerts users of the possibility of incomplete data when they drill down and then perform further data analysis operations. This can happen when users drill down and then perform other actions such as changing page filters, drilling up, or using Dimension Explorer/Member Filter. When this sequence of user actions occur, a dialog will pop up that alerts the users of the possibility of incomplete data and recommends the users to turn off Suppress Missing using the Data options dialog. When the showSuppressDataDialog property is set to false, the dialog will not pop up.

Parameters:: showDialog - true to pop up an alert dialog; false to suppress the popup dialog. Defaults to true.
Throws:: InvalidBloxPropertyValueException; ServerBloxException

setShowShortHierarchyNames

public void setShowShortHierarchyNames(boolean showShortHierarchyNames)
                                throws InvalidBloxPropertyValueException,
                                       ServerBloxException

A flag that determines how to generate dimension display names for dimensions with multiple hierarchies.

Throws:: InvalidBloxPropertyValueException; ServerBloxException

clearClientCache

public void clearClientCache()
                      throws ServerBloxException,
                             BadConnectionException

Call this method to clear the client cache used by MSOLAP connection; for Microsoft Analysis Services data sources only. This will only work if the DataBlox is connected and autoDisconnect is set to true.

Throws:: ServerBloxException; BadConnectionException

connect

public void connect()
             throws DataBloxCannotConnectException,
                    ServerBloxException

If currently connected, disconnect and clear the current result set. Connect using any data properties on the DataPeer that have changed. Some properties that may be set are the dataSourceName, userName, password, catalog, schema, and query. Also executes the text query if the query property has been set.

If you already have a server-side object created (such as a MDBMetaData object), after calling connect(), since the object is still pointing to the original connection that no longer exists, you will need to recreate the server-side object.

If the value for the query property is missing, no query is executed when the connection is made. Use the setQuery method to set the value for the query property.

Throws:: DataBloxCannotConnectException - When the DataBlox failed to connect to the data source.; ServerBloxException - When unable to properly initialize the DataPeer.
See Also:: connect(boolean)

connect

public void connect(boolean executeTextualQuery)
             throws DataBloxCannotConnectException,
                    ServerBloxException

Parameters:: executeTextualQuery - If true, also execute the textual query if the query property has been set after connecting.
Throws:: DataBloxCannotConnectException - When the DataBlox failed to connect to the data source.; ServerBloxException - When unable to properly initialize the DataPeer.

isConnected

public boolean isConnected()
                    throws ServerBloxException

Returns true when the data source is connected, false if not.

Returns:: true if the data source has already been connected, false otherwise.
Throws:: ServerBloxException - When unable to properly initialize the DataPeer.

disconnect

public void disconnect(boolean clearResultSet)
                throws ServerBloxException

Disconnects from the data source and releases the back end connection. It will be reconnected when a data operation is performed (e.g., changing the query). If this method is called and then an operation that requires a connection is called (for example, drill down), an exception will be thrown. If the clearResultSet parameter is false, the result set is not cleared.

Parameters:: clearResultSet - Use true to clear the result set, false not to clear the result set.
Throws:: ServerBloxException - When unable to properly initialize the DataPeer.

refresh

public void refresh()
             throws DataBloxBadConnectionException,
                    ServerBloxException

Refreshes the data set. This method is useful following a call to the lockCurrentDataSet method to ensure that the data is fresh before any modifications are made.

Throws:: DataBloxBadConnectionException - When the connection to the database has gone bad.; ServerBloxException - When an error was encountered.

clearResultSet

public void clearResultSet()
                    throws ServerBloxException

Clears and deletes the current result set for this DataBlox. Note: Using getResultSet() after using this method results in the exception CannotCreateResultSetException.

Throws:: ServerBloxException - When unable to properly initialize the DataPeer.

executeCustomCalc

public void executeCustomCalc(java.lang.String calcScript)
                       throws DataBloxBadConnectionException,
                              ServerBloxException

Executes a calculation script on an Essbase database (for example,"CALC ALL;"). The Essbase database does not need to be locked to perform a recalculation. This method is silently ignored by other data sources.

Parameters:: calcScript - The named calculation script saved in the database.
Throws:: DataBloxBadConnectionException - When the connection to the database has gone bad.; ServerBloxException - When an error was encountered.

executeNamedDBCalcScript

public void executeNamedDBCalcScript(java.lang.String calcScript)
                              throws DataBloxBadConnectionException,
                                     ServerBloxException

Executes the named Essbase calculation script. The named calc script must reside on the Essbase server. The application name and database name used in the calc script must exactly match the values for the catalog and schema parameters on the DataBlox. This method is silently ignored by other data sources.

Parameters:: calcScript - The named calculation script saved in the database.
Throws:: DataBloxBadConnectionException - When the connection to the database has gone bad.; ServerBloxException - When an error was encountered.

lockCurrentDataSet

public void lockCurrentDataSet()
                        throws DataBloxBadConnectionException,
                               ServerBloxException

Locks the called upon result set. This method does not lock the entire database. Writing data back to a database requires that the data set be locked before committing the data. This method must be called prior to calling the commitData method.

Throws:: DataBloxBadConnectionException - When connection to the database has gone bad.; ServerBloxException - When an error was encountered.

commitData

public void commitData()
                throws DataBloxBadConnectionException,
                       ServerBloxException

Writes the current data set back to the database. The data set must have been previously locked using the lockCurrentDataSet() method. Once the data set is committed, it is automatically unlocked. Any further calls to commitData() require the data set to be relocked.

Throws:: DataBloxBadConnectionException - When connection to the database has gone bad.; ServerBloxException - When an error was encountered.

setDataValues

public void setDataValues(Tuple[][] coordinates,
                          java.lang.String[] values)
                   throws ServerBloxException

Changes data values in the result set at the coordinates specified. Note: The setDataValues method supports writeback to Essbase cubes (including both leaf and non-leaf members) and Microsoft Analysis Services 2000 cubes (leaf members only); AlphaBlox Cubes do not support writeback.

Parameters:: coordinates - An array of coordinates, a single coordinate is itself an array of tuple that specifies a cell in the data cube. Invalid coordinates will result in an exception.; values - An array of data values to be written back. If only one value appears in the value string, it is applied to all specified cell coordinates. Non-numeric values such as a blank string or #MISSING are submitted to the data source as a missing value.
Throws:: ServerBloxException - When an error occurs.

drillThrough

public RDBResultSet drillThrough(Tuple[] coordinates)
                          throws ServerBloxException

Perform a drill through operation at the specified cell. A DRILLTHROUGH MDX statement will be generated and executed. The generated MDX statement is in the form: DRILLTHROUGH
SELECT
FROM [CUBE]
WHERE (
[Unique Name of Current Member From Dimension 0],
[Unique Name of Current Member From Dimension 1],
[Unique Name of Current Member From Dimension 2],
...
[Unique Name of Current Member From Dimension N])
We will use the coordinates to determine the unique names of the current members for the dimensions on the column and row axis. The DataBlox will determine the unique names of the current members on the slicer axis. The relational data returned from the drill through is encapsulated in a RDBResultSet. This is only relevant to MSOLAP datasources. Otherwise return null.

Parameters:: coordinates - - The first tuple's index is the column coordinate of the specified cell. The second tuple's index is the row coordinate of the specified cell.
Returns:: A RDBResultSet representing the drill through relational data. This is only relevant to MSOLAP datasources. Otherwise return null.
Throws:: ServerBloxException

drillThrough

public RDBResultSet drillThrough(Tuple[] coordinates,
                                 int timeout)
                          throws ServerBloxException

Parameters:: coordinates - - The first tuple's index is the column coordinate of the specified cell. The second tuple's index is the row coordinate of the specified cell.; timeout - - how long to wait in seconds while executing a drillthrough before terminating the attempt and generating an error
Returns:: A RDBResultSet representing the drill through relational data. This is only relevant to MSOLAP datasources. Otherwise return null.
Throws:: ServerBloxException

drillThrough

public RDBResultSet drillThrough(int columnCoordinate,
                                 int rowCoordinate,
                                 int timeout)
                          throws ServerBloxException

Perform a drill through operation at the specified cell. A DRILLTHROUGH MDX statement will be generated and executed. The generated MDX statement is in the form: DRILLTHROUGH
SELECT
FROM [CUBE]
WHERE (
[Unique Name of Current Member From Dimension 0],
[Unique Name of Current Member From Dimension 1],
[Unique Name of Current Member From Dimension 2],
...
[Unique Name of Current Member From Dimension N])
We will use the coordinates to determine the unique names of the current members for the dimensions on the column and row axis. The DataBlox will determine the unique names of the current members on the slicer axis. The relational data returned from the drill through is encapsulated in a RDBResultSet. This method is only relevant to MSOLAP datasources. Otherwise return null.

Parameters:: columnCoordinate - - The column coordinate of the specified cell.; rowCoordinate - - The row coordinate of the specified cell.; timeout - - how long to wait in seconds while executing a drillthrough before terminating the attempt and generating an error
Returns:: A RDBResultSet representing the drill through relational data. This is only relevant to MSOLAP datasources. Otherwise return null.
Throws:: ServerBloxException

drillThrough

public RDBResultSet drillThrough(int columnCoordinate,
                                 int rowCoordinate)
                          throws ServerBloxException

Perform a drill through operation at the specified cell. A DRILLTHROUGH MDX statement will be generated and executed. The generated MDX statement is in the form: DRILLTHROUGH
SELECT
FROM [CUBE]
WHERE (
[Unique Name of Current Member From Dimension 0],
[Unique Name of Current Member From Dimension 1],
[Unique Name of Current Member From Dimension 2],
...
[Unique Name of Current Member From Dimension N])
We will use the coordinates to determine the unique names of the current members for the dimensions on the column and row axis. The DataBlox will determine the unique names of the current members on the slicer axis. The relational data returned from the drill through is encapsulated in a RDBResultSet. This method is only relevant to MSOLAP datasources. Otherwise return null.

Parameters:: columnCoordinate - - The column coordinate of the specified cell.; rowCoordinate - - The row coordinate of the specified cell.
Returns:: A RDBResultSet representing the drill through relational data. This is only relevant to MSOLAP datasources. Otherwise return null.
Throws:: ServerBloxException

drillThrough

public RDBResultSet drillThrough(java.lang.String reportName,
                                 int columnCoordinate,
                                 int rowCoordinate)
                          throws ServerBloxException

Performs a drill through operation at the specified cell using the specified reportName. This method is only relevant to Essbase OLAP or EES datasources which have drillthrough reports setup through EIS

Parameters:: reportName - The name of the drillthrough report.; columnCoordinate - The column coordinate of the specified cell.; rowCoordinate - The row coordinate of the specified cell.
Returns:: RDBResultSet representing the specified drillthrough report at the specified cell.
Throws:: ServerBloxException

getDrillThroughReportNames

public java.lang.String[] getDrillThroughReportNames(int columnCoordinate,
                                                     int rowCoordinate)
                                              throws ServerBloxException

Returns the list of drillthrough reports found at the specified cell. This method is only relevant to Essbase OLAP or EES datasources which have drillthrough reports setup through EIS

Parameters:: columnCoordinate - The column coordinate for the specified cell; rowCoordinate - The row coordinate for the specified cell
Returns:: String[] containing the names of the drillthrough reports at the specified cell.
Throws:: ServerBloxException

swapRowAndColumnAxes

public void swapRowAndColumnAxes()
                          throws ServerBloxException

Swaps the members on the row axis with the members on the column axes.

Throws:: ServerBloxException

writeback

public void writeback(java.lang.Object coordinates,
                      java.lang.Object values,
                      java.lang.String command)
               throws ServerBloxException

Combines into a single method the actions performed by the lockCurrentDataSet, commitData, setDataValues, unlockAll, executeCustomCalc, and refresh methods.
Note: The writeback method supports writeback to Essbase cubes (including both leaf and non-leaf members) and Microsoft Analysis Services 2000 cubes (leaf members only); AlphaBlox Cubes do not support writeback.

Parameters:: coordinates - The coordinates object can be in two forms: Tuple[][] or a String. If the coordinates object is in the form of a string, it should be a comma delimited string denoting the coordinates of the cells to write back to. If the coordinates object is in the form of a Tuple[][], a Tuple[] in the array represents the coordinates for each cell you want to write back to.; values - The values object can be in two forms Object[] or String. If the values is a string, it should be a comma delimited string denoting the values for the writeback operation. The order of the values corresponds to the order of the coordinates specified. If the coordinates object is in the form of Object[], each object in the array represents a value to writeback. The order of the values will correspond to the order of the coordinates specified.
If only one value appears in the value string, it is applied to all specified cell coordinates. Non-numeric values such as a blank string or #MISSING are submitted to the data source as a missing value.; command - A command to execute on the data source's database. This argument must be non-null. If no command are to be executed, use the version of writeback that takes coordinates and values only, or pass in an empty string for the command parameter.
Throws:: ServerBloxException - When an error occurs while trying to writeback.

unlockAll

public void unlockAll()
               throws ServerBloxException,
                      DataException,
                      BadConnectionException,
                      java.lang.Exception

Unlocks any data that was previously locked in the Essbase database. This method applies to Essbase only.

Throws:: ServerBloxException; DataException; BadConnectionException; java.lang.Exception

generateQuery

public java.lang.String generateQuery()
                               throws DataBloxBadConnectionException,
                                      ServerBloxException

Generates and returns a textual query reflecting the current state of the result set, in the query language of the data source (e.g., MDX). This method will not work for relational data or when not connected to the data source (an exception will be thrown in these cases).

Returns:: A String representing a textual query. Running this query will return the current state of the result set.
Throws:: DataBloxBadConnectionException; ServerBloxException

generateQueryModel

public IQueryModel generateQueryModel()
                               throws ServerBloxException

Generates and returns an IQueryModel object that reflects the current state of the result set. This method is currently limited for use with data sources whose query language is MDX. Unless setQueryModel() has been called first, this method requires a connection to the data source.

Returns:: An IQueryModel object. Currently, this method is limited to returning IMDXQueryModel objects.
Throws:: ServerBloxException

getMetaData

public MetaData getMetaData()
                     throws DataBloxCannotConnectException,
                            ServerBloxException

Returns a read-only copy of the metadata. This method will connect to the data source if needed.

Returns:: A read-only copy of the metadata.
Throws:: DataBloxCannotConnectException - When the DataBlox fails to connect to the datasource.; ServerBloxException

getResultSet

public ResultSet getResultSet()
                       throws DataBloxCannotConnectException,
                              CannotCreateResultSetException,
                              ServerBloxException

Returns a read-only copy of the result set. This method will connect to the database if needed, and never returns a null result set. This result set corresponds to the result set which is displayed by the DataBlox. Alphablox hidden members will not appear in this result set since they are hidden from display. Alphablox calculated members will appear in this result set since they are displayed. Members with merged header names will appear in this result set since they are displayed as merged.

Returns:: A read-only copy of result set corresponding to the data which is displayed from this DataBlox.
Throws:: DataBloxCannotConnectException - When the DataBlox failed to connect to datasource.; CannotCreateResultSetException - When a result set cannot be found after connecting to the datasource, usually because a query hasn't been specified.; ServerBloxException

getRawResultSet

public ResultSet getRawResultSet()
                          throws DataBloxCannotConnectException,
                                 CannotCreateResultSetException,
                                 ServerBloxException

Returns a read-only copy of the result set. This method will connect to the database if needed, and never returns a null result set. This result set corresponds to the result set which is returned by the database. Since Alphablox hidden members have yet to be hidden these members will appear in this result set. Since Alphablox calculated members have yet to be calculated these members will not appear in this result set. Since headers which have yet to be merged the merged headers will not appear in this result set.

Returns:: A read-only copy of result set corresponding to the data which is from the database.
Throws:: DataBloxCannotConnectException - When the DataBlox failed to connect to datasource.; CannotCreateResultSetException - When a result set cannot be found after connecting to the datasource, usually because a query hasn't been specified.; ServerBloxException

getXMLResultSet

public AASCubeXMLDocument getXMLResultSet()
                                   throws CannotCreateXMLResultSetException,
                                          ServerBloxException

Returns a read-only copy of the result set as XML DOM. This method will not return a null.

Returns:: A read-only copy of the result set as XML DOM.
Throws:: ServerBloxException - When unable to properly initialize the DataPeer.; CannotCreateXMLResultSetException - When unable to build the XML DOM.

drillDown

public void drillDown(TupleMember member)
               throws DataBloxBadConnectionException,
                      ServerBloxException

Drills down on the specified member. This method is relevant for multi-dimensional data sources only.

Parameters:: member - The member to drill down on. This member cannot be null.
Throws:: DataBloxBadConnectionException - When connection to the database has gone bad.; ServerBloxException - When an error was encountered.

drillToAllDescendants

public void drillToAllDescendants(TupleMember member)
                           throws DataBloxBadConnectionException,
                                  ServerBloxException

Drills down to all descendants for the specified member. This method is relevant for multi-dimensional data sources only.

Parameters:: member - The member to drill down on. This member cannot be null.
Throws:: DataBloxBadConnectionException - When connection to the database has gone bad.; ServerBloxException - When an error was encountered.

drillUp

public void drillUp(TupleMember member)
             throws DataBloxBadConnectionException,
                    ServerBloxException

Drills up on the specified member. This method is relevant for multi-dimensional data sources only.

Parameters:: member - The member to drill up on. This member cannot be null.
Throws:: DataBloxBadConnectionException - When connection to the database has gone bad.; ServerBloxException - When an error was encountered.

pivot

public void pivot(AxisDimension dimension,
                  int newAxisIndex,
                  int newNestLevel)
           throws ServerBloxException,
                  DataBloxBadConnectionException

Pivots the specified dimension to another position in the schema, either from axis to axis, slicer to axis, or axis to slicer. This method is relevant for multi-dimensional data sources only.

Parameters:: dimension - The dimension that is being pivoted; newAxisIndex - The index of the axis the dimension is to be moved to.; newNestLevel - The nesting level within the new axis the dimension is to be moved to.
Throws:: DataBloxBadConnectionException - When connection to the database has gone bad.; ServerBloxException - When an error was encountered.

pivot

public void pivot(int oldAxisIndex,
                  int oldNestLevel,
                  int newAxisIndex,
                  int newNestLevel)
           throws DataBloxBadConnectionException,
                  ServerBloxException

Pivots the specified dimension to another position in the schema, either from axis to axis, slicer to axis, or axis to slicer. This method is relevant for multi-dimensional data sources only.

Parameters:: oldAxisIndex - The index of the axis the dimension is to be moved from.; oldNestLevel - The nesting level within the axis the dimension is to be moved from.; newAxisIndex - The index of the axis the dimension is to be moved to.; newNestLevel - The nesting level within the new axis the dimension is to be moved to.
Throws:: DataBloxBadConnectionException - When connection to the database has gone bad.; ServerBloxException - When an error was encountered.

keepOnly

public void keepOnly(TupleMember member)
              throws DataBloxBadConnectionException,
                     ServerBloxException

Keeps only the specified member. This method is relevant for multi-dimensional data sources only.

Parameters:: member - The only member to keep. This member cannot be null.
Throws:: DataBloxBadConnectionException - When the connection has gone bad.; ServerBloxException - When an error occurs.

keepOnly

public void keepOnly(TupleMember[] members)
              throws DataBloxBadConnectionException,
                     ServerBloxException

Keeps only the members found in the specified array. This method is relevant for multi-dimensional data sources only.

Parameters:: members - Array specifying the members to keep. If the array is null, this call is ignored.
Throws:: DataBloxBadConnectionException - When the connection has gone bad.; ServerBloxException - When an error occurs.

removeOnly

public void removeOnly(TupleMember member)
                throws DataBloxBadConnectionException,
                       ServerBloxException

Removes only the specified member. This method is relevant for multi-dimensional data sources only.

Parameters:: member - The member to remove. This member cannot be null.
Throws:: DataBloxBadConnectionException - When connection to the database has gone bad.; ServerBloxException - When an error was encountered.

removeOnly

public void removeOnly(TupleMember[] members)
                throws DataBloxBadConnectionException,
                       ServerBloxException

Removes the members found in specified array of members. This method is relevant for multi-dimensional data source only.

Parameters:: members - An array of members to remove. If the array is null, this call is ignored.
Throws:: DataBloxBadConnectionException - When connection to the database has gone bad.; ServerBloxException - When an error was encountered.

setRowSort

public void setRowSort(Tuple tuple,
                       AxisDimension dimension,
                       boolean ascending)
                throws ServerBloxException

Specifies how to sort row members for multi-dimensional data sources.

Parameters:: tuple - The tuple on the row axis that specifies the row on which to sort.; dimension - Specifies the dimension on the column axis for which grouping is preserved. The parameter can be null, which indicates that no grouping is to be preserved on the column axis.; ascending - Specifies the sort order. If True, the sort will be ascending, otherwise descending.
Throws:: ServerBloxException - When a runtime error occurs.

setRowSort

public void setRowSort(Tuple tuple,
                       AxisDimension dimension,
                       boolean ascending,
                       boolean preserveHierarchy)
                throws ServerBloxException

Specifies how to sort row members for multi-dimensional data sources.

Parameters:: tuple - The tuple on the row axis that specifies the row on which to sort.; dimension - Specifies the dimension on the column axis for which grouping is preserved. The parameter can be null, which indicates that no grouping is to be preserved on the column axis.; ascending - Specifies the sort order. If True, the sort will be ascending, otherwise descending.; preserveHierarchy - specifies whether or not the hierarchy will be preserved. True if it is to be preserved, otherwise false.
Throws:: ServerBloxException - When a runtime error occurs.

setRowSort

public void setRowSort(Tuple tuple,
                       AxisDimension dimension,
                       boolean ascending,
                       boolean preserveHierarchy,
                       TupleMember[] headerMembers,
                       TupleMember[] footerMembers)
                throws ServerBloxException

Specifies how to sort row members for multi-dimensional data sources.

Parameters:: tuple - The tuple on the row axis that specifies the row on which to sort.; dimension - Specifies the dimension on the column axis for which grouping is preserved. The parameter can be null, which indicates that no grouping is to be preserved on the column axis.; ascending - Specifies the sort order. If True, the sort will be ascending, otherwise descending.; preserveHierarchy - specifies whether or not the hierarchy will be preserved. True if it is to be preserved, otherwise false.
Throws:: ServerBloxException - When a runtime error occurs.

setColumnSort

public void setColumnSort(Tuple tuple,
                          AxisDimension dimension,
                          boolean ascending)
                   throws ServerBloxException

Specifies how to sort column members for multi-dimensional data sources.

Parameters:: tuple - The tuple on the column axis that specifies the column on which to sort.; dimension - Specifies the dimension on the row axis for which grouping is preserved. The parameter can be null, which indicates that no grouping is to be preserved on the row axis.; ascending - Specifies the sort order. If True, the sort will be ascending, otherwise descending.
Throws:: ServerBloxException - When a runtime error occurs.

setColumnSort

public void setColumnSort(Tuple tuple,
                          AxisDimension dimension,
                          boolean ascending,
                          boolean preserveHierarchy)
                   throws ServerBloxException

Specifies how to sort column members for multi-dimensional data sources.

Parameters:: tuple - The tuple on the column axis that specifies the column on which to sort.; dimension - Specifies the dimension on the row axis for which grouping is preserved. The parameter can be null, which indicates that no grouping is to be preserved on the row axis.; ascending - Specifies the sort order. If True, the sort will be ascending, otherwise descending.; preserveHierarchy - specifies whether or not the hierarchy will be preserved. True if it is to be preserved, otherwise false.
Throws:: ServerBloxException - When a runtime error occurs.

setColumnSort

public void setColumnSort(Tuple tuple,
                          AxisDimension dimension,
                          boolean ascending,
                          boolean preserveHierarchy,
                          TupleMember[] headerMbrs,
                          TupleMember[] footerMbrs)
                   throws ServerBloxException

Specifies how to sort column members for multi-dimensional data sources.

Parameters:: tuple - The tuple on the column axis that specifies the column on which to sort.; dimension - Specifies the dimension on the row axis for which grouping is preserved. The parameter can be null, which indicates that no grouping is to be preserved on the row axis.; ascending - Specifies the sort order. If True, the sort will be ascending, otherwise descending.; preserveHierarchy - specifies whether or not the hierarchy will be preserved. True if it is to be preserved, otherwise false.
Throws:: ServerBloxException - When a runtime error occurs.

setColumnSort

public void setColumnSort(ResultColumn column,
                          boolean ascending)
                   throws ServerBloxException

Specifies how to sort column members for relational data sources.

Parameters:: column - a column in this DataBlox's relational result set.; ascending - specifies the sort order. If true, the sort will be ascending, otherwise descending.
Throws:: ServerBloxException - When a runtime error occurs.

removeRowSort

public void removeRowSort()
                   throws DataBloxBadConnectionException,
                          ServerBloxException

Removes row sort. Relevant for multi-dimensional data sources only.

Throws:: DataBloxBadConnectionException - When connection to the database has gone bad.; ServerBloxException - When an error was encountered.

removeColumnSort

public void removeColumnSort()
                      throws DataBloxBadConnectionException,
                             ServerBloxException

Removes the column sort. This applies to both relational and multi-dimensional data sources.

Throws:: DataBloxBadConnectionException - When connection to the database has gone bad.; ServerBloxException - When an error was encountered.

setSelectedMembers

public void setSelectedMembers(Member[] members)
                        throws ServerBloxException

Sets the selected members for the given dimension. For dimensions on the row and column axes, the selected members are displayed in the grid. For dimensions on the page and other axes, the selected member is the member to be set as the filter. This method is relevant for multi-dimensional data sources only.

Parameters:: members - The selected members to set. Members must belong to the same dimension.
Throws:: ServerBloxException - When a runtime error occurs.
See Also:: Member, MDBMetaData.resolveMember(java.lang.String)

addSelectedMembers

public void addSelectedMembers(Member[] members)
                        throws ServerBloxException

Add to the selected members for the given dimension. For dimensions on the row and column axes, the selected members are displayed in the grid. For dimensions on the page and other axes, the selected members are the members to be set as the filter. This method is relevant for multi-dimensional data sources only.

Parameters:: members - An array containing the selected members to set. All the members must belong to the same dimension.
Throws:: ServerBloxException - When an invalid member is encountered.
See Also:: Member, MDBMetaData.resolveMember(java.lang.String)

getSelectedMembers

public Member[] getSelectedMembers(Dimension dimension)
                            throws ServerBloxException

Returns the selected members for the given dimension. For dimensions on the row and column axes, the selected members are displayed in the grid. For dimensions on the page and other axes, the selected member is the member to be set as the filter. This method is relevant for multi-dimensional data sources only.

Parameters:: dimension - the given dimension.
Returns:: members the selected members.
Throws:: ServerBloxException
See Also:: Dimension, Member, MDBMetaData.resolveDimension(java.lang.String), MDBMetaData.resolveMember(java.lang.String)

getHiddenMembers

public Member getHiddenMembers(MDBMetaData mdbMetaData,
                               int i,
                               java.lang.String cubeName)
                        throws ServerBloxException,
                               java.lang.ArrayIndexOutOfBoundsException

Returns the hidden member with the specified index for the array of hidden members. Use this method to return the hidden members from a multi-dimensional data source.

Parameters:: mdbMetaData - The multidimensional metadata from which the members should be retrieved. If this parameter is null, the members are generated from a new metadata object.; i - the index of desired hidden member.; cubeName - the name of the cube from which the members should be retrieved. In Essbase, the cube name is Cube 1.
Returns:: The hidden member with the specified index.
Throws:: ServerBloxException - When unable to connect to the database or when the metadata is corrupted.; java.lang.ArrayIndexOutOfBoundsException - When the index is negative, or greater than or equal to the total number of hidden members.

getHiddenMembers

public Member[] getHiddenMembers(MDBMetaData mdbMetaData,
                                 java.lang.String cubeName)
                          throws ServerBloxException

Returns an array of hidden members. Use this method to return the hidden members from a multi-dimensional data source.

Parameters:: mdbMetaData - The multidimensional metadata from which the members should be retrieved.; cubeName - the name of the cube from which the members should be retrieved.
Returns:: An array of hidden members.
Throws:: ServerBloxException

setHiddenMembers

public void setHiddenMembers(Member[] members)
                      throws ServerBloxException

Hides the members in the specified array. One member of each dimension must remain in the grid. If you specify for all members of a dimension to be hidden, the last member specified will not be hidden. Any previous hidden members will no longer be hidden. This method is relevant with multi-dimensional data sources.

Parameters:: members - an array containing the members to hide. This array cannot be null.
Throws:: ServerBloxException - When an error occurred while trying to set hidden members.

showMembers

public void showMembers(Member[] members)
                 throws ServerBloxException

Shows members in the specified array that were previously hidden. This method is relevant with multi-dimensional data sources.

Parameters:: members - an array of members to show. This array cannot be null.
Throws:: ServerBloxException - When an error occurred while trying to show members.

hideMembers

public void hideMembers(java.lang.String membersToHide)
                 throws ServerBloxException

Specifies the members to hide. This adds to the list of members already hidden, therefore previously hidden members will remain hidden.

Parameters:: membersToHide - A comma delimited string specifying the members to hide. The members are grouped by dimension. Each group of members is proceeded by the name of the dimension followed by a colon. Separate each group with a semicolon. For example, DimensionName1:MemberNameA,MemberNameB; DimensionName2:MemberNameC,MemberNameD;
Throws:: ServerBloxException - When an error occurred while trying to hide members.

hideMembers

public void hideMembers(Member[] members)
                 throws ServerBloxException

Specifies the members to hide. This adds to the list of members already hidden, therefore previously hidden members will remain hidden. This method is relevant for use with multi-dimensional data sources.

Parameters:: members - An array containing the members to hide.
Throws:: ServerBloxException - When an error occurred while trying to hide members

getHiddenMembers

public Column getHiddenMembers(RDBMetaData rdbMetaData,
                               int i)
                        throws ServerBloxException,
                               java.lang.ArrayIndexOutOfBoundsException

Returns the hidden column (member) with the specifed index for the array of hidden columns (members). Use this method to return the hidden members from a relational data source.

Parameters:: rdbMetaData - The relational metadata from which the members should be retrieved. If this parameter is null, then the members are generated from a new metadata object.; i - The index of the hidden member.
Returns:: A hidden member with specified index.
Throws:: ServerBloxException - When unable to connect to the database or when the metadata is corrupted.; java.lang.ArrayIndexOutOfBoundsException - When the index is negative, or greater than or equal to the total number of hidden members.

getHiddenMembers

public Column[] getHiddenMembers(RDBMetaData rdbMetaData)
                          throws ServerBloxException

Returns an array containing the hidden colummns (members). Use this method to return the hidden columns (members) from a relational data source.

Parameters:: rdbMetaData - The relational metadata from which the members should be retrieved. If this parameter is null, then the members are generated from a new metadata object.
Returns:: An array of hidden members.
Throws:: ServerBloxException - When unable to connect to the database or when the metadata is corrupted.

setHiddenMembers

public void setHiddenMembers(Column[] columns)
                      throws ServerBloxException

Hides the specified columns (members). One member of each dimension must remain in the grid. If you specify for all members of a dimension to be hidden, the last member specified will not be hidden. All previous hidden members will longer be hidden. This method is relevant for use with relational data sources.

Parameters:: columns - Array of members to hide. This array cannot be null.
Throws:: ServerBloxException - When an error occurred while trying to set hidden members.

showMembers

public void showMembers(java.lang.String membersToShow)
                 throws ServerBloxException

Shows the previously hidden members in the specified string.

Parameters:: membersToShow - A comma delimited string specifying the members to show. The members are grouped by dimension. Each group of members is proceeded by the name of the dimension followed by a colon. Separate each group with a semicolon. For example, DimensionName1:MemberNameA,MemberNameB; DimensionName2:MemberNameC,MemberNameD;
Throws:: ServerBloxException - When an error occurred while trying to show members

showMembers

public void showMembers(Column[] columns)
                 throws ServerBloxException

Shows the previously hidden columns (members) in the specified array. This method is relevant for use with a relational data source.

Parameters:: columns - An array specifying the members to show. The array cannot be null.
Throws:: ServerBloxException - When an error occurred while trying to show members

hideMembers

public void hideMembers(Column[] columns)
                 throws ServerBloxException

Hides the columns (members) in the specified array. This adds to the list of members already hidden, therefore previously hidden members remain hidden. This method is relevant for use with relational data sources.

Parameters:: columns - An array containing the members to hide.
Throws:: ServerBloxException - When an error occurred while trying to hide members.

setHiddenTuples

public void setHiddenTuples(java.lang.String selectedTuples)
                     throws ServerBloxException

Sets hiddenTuples parameter to the specified selectedTuples it will replace the existing hiddenTuples

Parameters:

selectedTuples - - The hidden tuple list is in the form of the following example:

 {Year,Product:Qtr3,Audio;Qtr4,Visual}, {Accounts, Market:Profit,East}

If there is only one group of hidden tuples, the curly braces are optional. Each tuple list contains the dimension names separated by commas, followed by a colon, followed by the list of tuples. Each member of the tuple is separated by a comma and each tuple is separated by a semi-colon.

Throws:

ServerBloxException

showTuples

public void showTuples(java.lang.String selectedTuples)
                throws ServerBloxException

Shows or unhides specified selectedTuples if they are hidden.

Parameters:

selectedTuples - - The hidden tuple list is in the form of the following example:

 {Year,Product:Qtr3,Audio;Qtr4,Visual}, {Accounts, Market:Profit,East}

Throws:

ServerBloxException

showOnlyTuples

public void showOnlyTuples(java.lang.String selectedTuples)
                    throws ServerBloxException

Shows only the specified selectedTuples.

Parameters:

selectedTuples - - The hidden tuple list is in the form of the following example

{Year,Product:Qtr3,Audio;Qtr4,Visual}, {Accounts, Market:Profit,East}

Throws:

ServerBloxException

showOnlyTuples

public void showOnlyTuples(Tuple[] tuples)
                    throws ServerBloxException

Show only the specified selectedTuples.

Parameters:: tuples - - The list of tuples to show
Throws:: ServerBloxException

hideTuples

public void hideTuples(java.lang.String selectedTuples)
                throws ServerBloxException

Hides specified tuples

Parameters:

selectedTuples - - The hidden tuple list is in the form of the following example:

 {Year,Product:Qtr3,Audio;Qtr4,Visual}, {Accounts, Market:Profit,East}

Throws:

ServerBloxException

deleteBookmark

public void deleteBookmark(int visibility,
                           java.lang.String owner,
                           java.lang.String bookmarkName)
                    throws ServerBloxException

Deprecated. Use com.alphablox.internal.common.peer.BookmarkImpl#delete()

Throws:: ServerBloxException
See Also:: BookmarksBlox, com.alphablox.internal.common.peer.BookmarkImpl

listBookmarks

public java.lang.String[][] listBookmarks(int visibility,
                                          java.lang.String owner)
                                   throws ServerBloxException

Deprecated. Use BookmarksBlox.listBookmarks(), BookmarksBlox.listBookmarks(com.alphablox.blox.repository.BookmarkMatcher)

Throws:: ServerBloxException
See Also:: BookmarksBlox, com.alphablox.internal.common.peer.BookmarkImpl, BookmarkMatcher

renameBookmark

public void renameBookmark(int visibility,
                           java.lang.String owner,
                           java.lang.String oldBookmarkName,
                           java.lang.String newBookmarkName,
                           java.lang.String description)
                    throws ServerBloxException

Deprecated. Use BookmarksBlox.getBookmark(Blox, String, String), BookmarksBlox.getBookmark(String, String, String, String, String), com.alphablox.internal.common.peer.BookmarkImpl#setName(String), com.alphablox.internal.common.peer.BookmarkImpl#saveAll()

Throws:: ServerBloxException
See Also:: BookmarksBlox, com.alphablox.internal.common.peer.BookmarkImpl

restoreBookmark

public void restoreBookmark(int visibility,
                            java.lang.String owner,
                            java.lang.String bookmarkName)
                     throws ServerBloxException

Deprecated. Use loadBookmark(int, String, String)

Restores the specified bookmark. The user must have read permissions.

Parameters:: visibility - The visibility level of the bookmark. The valid int values are RepositoryBlox.VISIBILITY_GROUP, RepositoryBlox.VISIBILITY_APPLICATION, and RepositoryBlox.VISIBILITY_PRIVATE; owner - The name of the group containing the bookmark to restore. If the specified visibility is not RepositoryBlox.VISIBILITY_GROUP, this parameter is ignored.; bookmarkName - The name of the bookmark to restore.
Throws:: ServerBloxException - When an error occurs while trying to restore the bookmark.

loadBookmark

public void loadBookmark(int visibility,
                         java.lang.String owner,
                         java.lang.String bookmarkName)
                  throws ServerBloxException

Loads a bookmark into this Blox. The user must have read permissions.

Specified by:: loadBookmark in interface BookmarkableBlox

Parameters:: visibility - The visibility level of the bookmark. The valid int values are RepositoryBlox.VISIBILITY_GROUP, RepositoryBlox.VISIBILITY_APPLICATION, and RepositoryBlox.VISIBILITY_PRIVATE; owner - The name of the group containing the bookmark to restore. If the specified visibility is not RepositoryBlox.VISIBILITY_GROUP, this parameter is ignored.; bookmarkName - The name of the bookmark to restore.
Throws:: ServerBloxException - When an error occurs while trying to restore the bookmark.

loadBookmark

public void loadBookmark(Bookmark bookmark)
                  throws ServerBloxException

Specified by:: loadBookmark in interface BookmarkableBlox

Throws:: ServerBloxException

saveBookmark

public void saveBookmark(int visibility,
                         java.lang.String owner,
                         java.lang.String bookmarkName,
                         java.lang.String description)
                  throws ServerBloxException

Saves a bookmark. The user must have write permissions.

Specified by:: saveBookmark in interface BookmarkableBlox

Parameters:: visibility - The visibility level of the bookmark. The valid int values are RepositoryBlox.VISIBILITY_GROUP, RepositoryBlox.VISIBILITY_APPLICATION, and RepositoryBlox.VISIBILITY_PRIVATE; owner - The name of the group to which to save the bookmark. If the specified visibility is not RepositoryBlox.VISIBILITY_GROUP, this parameter is ignored.; bookmarkName - The name for the bookmark.; description - The description for the bookmark.
Throws:: ServerBloxException - When an error occurs while trying to save the bookmark.
See Also:: BookmarksBlox

saveBookmarkHidden

public void saveBookmarkHidden(int visibility,
                               java.lang.String owner,
                               java.lang.String bookmarkName,
                               java.lang.String description)
                        throws ServerBloxException

Throws:: ServerBloxException

addDrillThroughFilter

public void addDrillThroughFilter(DrillThroughFilter filter)
                           throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removeDrillThroughFilter

public void removeDrillThroughFilter(DrillThroughFilter filter)
                              throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addDrillDownFilter

public void addDrillDownFilter(DrillDownFilter filter)
                        throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removeDrillDownFilter

public void removeDrillDownFilter(DrillDownFilter filter)
                           throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addDrillUpFilter

public void addDrillUpFilter(DrillUpFilter filter)
                      throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removeDrillUpFilter

public void removeDrillUpFilter(DrillUpFilter filter)
                         throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addPivotFilter

public void addPivotFilter(PivotFilter filter)
                    throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removePivotFilter

public void removePivotFilter(PivotFilter filter)
                       throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addKeepOnlyFilter

public void addKeepOnlyFilter(KeepOnlyFilter filter)
                       throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removeKeepOnlyFilter

public void removeKeepOnlyFilter(KeepOnlyFilter filter)
                          throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addRemoveOnlyFilter

public void addRemoveOnlyFilter(RemoveOnlyFilter filter)
                         throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removeRemoveOnlyFilter

public void removeRemoveOnlyFilter(RemoveOnlyFilter filter)
                            throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addHideOnlyFilter

public void addHideOnlyFilter(HideOnlyFilter filter)
                       throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removeHideOnlyFilter

public void removeHideOnlyFilter(HideOnlyFilter filter)
                          throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addShowOnlyFilter

public void addShowOnlyFilter(ShowOnlyFilter filter)
                       throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removeShowOnlyFilter

public void removeShowOnlyFilter(ShowOnlyFilter filter)
                          throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addShowAllFilter

public void addShowAllFilter(ShowAllFilter filter)
                      throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removeShowAllFilter

public void removeShowAllFilter(ShowAllFilter filter)
                         throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addCollapseFilter

public void addCollapseFilter(CollapseFilter filter)
                       throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removeCollapseFilter

public void removeCollapseFilter(CollapseFilter filter)
                          throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addExpandFilter

public void addExpandFilter(ExpandFilter filter)
                     throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removeExpandFilter

public void removeExpandFilter(ExpandFilter filter)
                        throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addMemberSelectFilter

public void addMemberSelectFilter(MemberSelectFilter filter)
                           throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removeMemberSelectFilter

public void removeMemberSelectFilter(MemberSelectFilter filter)
                              throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addSwapAxisFilter

public void addSwapAxisFilter(SwapAxisFilter filter)
                       throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removeSwapAxisFilter

public void removeSwapAxisFilter(SwapAxisFilter filter)
                          throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addQueryFilter

public void addQueryFilter(QueryFilter filter)
                    throws ServerBloxException

Deprecated. Use addEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

removeQueryFilter

public void removeQueryFilter(QueryFilter filter)
                       throws ServerBloxException

Deprecated. Use removeEventFilter()

Parameters:: filter -
Throws:: ServerBloxException

addEventFilter

public void addEventFilter(DataFilter dataFilter)
                    throws ServerBloxException

Addes the dataFilter to the list of filters to be notified prior to data events being processed. The filter will be notified of all event filters interfaces that it implements. The dataFilter has a chance to call event.cancelEvent() on the FilterEvent which will cause the event not to be processed.

Parameters:: dataFilter -
Throws:: ServerBloxException

removeEventFilter

public void removeEventFilter(DataFilter dataFilter)
                       throws ServerBloxException

Removes the dataFilter from the list of filters to notify prior to data events being processed.

Parameters:: dataFilter -
Throws:: ServerBloxException

setQueryPassthrough

public void setQueryPassthrough(IResultSetHandler passThroughHandler)
                         throws ServerBloxException

For relational data only. Sets a result set handler that allows bypassing the normal DB2/Alphablox data stack. Set to null returns the data blox to normal processing. See IResultSetHandler for more details.

Parameters:: passThroughHandler -
Throws:: ServerBloxException

getQueryPassthrough

public IResultSetHandler getQueryPassthrough()
                                      throws ServerBloxException

Applies to relational data only. Gets the current result set handler. Can return null.

Throws:: ServerBloxException

loadRDBResultSet

public void loadRDBResultSet(java.sql.ResultSet storeProcedureResultSet)
                      throws ServerBloxException,
                             DataException

Throws:: ServerBloxException; DataException

setCommentsBlox

public void setCommentsBlox(CommentsBlox commentsBlox)
                     throws ServerBloxException

Throws:: ServerBloxException

getCommentsBlox

public CommentsBlox getCommentsBlox()

getCalculations

public Calculation[] getCalculations()
                              throws ServerBloxException

Throws:: ServerBloxException

addDataChangedEventListener

public void addDataChangedEventListener(DataChangedEventListener listener)

freeConnection

public void freeConnection()
                    throws ServerBloxException,
                           BadConnectionException

Frees this DataBlox's connection and puts it back onto the connection pool. For Microsoft Analysis Services data sources only.

Throws:: ServerBloxException; BadConnectionException

removeDataChangedEventListener

public void removeDataChangedEventListener(DataChangedEventListener listener)

getASCSConnection

public java.lang.Object getASCSConnection()

This method is used only by the Symphony adapter. It is not meant for public consumption.

Returns:: Object

getExternalMDConnection

public java.lang.Object getExternalMDConnection()

This method is only used by implementations of external data sources and is not meant for public consumption.

updateResultSet

public void updateResultSet()
                     throws ServerBloxException,
                            DataException

Applies the properties to the textual or serialized query (depending on which query is most recent) and creates a new result set. Through various events and listeners all the other Blox will know that the result set has been updated and update themselves accordingly. Before calling updateResultSet(), if the DataBlox needs to be connected, it will automatically connect first.

Throws:: ServerBloxException; DataException

setMDXForDimensions

public void setMDXForDimensions(java.util.HashMap map)
                         throws ServerBloxException

Sets the MDX set statement for particular dimensions. Each instance of the hashmap consists of a key which is the unique name of the dimension and a value which is a MDX statement representing a set of members for a particular dimension. For example, key = "[Product]"
value = "{[Product].[All Products].[L0].[All Products].children}"

Parameters:: map - Collection of MDX set statements for specific dimensions.
Throws:: ServerBloxException

getMDXForDimensions

public java.util.HashMap getMDXForDimensions()
                                      throws ServerBloxException

Returns the HashMap of MDX set statements for a particular dimensions.

Returns:: A HashMap of MDX set statements for a particular dimensions.
Throws:: ServerBloxException

Overview

Package

Class

Tree

Deprecated

Index

Help

IBM Alphablox V9.5.1 Blox API Reference

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

© Copyright International Business Machines Corporation 2007. All rights reserved
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

com.alphablox.blox Class DataBlox

PARENT_DEFAULT

PARENT_FIRST

PARENT_LAST

DataBlox

deleteBlox

addBookmarkLoadFilter

removeBookmarkLoadFilter

addBookmarkSaveFilter

removeBookmarkSaveFilter

addBookmarkRenameFilter

removeBookmarkRenameFilter

addBookmarkDeleteFilter

removeBookmarkDeleteFilter

getListenerClasses

getFilterClasses

init

setProperty

setInitialProperty

isTextualQueryEnabled

isApplyPropertiesAfterBookmark

getDataSourceName

getCatalog

getSchema

getUserName

isAASUserAuthorizationEnabled

getQuery

getSelectableSlicerDimensions

getSelectableSlicerDimensions

getMergedDimensions

isOnErrorClearResultSet

getDrillDownOption

isDrillKeepSelectedMember

isDrillRemoveUnselectedMembers

isPerformInAllGroups

isUseAliases

getAliasTable

getMemberNameRemoveSuffix

getMemberNameRemovePrefix

isSuppressMissingRows

isSuppressMissingColumns

isSuppressMissing

isSuppressNoAccess

isSuppressZeros

isSuppressDuplicates

getCalculatedMembers

getMergedHeaders

getBookmarkFilter

getParentFirst

getRowSort

getColumnSort

getDimensionRoot

getDimensionRoot

isEnableKeepRemove

isEnableShowHide

isLeafDrillDownAvailable

getHiddenMembers

getHiddenTuples

isAutoConnect

isAutoDisconnect

isConnectOnStartup

isUseOlapDrillOptimization

isShowSuppressDataDialog

isRetainSlicerMemberSet

getProvider

isInternalSortEnabled

isShowShortHierarchyNames

setRetainSlicerMemberSet

setTextualQueryEnabled

setApplyPropertiesAfterBookmark

setDataSourceName

setCatalog

setSchema

setUserName

setProvider

setInternalSortEnabled

setAASUserAuthorizationEnabled

setPassword

setQuery

setQueryModel

com.alphablox.blox
Class DataBlox