NCubeRuntimeClient (n-cube 5.0.0 API)

com.cedarsoftware.ncube.NCubeClient

All Superinterfaces:

NCubeClient
```
@groovy.transform.CompileStatic
interface NCubeRuntimeClient
extends NCubeClient
```
Authors:
John DeRegnaucourt ([email protected]), Josh Snyder ([email protected])
Copyright (c) Cedar Software LLC

Licensed under the Apache License, Version 2.0 (the "License") you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`abstract void`	`addAdvice(ApplicationID appId, java.lang.String wildcard, Advice advice)`
	`abstract void`	`addCube(NCube ncube)`
	`abstract void`	`addCube(NCube ncube, boolean force)`
	`abstract void`	`clearCache(ApplicationID appId)`
	`abstract void`	`clearCache(ApplicationID appId, java.util.Collection<java.lang.String> cubeNames)`
	`abstract java.util.Map`	`execute(ApplicationID appId, java.lang.String cubeName, java.lang.String method, java.util.Map args)`
	`abstract java.net.URL`	`getActualUrl(ApplicationID appId, java.lang.String url, java.util.Map input)`
	`abstract ApplicationID`	`getApplicationID(java.lang.String tenant, java.lang.String app, java.util.Map<java.lang.String, java.lang.Object> coord)`
	`abstract ApplicationID`	`getBootVersion(java.lang.String tenant, java.lang.String app)`
	`abstract org.springframework.cache.Cache`	`getCacheForApp(ApplicationID appId)`
	`abstract java.util.Map`	`getCell(ApplicationID appId, java.lang.String cubeName, java.util.Map coordinate, java.lang.Object defaultValue)`
	`abstract java.lang.Object[]`	`getCells(ApplicationID appId, java.lang.String cubeName, java.lang.Object[] idArrays, java.util.Map input)`
	`abstract java.lang.Object[]`	`getCells(ApplicationID appId, java.lang.String cubeName, java.lang.Object[] idArrays, java.util.Map input, java.util.Map output)`
	`abstract java.lang.Object[]`	`getCells(ApplicationID appId, java.lang.String cubeName, java.lang.Object[] idArrays, java.util.Map input, java.util.Map output, java.lang.Object defaultValue)`
	`abstract java.net.URLClassLoader`	`getLocalClassloader(ApplicationID appId)`
	`abstract java.util.Map`	`getMenu(ApplicationID appId)`
	`abstract NCube`	`getNCubeFromResource(ApplicationID appId, java.lang.String name)`
	`abstract java.util.List<NCube>`	`getNCubesFromResource(ApplicationID appId, java.lang.String name)`
	`abstract java.util.Map<java.lang.String, java.lang.Object>`	`getSystemParams()`
	`abstract java.lang.String`	`getTestCauses(java.lang.Throwable t)`
	`abstract java.net.URLClassLoader`	`getUrlClassLoader(ApplicationID appId, java.util.Map input)`
	`abstract java.lang.String`	`getUrlContent(ApplicationID appId, java.lang.String url, java.util.Map input)`
	`abstract java.util.Map<java.lang.String, java.lang.Object>`	`getVisualizerGraph(ApplicationID appId, java.util.Map options)`
	`abstract java.util.Map<java.lang.String, java.lang.Object>`	`getVisualizerNodeDetails(ApplicationID appId, java.util.Map options)`
	`abstract java.util.Map<java.lang.String, java.lang.Object>`	`getVisualizerScopeChange(ApplicationID appId, java.util.Map options)`
	`abstract boolean`	`isCached(ApplicationID appId, java.lang.String cubeName)`
	`abstract boolean`	`isTrackBindingsOn()` This JVM is running NCube in a read-only mode, meaning that it is not configured to be allowed to make calls to the mutable APIs (CRUD APIs against the NCube storage server).
	`abstract java.util.Map`	`mapReduce(ApplicationID appId, java.lang.String cubeName, java.lang.String colAxisName, java.lang.String where, java.util.Map options)`
	`abstract java.util.Map`	`runTest(ApplicationID appId, java.lang.String cubeName, NCubeTest test)`
	`abstract java.util.Map`	`runTests(ApplicationID appId)`
	`abstract java.util.Map`	`runTests(ApplicationID appId, java.lang.String cubeName, java.lang.Object[] tests)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface NCubeClient`	`getAppNames, getAppTests, getBranches, getCube, getJson, getNotes, getTests, getVersions, search`

