Child pages
  • JSDataSourceNode

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{div:style=display:none} DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING. THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR{div} {div:id=description}{div}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[JSCalculation]{td}{td}[#getCalculation]\(name) Get an existing calculation for the datasource node.{td}{tr}{tbody}{tbody}{tr}{td}[JSCalculation]\[]{td}{td}[#getCalculations]\() Gets all the calculations for the datasource node.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getDataSource]\() Get the data source for this node.{td}{tr}{tbody}{tbody}{tr}{td}[JSMethod]{td}{td}[#getMethod]\(name) Get an existing foundset method for the datasource node.{td}{tr}{tbody}{tbody}{tr}{td}[JSMethod]\[]{td}{td}[#getMethods]\() Gets all the foundset methods for the datasource node.{td}{tr}{tbody}{tbody}{tr}{td}[JSCalculation]{td}{td}[#newCalculation]\(code) Creates a new calculation for the given code, the type will be the column where it could be build on (if name is a column name), else it will default to JSVariable.{td}{tr}{tbody}{tbody}{tr}{td}[JSCalculation]{td}{td}[#newCalculation]\(code, type) Creates a new calculation for the given code and the type, if it builds on a column (name is a column name) then type will be ignored.{td}{tr}{tbody}{tbody}{tr}{td}[JSMethod]{td}{td}[#newMethod]\(code) Creates a new foundset method with the specified code.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#removeCalculation]\(name) Removes the calculation specified by name.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#removeMethod]\(name) Removes the foundset method specified by name.{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=getCalculation-String}{tr:id=name}{td}h6.getCalculation{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSCalculation]{span}{span:style=font-weight: bold;}getCalculation{span}{span}\(name){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- The name of the calculation {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSCalculation]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var calc = solutionModel.getDataSourceNode("db:/example_data/customers").newCalculation("function myCalculation() { return 123; }", JSVariable.INTEGER); var calc2 = solutionModel.getDataSourceNode("db:/example_data/customers").newCalculation("function myCalculation2() { return '20'; }"); var calc3 = solutionModel.getDataSourceNode("db:/example_data/employees").newCalculation("function myCalculation3() { return 'Hello World!'; }", JSVariable.TEXT); var c = solutionModel.getDataSourceNode("db:/example_data/customers").getCalculation("myCalculation"); application.output("Name: " + c.getName() + ", Stored: " + c.isStored()); var allCalcs = solutionModel.getDataSourceNode("db:/example_data/customers").getCalculations(); for (var i = 0; i < allCalcs.length; i++) { application.output(allCalcs[i]); } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCalculations}{tr:id=name}{td}h6.getCalculations{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSCalculation]\[]{span}{span:style=font-weight: bold;}getCalculations{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSCalculation]\[]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var calc = solutionModel.getDataSourceNode("db:/example_data/customers").newCalculation("function myCalculation() { return 123; }", JSVariable.INTEGER); var calc2 = solutionModel.getDataSourceNode("db:/example_data/customers").newCalculation("function myCalculation2() { return '20'; }"); var calc3 = solutionModel.getDataSourceNode("db:/example_data/employees").newCalculation("function myCalculation3() { return 'Hello World!'; }", JSVariable.TEXT); var c = solutionModel.getDataSourceNode("db:/example_data/customers").getCalculation("myCalculation"); application.output("Name: " + c.getName() + ", Stored: " + c.isStored()); var allCalcs = solutionModel.getDataSourceNode("db:/example_data/customers").getCalculations(); for (var i = 0; i < allCalcs.length; i++) { application.output(allCalcs[i]); } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDataSource}{tr:id=name}{td}h6.getDataSource{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getDataSource{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- the dataSource{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var nodeDataSource = solutionModel.getDataSourceNode("db:/example_data/customers").getDataSource(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getMethod-String}{tr:id=name}{td}h6.getMethod{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSMethod]{span}{span:style=font-weight: bold;}getMethod{span}{span}\(name){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- The name of the method {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSMethod]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var method = solutionModel.getDataSourceNode("db:/example_data/orders").newMethod("function doubleSize() { return 2*getSize(); }"); application.output('Doubled orders for this customer: '+customers_to_orders.doubleSize()) {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getMethods}{tr:id=name}{td}h6.getMethods{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSMethod]\[]{span}{span:style=font-weight: bold;}getMethods{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSMethod]\[]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var method = solutionModel.getDataSourceNode("db:/example_data/orders").newMethod("function doubleSize() { return 2*getSize(); }"); application.output('Doubled orders for this customer: '+customers_to_orders.doubleSize()) {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=newCalculation-String}{tr:id=name}{td}h6.newCalculation{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSCalculation]{span}{span:style=font-weight: bold;}newCalculation{span}{span}\(code){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} code -- The code of the calculation, this must be a full function declaration. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSCalculation]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var calc = solutionModel.getDataSourceNode("db:/example_data/customers").newCalculation("function myCalculation() { return 123; }", JSVariable.INTEGER); var calc2 = solutionModel.getDataSourceNode("db:/example_data/customers").newCalculation("function myCalculation2() { return '20'; }"); var calc3 = solutionModel.getDataSourceNode("db:/example_data/employees").newCalculation("function myCalculation3() { return 'Hello World!'; }", JSVariable.TEXT); var c = solutionModel.getDataSourceNode("db:/example_data/customers").getCalculation("myCalculation"); application.output("Name: " + c.getName() + ", Stored: " + c.isStored()); var allCalcs = solutionModel.getDataSourceNode("db:/example_data/customers").getCalculations(); for (var i = 0; i < allCalcs.length; i++) { application.output(allCalcs[i]); } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=newCalculation-String_Number}{tr:id=name}{td}h6.newCalculation{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSCalculation]{span}{span:style=font-weight: bold;}newCalculation{span}{span}\(code, type){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} code -- The code of the calculation, this must be a full function declaration. \{[Number]} type -- The type of the calculation, one of the JSVariable types. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSCalculation]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var calc = solutionModel.getDataSourceNode("db:/example_data/customers").newCalculation("function myCalculation() { return 123; }", JSVariable.INTEGER); var calc2 = solutionModel.getDataSourceNode("db:/example_data/customers").newCalculation("function myCalculation2() { return '20'; }"); var calc3 = solutionModel.getDataSourceNode("db:/example_data/employees").newCalculation("function myCalculation3() { return 'Hello World!'; }", JSVariable.TEXT); var c = solutionModel.getDataSourceNode("db:/example_data/customers").getCalculation("myCalculation"); application.output("Name: " + c.getName() + ", Stored: " + c.isStored()); var allCalcs = solutionModel.getDataSourceNode("db:/example_data/customers").getCalculations(); for (var i = 0; i < allCalcs.length; i++) { application.output(allCalcs[i]); } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=newMethod-String}{tr:id=name}{td}h6.newMethod{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSMethod]{span}{span:style=font-weight: bold;}newMethod{span}{span}\(code){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} code -- the specified code for the foundset method {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSMethod] -- a JSMethod object{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var method = solutionModel.getDataSourceNode("db:/example_data/orders").newMethod("function doubleSize() { return 2*getSize(); }"); application.output('Doubled orders for this customer: '+customers_to_orders.doubleSize()) {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeCalculation-String}{tr:id=name}{td}h6.removeCalculation{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}removeCalculation{span}{span}\(name){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- the name of the calculation to be removed {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if the removal was successful, false otherwise{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var calc1 = solutionModel.getDataSourceNode("db:/example_data/customers").newCalculation("function myCalculation1() { return 123; }", JSVariable.INTEGER); var calc2 = solutionModel.getDataSourceNode("db:/example_data/customers").newCalculation("function myCalculation2() { return '20'; }"); var c = solutionModel.getDataSourceNode("db:/example_data/customers").getCalculation("myCalculation1"); application.output("Name: " + c.getName() + ", Stored: " + c.isStored()); solutionModel.getDataSourceNode("db:/example_data/customers").removeCalculation("myCalculation1"); c = solutionModel.getDataSourceNode("db:/example_data/customers").getCalculation("myCalculation1"); if (c != null) { application.output("myCalculation could not be removed."); } var allCalcs = solutionModel.getDataSourceNode("db:/example_data/customers").getCalculations(); for (var i = 0; i < allCalcs.length; i++) { application.output(allCalcs[i]); } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeMethod-String}{tr:id=name}{td}h6.removeMethod{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}removeMethod{span}{span}\(name){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- the name of the method to be removed {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if the removal was successful, false otherwise{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var method1 = solutionModel.getDataSourceNode("db:/example_data/customers").newMethod("function myFoundsetMethod1() { return 123; }"); var method2 = solutionModel.getDataSourceNode("db:/example_data/customers").newCalculation("function myFoundsetMethod2() { return '20'; }"); var m = solutionModel.getDataSourceNode("db:/example_data/customers").getMethod("myFoundsetMethod1"); application.output("Name: " + m.getName()); solutionModel.getDataSourceNode("db:/example_data/customers").removeMethod("myFoundsetMethod1"); m = solutionModel.getDataSourceNode("db:/example_data/customers").getCalculation("myFoundsetMethod1"); if (m != null) { application.output("myFoundsetMethod1 could not be removed."); } var allMethods = solutionModel.getDataSourceNode("db:/example_data/customers").getMethod(); for (var i = 0; i < allMethods; i++) { application.output(allMethods[i]); } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Wiki Markup
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryGet an existing calculation for the datasource node.Gets all the calculations for the datasource node.Get the data source for this node.Get an existing foundset method for the datasource node.Gets all the foundset methods for the datasource node.Creates a new calculation for the given code, the type will be the column where it could be build on (if name is a column name), else it will default to JSVariable.Creates a new calculation for the given code and the type, if it builds on a column (name is a column name) then type will be ignored.Creates a new foundset method with the specified code.Removes the calculation specified by name.Removes the foundset method specified by name.

functionservoy sDetail2100%height:30px2Methods DetailsgetCalculationname

getCalculation(name)

dessIndent
Get an existing calculation for the datasource node.
prs

Parameters

sIndentnameThe name of the calculation
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetCalculationsname

getCalculations()

dessIndent
Gets all the calculations for the datasource node.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDataSourcename

getDataSource()

dessIndent
Get the data source for this node.
ret

Returns

sIndent the dataSource
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getMethodname

getMethod(name)

dessIndent
Get an existing foundset method for the datasource node.
prs

Parameters

sIndentnameThe name of the method
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getMethodsname

getMethods()

dessIndent
Gets all the foundset methods for the datasource node.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newCalculationname

newCalculation(code)

dessIndent
Creates a new calculation for the given code, the type will be the column where it could be build on (if name is a column name),
else it will default to JSVariable.TEXT;
prs

Parameters

sIndentcodeThe code of the calculation, this must be a full function declaration.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newCalculationname

newCalculation(code, type)

dessIndent
Creates a new calculation for the given code and the type, if it builds on a column (name is a column name) then type will be ignored.
prs

Parameters

sIndentcodeThe code of the calculation, this must be a full function declaration.typeThe type of the calculation, one of the JSVariable types.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newMethodname

newMethod(code)

dessIndent
Creates a new foundset method with the specified code.
prs

Parameters

sIndentcodethe specified code for the foundset method
ret

Returns

sIndent a JSMethod object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeCalculationname

removeCalculation(name)

dessIndent
Removes the calculation specified by name.
prs

Parameters

sIndentnamethe name of the calculation to be removed
ret

Returns

sIndent true if the removal was successful, false otherwise
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeMethodname

removeMethod(name)

dessIndent
Removes the foundset method specified by name.
prs

Parameters

sIndentnamethe name of the method to be removed
ret

Returns

sIndent true if the removal was successful, false otherwise
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow