io.virtdata.api

Class BasicFunctionalLibrary

java.lang.Object

io.virtdata.api.BasicFunctionalLibrary

All Implemented Interfaces:

EnhancedDocs, Named, VirtDataFunctionLibrary

public abstract class BasicFunctionalLibrary
extends Object
implements VirtDataFunctionLibrary, EnhancedDocs

Constructor Summary

Constructors

Constructor and Description
BasicFunctionalLibrary()

Method Summary

Modifier and Type	Method and Description
List<String>	getDataMapperNames() Get a list of all data mappers supported by this library.
List<DocFuncData>	getDocModels()
abstract String	getName() Return the name for this function library implementation.
abstract List<Package>	getSearchPackages()
List<ResolvedFunction>	resolveFunctions(Class<?> returnType, Class<?> inputType, String functionName, Object... parameters) Given a signature for a unary function which takes an input and output type, a function name, and constructor arguments, return a list of instances from all implementations that have the same name as the function name, which have a matching constructor signature, and which also have a functional method which can be used with the provided input and output types.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.virtdata.api.VirtDataFunctionLibrary

getDataMapper, getDataMappers, resolveFunctions

Constructor Detail

BasicFunctionalLibrary

public BasicFunctionalLibrary()

Method Detail

getName

public abstract String getName()

Description copied from interface: Named

Return the name for this function library implementation.

Specified by:

getName in interface Named

Returns:

Simple lower-case canonical library name

getSearchPackages

public abstract List<Package> getSearchPackages()

resolveFunctions

public List<ResolvedFunction> resolveFunctions(Class<?> returnType,
                                               Class<?> inputType,
                                               String functionName,
                                               Object... parameters)

Description copied from interface: VirtDataFunctionLibrary

Given a signature for a unary function which takes an input and output type, a function name, and constructor arguments, return a list of instances from all implementations that have the same name as the function name, which have a matching constructor signature, and which also have a functional method which can be used with the provided input and output types. The input and output types are optionally specified. If either is provided, the returned functions should be constrained to match, but otherwise all possibly matching functions are included. Further, the argument should not be strict type checks, but should allow any matching constructor for which a compatible assignment can be made. The specified function name does not have to map to a

Specified by:

resolveFunctions in interface VirtDataFunctionLibrary

Parameters:

returnType - The class which the apply method should return, or null if unspecified

inputType - The class which the unary apply method should take as an argument, or null if unspecified

functionName - The name of the implementation to match

parameters - A list of arguments which will be used to instantiate any matching implementations

Returns:

A list, possibly empty, of matching functions

getDocModels

public List<DocFuncData> getDocModels()

Specified by:

getDocModels in interface EnhancedDocs

getDataMapperNames

public List<String> getDataMapperNames()

Description copied from interface: VirtDataFunctionLibrary

Get a list of all data mappers supported by this library.

Specified by:

getDataMapperNames in interface VirtDataFunctionLibrary

Returns:

A list of data mapping function names

toString

public String toString()

Overrides:

toString in class Object