info.archinnov.achilles.annotations

Annotation Type FunctionRegistry

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
public @interface FunctionRegistry

Marks a class as a function registry and let Achilles manage it

 @FunctionRegistry
 public interface MyFunctions {

      Integer sumOf(int val1, int val2);

      Long toLong(Date javaDate);
 }
 

Note: it is possible to declare several function registries in your source code, just annotate them with @FunctionRegistry

Warning: it is not possible to declare 2 different functions with the same name and signature in the same keyspace Achilles will raise a compilation error when encountering such case. Ex:

 @FunctionRegistry
 public interface MyFunctionRegistry {


      String toString(long value);

      String toString(int value); // OK because parameter type is different

      String toString(long value); // KO because same signature as the first function
 }
 

Remark 1: functions return types cannot be primitive, use boxed types instead

Remark 2: Achilles' codec system also applies for function parameters and return type

 @FunctionRegistry
 public interface FunctionsWithCodecSystemRegistry {

      // CQL function signature = listtojson(consistencylevels list<text>), returns text
      String listToJson(List<@Enumerated ConsistencyLevel> consistencyLevels);

      // CQL function signature = getinvalue(input text), returns text
      @Codec(IntToString.class) String getIntValue(String input);

 }
 

Remark 3: functions name and parameters' name are lower-cased by Cassandra automatically

See Also:

Function Registry

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	keyspace (Optional) The name of the keyspace in which the declared functions belong to.

Element Detail

keyspace

public abstract String keyspace

(Optional) The name of the keyspace in which the declared functions belong to. If not set explicitly, Achilles will use the current keyspace of the java driver Session object.

 @FunctionRegistry(keyspace="production")
 public class MyFunctions {...}
 

Default:

""