new bcdui.component.cube.Cube(args)
component/cube/cubeCreate.js, line 120
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
args |
The parameter map contains the following properties:
|
Extends
Members
-
constantchainLoadedStatusbcdui.core.status.ChainLoadedStatus
-
A status reached when the chain model is ready.
-
constantchainLoadingFailedbcdui.core.status.ChainStylesheetLoadingFailed
-
This (final) status is reached when the chain model could not be loaded.
-
constantchainStylesheetLoadingFailedbcdui.core.status.ChainStylesheetLoadingFailed
-
This (final) status is reached when the loading of a chain stylesheet has failed.
-
constantidstring
-
A globally unique id of the object. DataProviders do also register themselves at bcdui.factory.objectRegistry when an id is provided to the constructor. This id is only needed in declarative contexts, like jsp or, when a DataProvider is accessed in a xPath like
. If not provided in the constructor, a random id starting with 'bcd' is set, but the object is not automatically registered. -
constantinitializedStatusbcdui.core.status.InitializedStatus
-
This status is set when the constructor has set all parameters.
-
constantloadFailedStatusbcdui.core.status.LoadFailedStatus
-
This (final) status is reached when an error occurs during the loading or transformation process.
-
constantloadingStatusbcdui.core.status.LoadingStatus
-
The status code activated as soon as the loading begins.
-
constantsavedStatus
-
Example
if( model.getStatus() === model.savedStatus ) ... -
constantsaveFailedStatus
-
-
constanttransformedStatusbcdui.core.status.TransformedStatus
-
The status code is reached when everything is finished and the transformation result is available. This is the final state of the TransformationChain process if no error occurs.
-
constanttransformFailedStatusbcdui.core.status.TransformFailedStatus
-
The status code is reached when a transformation failed and operation cannot proceed
-
constanttransformingStatusbcdui.core.status.TransformingStatus
-
As long as this status is active the XSLT transformations are running.
-
constantwaitingForParametersStatusbcdui.core.status.WaitingForParametersStatus
-
This status is kept as long as the transformation chain is waiting for parameters to load and when the chain has already loaded.
Methods
-
inherited addDataProvider(newDataProvider, newName){bcdui.core.DataProvider}
-
Adds a new data provider to the transformation chain. If there is already a data provider with the given name it is replaced.
Name Type Description newDataProviderObject the new dataprovider which should be added newNamestring optional an optional new name for the provider. if given an alias will be created Returns:
Type Description bcdui.core.DataProvider The old data provider registered under the name or null if there has not been any. -
inherited addStatusListener(args)
-
Listen for any status to be reached. For use cases with the ready status (by far the most common), see onReady() and onceReady() convenience functions.
Name Type Description argsfunction | StatusListener | AddStatusListenerParam Either a function executed on all status transitions or a parameter map AddStatusListenerParam -
inherited debugIsWaitingFor(){string}
-
Returns:
Type Description string Human readable message, which DataProviders, this DataProvider depends on, are not currently in ready state -
inherited debugStatus(){string}
-
Returns:
Type Description string Human readable message about the current state state -
inherited execute(args)
-
Name Type Description argsboolean | ExecuteParam either true for forced or parameter map -
inherited fetchData(){Promise}
-
asynchronously fetch data for this data provider.
Returns:
Type Description Promise resolving once data has been loaded, first argument is this instance Example
new bcdui.core.SimpleModel("data.xml").fetchData().then((dp)=>{ console.info(dp.getData()); }) -
inherited fire()
-
This informs modification listeners, registered via onChange(args), that a change set was completed and data is consistent again.
Example
// Use of data modification events var model = new bcdui.core.StaticModel({ data: { value: 3 } }); model.execute(); model.onChange( function(m) { console.log(m.getData().value); }); model.getData().value ++; model.fire(); // console prints '4' -
getConfigModel(){bcdui.core.DataProvider}
component/cube/cubeCreate.js, line 258 -
Returns:
Type Description bcdui.core.DataProvider configuration model of the cube -
inherited getData(){*}
-
A getter for the document produced by the transformation chain.
Returns:
Type Description * The output of the last transfomration in the chain if it does not produce HTML (output="html"). -
inherited getDataProviderByName(name){bcdui.core.DataProvider}
-
Name Type Description nameString Returns:
Type Description bcdui.core.DataProvider returns the parameter of the given name -
getEnhancedConfiguration(){bcdui.core.DataProvider}
component/cube/cubeCreate.js, line 265 -
Returns:
Type Description bcdui.core.DataProvider Enhanced configuration model of the cube -
inherited getFailedStatus(){Array.<bcdui.core.Status>}
-
Returns:
Type Description Array.<bcdui.core.Status> Returns all statuses indicating a failure -
inherited getName(){string}
-
Getter for the name of the data provider. This name is for example used to set parameters names of a bcdui.core.TransformationChain.
Returns:
Type Description string The name of the data provider. This name should be unique within the scope it is used and is usually not globally unique (as the id). -
inherited getPrimaryModel(){bcdui.core.DataProvider}
-
Getter for the primary model of the chain. The first transformation of the chain takes a document as input. This document comes from the primary model.
Returns:
Type Description bcdui.core.DataProvider The model the first transformation in the chain is running on. -
inherited getReadyStatus(){Status}
-
The ready status for the transformation chain is reached as soon as all transformations are finished.
The status transitions of the class are as follows:
Initialized All variables have been initialized. Loading Start loading chain document. ChainLoaded The chain document has been loaded. Start loading chain stylesheets. WaitingForParameters Chain stylesheets loaded. Waiting for parameter data providers (execute). Transforming The chain stylesheets are running. Transformed The output has been generated. (ready) Returns:
Type Description Status The transformed status. -
inherited getStatus(){bcdui.core.Status}
-
Getter for the status of this object. See bcdui.core.status for possible return values.
Returns:
Type Description bcdui.core.Status The current status. -
inherited getTargetHtml()
-
Return the target html element where the renderer places its output
-
inherited hasFailed(){boolean}
-
Tests if the object has reached a failure status. These status codes are returned by the "getFailedStatus" method.
Returns:
Type Description boolean True, if the object's process has failed. -
inherited isClean(){boolean}
-
True, if DataProvider is ready and there are no uncommitted write transactions, see isReady() and fire().
Returns:
Type Description boolean -
inherited isReady(){boolean}
-
Tests if the current state is the readyStatus. This status is the same status as returned by "getReadyStatus".
Returns:
Type Description boolean True, if the object is ready. -
inherited onceReady(listenerObject)
-
Name Type Description listenerObjectfunction | OnceReadyParam Either a function to be called on ready status (i.e. onSuccess) or a parameter map OnceReadyParam. To listen for other states see addStatusListener() Example
myModel.onceReady({onSuccess: myCallback, executeIfNotReady: true}) -
inherited onChange(listenerObject, trackingXPath)
-
Name Type Description listenerObjectfunction | OnChangeParam Either a function to be called after changes or a parameter map OnChangeParam. Listeners can be removed with removeDataListener() trackingXPathstring optional xPath to monitor to monitor for changes -
inherited onReady(listenerObject)
-
Name Type Description listenerObjectfunction | OnReadyParam Either a function to be called on ready status (i.e. onSuccess) or a parameter map OnReadyParam. To listen for other states see addStatusListener() Example
myModel.onReady({onSuccess: function(){ console.log("ready") }, executeIfNotReady: true, onlyFuture: true}) -
inherited promptData()
-
Convenience method for debugging showing data in a prompt for copy-and-paste
-
inherited query(xPath, fillParams)
-
Reads a single node from a given xPath
Name Type Description xPathstring xPath to query fillParamsObject optional array or object holding the values for the dot placeholders in the xpath. Values with "'" get 'escaped' with a concat operation to avoid bad xpath expressions Returns:
single node or null if query fails -
inherited queryNodes(xPath, fillParams)
-
Get node list from a given xPath
Name Type Description xPathstring xPath to query fillParamsObject optional array or object holding the values for the dot placeholders in the xpath. Values with "'" get 'escaped' with a concat operation to avoid bad xpath expressions Returns:
node list or empty list if query fails -
inherited read(xPath, fillParams, defaultValue)
-
Reads the string value from a given xPath (or optionally return default value).
Name Type Description xPathstring xPath pointing to value (can include dot template placeholders which get filled with the given fillParams) fillParamsObject optional array or object holding the values for the dot placeholders in the xpath. Values with "'" get 'escaped' with a concat operation to avoid bad xpath expressions defaultValuestring optional default value in case xPath value does not exist Returns:
text value stored at xPath (or null if no text was found and no defaultValue supplied) -
inherited reloadStylesheets()
-
Start the loading process of the stylesheets and executes the transformations again.
-
inherited remove(xPath, fillParams, fire)
-
Deletes data at a given xPath from the model
Name Type Default Description xPathstring xPath pointing to the value fillParamsObject optional array or object holding the values for the dot placeholders in the xpath. Values with "'" get 'escaped' with a concat operation to avoid bad xpath expressions fireboolean false optional if true a fire is triggered to notify data modification listener -
inherited removeDataListener(listenerObject)
-
Name Type Description listenerObjectstring | function | RemoveDataListenerParam Either a listener function or id or a parameter map RemoveDataListenerParam. Listeners are added with onChange() -
inherited removeStatusListener(args)
-
Name Type Description argsfunction | StatusListener | RemoveStatusListenerParam The listener to be removed. This can either be a function or a StatusListener or a parameter map RemoveStatusListenerParam. -
inherited sendData()
-
Sends the current data to the original URL
-
inherited serialize()
-
Serialize dataprovider's data if available
Returns:
String containing the serialized data -
inherited setPrimaryModel(primaryModel)
-
Adds a new data provider to the list which becomes the new primary model of the transformation chain.
Name Type Description primaryModelbcdui.core.DataProvider the new primary model of the transformation chain. -
inherited setStatus(args)
-
Name Type Description argsStatus -
inherited setTargetHtml(targetHtmlElement)
-
Sets the target html element where the renderer places its output
Name Type Description targetHtmlElementHtmlElement target html element -
inherited toString(){String}
-
Returns:
Type Description String String representation of the chain. -
inherited write(xPath, fillParams, value, fire)
-
Set a value to on a certain xPath and create the xPath where necessary. This combines Element.evaluate() for a single node with creating the path where necessary. It will prefer extending an existing start-part over creating a second one. After the operation the xPath (with the optional value) is guaranteed to exist (pre-existing or created or extended) and the addressed node is returned.
Name Type Default Description xPathstring xPath pointing to the node which is set to the value value or plain xPath to be created if not there. It tries to reuse all matching parts that are already there. If you provide for example "/n:Root/n:MyElem/@attr2" and there is already "/n:Root/n:MyElem/@attr1", then "/n:Root/n:MyElem" will be "re-used" and get an additional attribute attr2. Many expressions are allowed, for example "/n:Root/n:MyElem[@attr1='attr1Value']/n:SubElem" is also ok. By nature, some xPath expressions are not allowed, for example using '//' or "/n:Root/n:MyElem/[@attr1 or @attr2]/n:SubElem" is obviously not unambiguous enough and will throw an error. This method is Wrs aware, use for example '/wrs:Wrs/wrs:Data/wrs:*[2]/wrs:C[3]' as xPath and it will turn wrs:R[wrs:C] into wrs:M[wrs:C and wrs:O], see Wrs format. (can include dot template placeholders which get filled with the given fillParams) fillParamsObject optional array or object holding the values for the dot placeholders in the xpath. Values with "'" get 'escaped' with a concat operation to avoid bad xpath expressions Example: bcdui.wkModels.guiStatus.write("/guiStatus:Status/guiStatus:ClientSettings/guiStatus:Test[@caption='{{=it[0]}}' and @caption2='{{=it[1]}}']", ["china's republic", "drag\"n drop"]) valuestring optional Optional value which should be written, for example to "/n:Root/n:MyElem/@attr" or with "/n:Root/n:MyElem" as the element's text content. If not provided, the xPath contains all values like in "/n:Root/n:MyElem[@attr='a' and @attr1='b']" or needs none like "/n:Root/n:MyElem" fireboolean false optional If true a fire is triggered to inform data modification listeners Returns:
The xPath's node or null if dataProvider isn't ready