- Method Detail
  - abstract void addAdvice(ApplicationID appId, java.lang.String wildcard, Advice advice)
  - abstract void addCube(NCube ncube)
  - abstract void addCube(NCube ncube, boolean force)
  - abstract void clearCache(ApplicationID appId)
  - abstract void clearCache(ApplicationID appId, java.util.Collection<java.lang.String> cubeNames)
  - abstract java.util.Map execute(ApplicationID appId, java.lang.String cubeName, java.lang.String method, java.util.Map args)
  - abstract java.net.URL getActualUrl(ApplicationID appId, java.lang.String url, java.util.Map input)
  - abstract ApplicationID getApplicationID(java.lang.String tenant, java.lang.String app, java.util.Map<java.lang.String, java.lang.Object> coord)
  - abstract ApplicationID getBootVersion(java.lang.String tenant, java.lang.String app)
  - abstract org.springframework.cache.Cache getCacheForApp(ApplicationID appId)
  - abstract java.util.Map getCell(ApplicationID appId, java.lang.String cubeName, java.util.Map coordinate, java.lang.Object defaultValue)
  - abstract java.lang.Object[] getCells(ApplicationID appId, java.lang.String cubeName, java.lang.Object[] idArrays, java.util.Map input)
  - abstract java.lang.Object[] getCells(ApplicationID appId, java.lang.String cubeName, java.lang.Object[] idArrays, java.util.Map input, java.util.Map output)
  - abstract java.lang.Object[] getCells(ApplicationID appId, java.lang.String cubeName, java.lang.Object[] idArrays, java.util.Map input, java.util.Map output, java.lang.Object defaultValue)
  - abstract java.net.URLClassLoader getLocalClassloader(ApplicationID appId)
  - abstract java.util.Map getMenu(ApplicationID appId)
  - abstract NCube getNCubeFromResource(ApplicationID appId, java.lang.String name)
  - abstract java.util.List<NCube> getNCubesFromResource(ApplicationID appId, java.lang.String name)
  - abstract java.util.Map<java.lang.String, java.lang.Object> getSystemParams()
  - abstract java.lang.String getTestCauses(java.lang.Throwable t)
  - abstract java.net.URLClassLoader getUrlClassLoader(ApplicationID appId, java.util.Map input)
  - abstract java.lang.String getUrlContent(ApplicationID appId, java.lang.String url, java.util.Map input)
  - abstract java.util.Map<java.lang.String, java.lang.Object> getVisualizerGraph(ApplicationID appId, java.util.Map options)
  - abstract java.util.Map<java.lang.String, java.lang.Object> getVisualizerNodeDetails(ApplicationID appId, java.util.Map options)
  - abstract java.util.Map<java.lang.String, java.lang.Object> getVisualizerScopeChange(ApplicationID appId, java.util.Map options)
  - abstract boolean isCached(ApplicationID appId, java.lang.String cubeName)
  - abstract boolean isTrackBindingsOn()
    
    This JVM is running NCube in a read-only mode, meaning that it is not configured to be allowed to make calls to the mutable APIs (CRUD APIs against the NCube storage server).
    Returns:
    false if configured to allow mutable method calls (not readonly) or true (readonly) otherwise.
  - abstract java.util.Map mapReduce(ApplicationID appId, java.lang.String cubeName, java.lang.String colAxisName, java.lang.String where, java.util.Map options)
  - abstract java.util.Map runTest(ApplicationID appId, java.lang.String cubeName, NCubeTest test)
  - abstract java.util.Map runTests(ApplicationID appId)
  - abstract java.util.Map runTests(ApplicationID appId, java.lang.String cubeName, java.lang.Object[] tests)

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Interface NCubeRuntimeClient

Methods Summary

Inherited Methods Summary

Method Detail

abstract void addAdvice(ApplicationID appId, java.lang.String wildcard, Advice advice)

abstract void addCube(NCube ncube)

abstract void addCube(NCube ncube, boolean force)

abstract void clearCache(ApplicationID appId)

abstract void clearCache(ApplicationID appId, java.util.Collection<java.lang.String> cubeNames)

abstract java.util.Map execute(ApplicationID appId, java.lang.String cubeName, java.lang.String method, java.util.Map args)

abstract java.net.URL getActualUrl(ApplicationID appId, java.lang.String url, java.util.Map input)

abstract ApplicationID getApplicationID(java.lang.String tenant, java.lang.String app, java.util.Map<java.lang.String, java.lang.Object> coord)

abstract ApplicationID getBootVersion(java.lang.String tenant, java.lang.String app)

abstract org.springframework.cache.Cache getCacheForApp(ApplicationID appId)

abstract java.util.Map getCell(ApplicationID appId, java.lang.String cubeName, java.util.Map coordinate, java.lang.Object defaultValue)

abstract java.lang.Object[] getCells(ApplicationID appId, java.lang.String cubeName, java.lang.Object[] idArrays, java.util.Map input)

abstract java.lang.Object[] getCells(ApplicationID appId, java.lang.String cubeName, java.lang.Object[] idArrays, java.util.Map input, java.util.Map output)

abstract java.lang.Object[] getCells(ApplicationID appId, java.lang.String cubeName, java.lang.Object[] idArrays, java.util.Map input, java.util.Map output, java.lang.Object defaultValue)

abstract java.net.URLClassLoader getLocalClassloader(ApplicationID appId)

abstract java.util.Map getMenu(ApplicationID appId)

abstract NCube getNCubeFromResource(ApplicationID appId, java.lang.String name)

abstract java.util.List<NCube> getNCubesFromResource(ApplicationID appId, java.lang.String name)

abstract java.util.Map<java.lang.String, java.lang.Object> getSystemParams()

abstract java.lang.String getTestCauses(java.lang.Throwable t)

abstract java.net.URLClassLoader getUrlClassLoader(ApplicationID appId, java.util.Map input)

abstract java.lang.String getUrlContent(ApplicationID appId, java.lang.String url, java.util.Map input)

abstract java.util.Map<java.lang.String, java.lang.Object> getVisualizerGraph(ApplicationID appId, java.util.Map options)

abstract java.util.Map<java.lang.String, java.lang.Object> getVisualizerNodeDetails(ApplicationID appId, java.util.Map options)

abstract java.util.Map<java.lang.String, java.lang.Object> getVisualizerScopeChange(ApplicationID appId, java.util.Map options)

abstract boolean isCached(ApplicationID appId, java.lang.String cubeName)

abstract boolean isTrackBindingsOn()

abstract java.util.Map mapReduce(ApplicationID appId, java.lang.String cubeName, java.lang.String colAxisName, java.lang.String where, java.util.Map options)

abstract java.util.Map runTest(ApplicationID appId, java.lang.String cubeName, NCubeTest test)

abstract java.util.Map runTests(ApplicationID appId)

abstract java.util.Map runTests(ApplicationID appId, java.lang.String cubeName, java.lang.Object[] tests)