@groovy.util.logging.Slf4j abstract class DataTableVineMethod<T, U extends VineMethodCall> extends VineMethod
DataTableVineMethod is a partial concretization of VineMethod for vine methods that return a data table as a result. It is not expected that client code will extend this class, but rather the more concrete sub-classes of GenericDataTableVineMethod or MappedDataTableVineMethod.
| Constructor and description |
|---|
DataTableVineMethod
() |
| Type Params | Return Type | Name and description |
|---|---|---|
|
U |
_callCacheModeIgnore()Call the _fetchAndCache() and return the vine method call object. |
|
U |
_callCacheModeOptional()Check for a cached result; return if present; if not present, call _fetchAndCache() and return the resulting vine method call object. |
|
U |
_callCacheModeRequired()Verify that a cached result exists and return it. |
|
abstract U |
_createCallObject(java.util.Map arguments, org.apache.tinkerpop.gremlin.structure.T result)Create the vine method call object representing a call to this vine method. |
|
U |
_fetchAndCache()Call fetch(), write the result to the cache, and return a vine method call object. |
|
abstract U |
_readFromCache(DataTableFiles cacheFiles)Read the vine method result from the cache files. |
|
java.util.List<java.io.File> |
_writeCacheFile(U methodCall)Write the cache files to the cache directory for the provided method call object. |
|
DataTableFiles |
cacheFiles()Convenience method to call DataTableFiles.create for this vine method. |
|
U |
call(java.util.Map args)Set the arguments to the provided ones and call the vine method. |
|
U |
call(CacheMode cacheMode)Set the cache mode to the provided one and call the vine method. |
|
U |
call(CacheMode cacheMode, java.util.Map args)Set the cache mode and arguments and call the vine method. |
|
U |
call()Call the vine method returning a vine method call object. |
|
abstract org.apache.tinkerpop.gremlin.structure.T |
createDataTable(java.util.Map args)Create an empty data table for this vine methods if it were called using the provided arguments. |
|
abstract DataTable |
fetch(java.util.Map args)Executes the logic of this vine method. |
|
DataTableFiles |
findCacheFiles()Convenience method to call DataTableVineMethodCall.findFiles for this vine method. |
| Methods inherited from class | Name |
|---|---|
class VineMethod |
_cacheDirectory, _cacheDirectoryInitialize, _cacheDirectoryValidated, args, arguments, cacheMode, call, call, call, call, fetch, getCacheMode, mode, setCacheMode |
Call the _fetchAndCache() and return the vine method call object.
Check for a cached result; return if present; if not present, call _fetchAndCache() and return the resulting vine method call object.
Verify that a cached result exists and return it.
Create the vine method call object representing a call to this vine method.
arguments - The map of argument used during the call.result - The result object of the call.Call fetch(), write the result to the cache, and return a vine method call object.
Read the vine method result from the cache files.
cacheFiles - The cache files.Write the cache files to the cache directory for the provided method call object.
methodCall - The method call object that will be written to the
cache directory.Convenience method to call DataTableFiles.create for this vine method.
Set the arguments to the provided ones and call the vine method.
args - Map of arguments.Set the cache mode to the provided one and call the vine method.
cacheMode - The cache mode to use.Set the cache mode and arguments and call the vine method.
cacheMode - The cache mode to use.args - Map of arguments.Call the vine method returning a vine method call object. This method respects the cache mode.
Create an empty data table for this vine methods if it were called using the provided arguments.
args - The map of arguments.Executes the logic of this vine method.
Arguments - for the vine method logic.Convenience method to call DataTableVineMethodCall.findFiles for this vine method.