Class Reference
IRIS for UNIX 2024.1.2
|
Class Reference
IRIS for UNIX 2024.1.2
|
|
|
Private
Storage
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DeepSee Architect page.
|
|
|
|
|
|
If this page has multiple views, this is its initial display mode.
Docbook ID for this page.
Displayed name of this page.
All Analytics pages require %DeepSee_Portal USE.
|
|
Local copy of cube model object.
If true, user can modify (non-read-only) cube definitions, otherwise they can only view.
This will be true if the cube being loaded logged an error on the last compile.
Class name of Cube being viewed. This is determined from the cube name.
DependsOn for cube class. If provided, this is used as the DependsOn value of the generated cube. If not, the sourceClass for the cube is used. This is handled seperately from json.
Description of Cube being viewed. This is determined from the cube name.
Domain of Cube being viewed. This is handled seperately from json.
Name of Cube (with extension).
Name of Cube being viewed.
ID (index number, 0-based) of current selected item.
Type of the current selected item.
Data source. This is a copy of the value in the cube model.
Whether to expand all elements under each type. When user clicks Collapse All then this is set to 0. At end of renderTable it is set to 2.
Name of the inherited cube, if it exists.
If true, user cannot modify the current cube definition.
|
|
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
This class method callback is called just before the server-side page object is created.
This callback is called at the end of the HTML HEAD section of the page.
Get the (localized) name of the page.
Get the product name for the page.
Get the (localized) title string for the page. This should be implemented in a subclass.
Check to see if the current cube has a build lock, indicating there is an update underway
Draw the contents of the Table Header (the region between the diagram and the table).
Return an index of the currently used fact numbers in the compiled metadata. This index is returned as a JSON object which takes the form:
Set tCompiledFactNums = { "measures":{ "[MEASURES].[NAME]":"M1" }, "dimensions":{ "[DIM].[HIER].[LEVEL]":"2" }, "relationships":{ "[RELNAME]":"3" } }
Get Cube definition for JSON provider.
Provide contents of the data source tree.
Get the inherited Cube definition for JSON provider.
Return the internal name of the current document, including the three letter extension in upper-case. For example, MyPackage.MyClass.CLS would be the internal name for the class MyPackage.MyClass.
This method returns the following values via proxy object:
1) IsDate is set to 1 if the property type is a date format. Verified against the ODBC type.
2) IsNumeric is set to 1 if the property type is any kind of numeric format. Verified against the ODBC type.
3) Caption is the property's parameter CAPTION. 4) SQLNames in the fashion of Prop1 -> Prop2 -> Prop3. 5) IsBoolean is set to 1 if the property type is a boolean. Verified against the ODBC type.
Produces a list of Time level class delimited by commas.
Return Data Connector list
Draw additional stuff in the ribbon bar
Get information to display in the ribbon bar.
Object submit handler JSON provider. This is called when the client submits the Cube definition.
Add a new item to the model and select it. Designed for adding an overriden item from an inherited cube
Invoke dialog to add a new item to the model.
Add a new item to the model and select it.
Remember the current state in the undo buffer.
Adjust sizes of components on the page.
This will compare the current cube model with the compiled definition. It will return two arrays definedMsrNums, definedFactNums containing the known factNumbers that have been used in measures and levels/relationships, respectively. For those items that have factNumbers assigned, the mapping between column sources and factNumbers is returned in sourceIndex. Anything that has been modified in the current session or did not previously have a compiled fact number will be returned in the missing index.
If factNumbers of the model elements have not been explicitly set but have been previously assigned internally via the compile, the factNumbers in the current cube model will be set to those numbers. In the case of inherited cubes, only the compiled factNumbers of the supercube will be held constant.
user modified DependsOn. Since it is not part of json, handle it seperately.
Set textarea description back into the text description field.
Apply changes from detail form.
user modified Domain. Since it is not part of json, handle it seperately.
Examine the cube definition object. If the cube's namedFactNums property is set, automatically assign a factNumber to any structural element that does not already have one defined.
Invoke class finder dialog. popupName="sourceclasses" or "cubes"
Rebuild the cube.
Return true if it is possible to undo an action
Test if the user has build privileges.
Test if the user has write privilege.
Cancel changes from detail form.
Launch the data source dialog.
Launch the cube finder dialog.
This function takes care of certain fields when their values are changed.
Change Undo button state and View button state (opposite of Undo button)
User checked/unchecked the Use SQL field
Pass in an item and type and test if the settings substantial to data storage definition (eg: values, type, etc.) have changed.
Handle a source control menu selection.
Create a clone of the given object.
Timeout for the timer managing the compile button
Compile the cube.
Callback to limit horizontal resizing
Callback to limit vertical resizing
Create new dimension. If drag & drop, sourceprop passed in will not be null.
Create new hierarchy.
Create new level If drag & drop, newsource passed in will not be null.
Create new listing object. If drag & drop, fieldName passed in will not be null.
Create new listing object. If drag & drop, fieldExpression passed in will not be null.
Create a new measure. 'type' passed in is 'number', 'date', 'boolean' or 'string'
Create new property. If drag & drop, newsource passed in will not be null.
Create new relationship object.
Open Documatic page to view all details (if user has not modified anything).
Toggle to show/hide Description textarea; set what's in text into textarea.
Invoke dialog to edit certain items: RangeExpression, FormatString, SourceProperty, SourceExpression, CubeResource, ListingResource, ListingField.
Enable/disable a row in the table.
Callback to wrap up window resize event
This method is called from child pages (reorder) to get a live javaScript object of the cube
Find the row number in the table for the given model item. This must be called after the table has been rendered.
Find the row number in the table for the given model item name. If itemGroup is defined, return the first occurence of name within the particular group of model items. This must be called after the table has been rendered.
Find the css class for the given row type.
Get the jsonProvider object on the client.
Return the cube definition object.
Return the current name of the class/object being modified.
Given the base name, return the new name with proper index number
Given the base name, return the new name with proper index number
Return the cube definition object for the inherited cube.
Given the base name, return the new name with proper index number
Given the objects representing a dimension and a level, produce a string that can be used as an identifier in the sourceIndex when determining shared storage for fact table columns.
Return new list name. Starting "New_listing1".
Return new list name. Starting "New_listing1".
Given the base name, return the new name with proper index number
Fetch the list of dimensions, measures, and relationships that are known to have been modified since the last build.
Get the title string to add to the locator row. This should be implemented in a subclass.
Given the base name, return the new name with proper index number
Return the current selected item.
Report the supported functions for a given calendar.
Return a list of iKnow measures
If it exists, search the inherited cube object for the same logical definition as item.
Invoke dialog to add a new cube.
Callback method invoked after we have successfully loaded the current document.
This client event is fired when the a popup page launched from this page fires an action.
Adjust sizes of components on the page.
Add check to ensure that we correctly load documents on the client when source control hooks are in use. Also set up a timer to ensure we don't hit timeouts while editing documents in Studio, as well as When in Studio mode, also detect whether we are running IE10, as we need to save documents differently if that is the case.
Called by the Override button to override an inherited item in the local cube definition.
Remove a row from the table.
Render the actual items in a given group type in the table. This does not draw the title bars.
Update the contents of the model table.
Invoke dialog to reorder certain elements of the model.
User click on a row in the table.
method for when mouse out
method for when user mouse over a row in the table
Save the cube.
Do save now. This method is called from compile also.
Select a row in the table.
Helper method: select an item, make sure it is visible and give focus to the details panel.
This method is responsible for controlling the Compile button's availability according to the build lock.
Set the dataSource for the current cube.
This prevents a user from making changes to the item details using the cover pane.
Set or Clear all isModified flags in the cube definition according to value.
Set the modified flag for the page.
method used by Source Control to set the value of the readOnly flag.
Do the actual work of updating the view to match the current view mode.
Callback to initiate window resize event
Drop handler for model table.
User click on disclosure icon in table.
user clicked Expand All (flag=1) or Collapsed All (flag=0).
Toggle display of settings (property tabs) box.
Show analyzer in a new window.
Show query tool in a new window.
Undo the most recent change.
Update the contents of the model table.
Open CubeView page to view all details (if user has not modified anything).