Search in sources :

Example 1 with FieldSignature

use of org.neo4j.kernel.api.proc.FieldSignature in project neo4j by neo4j.

the class MethodSignatureCompiler method signatureFor.

public List<FieldSignature> signatureFor(Method method) throws ProcedureException {
    Parameter[] params = method.getParameters();
    Type[] types = method.getGenericParameterTypes();
    List<FieldSignature> signature = new ArrayList<>(params.length);
    boolean seenDefault = false;
    for (int i = 0; i < params.length; i++) {
        Parameter param = params[i];
        Type type = types[i];
        if (!param.isAnnotationPresent(Name.class)) {
            throw new ProcedureException(Status.Procedure.ProcedureRegistrationFailed, "Argument at position %d in method `%s` is missing an `@%s` annotation.%n" + "Please add the annotation, recompile the class and try again.", i, method.getName(), Name.class.getSimpleName());
        }
        Name parameter = param.getAnnotation(Name.class);
        String name = parameter.value();
        if (name.trim().length() == 0) {
            throw new ProcedureException(Status.Procedure.ProcedureRegistrationFailed, "Argument at position %d in method `%s` is annotated with a name,%n" + "but the name is empty, please provide a non-empty name for the argument.", i, method.getName());
        }
        try {
            NeoValueConverter valueConverter = typeMappers.converterFor(type);
            Optional<Neo4jValue> defaultValue = valueConverter.defaultValue(parameter);
            //it is not allowed to have holes in default values
            if (seenDefault && !defaultValue.isPresent()) {
                throw new ProcedureException(Status.Procedure.ProcedureRegistrationFailed, "Non-default argument at position %d with name %s in method %s follows default argument. " + "Add a default value or rearrange arguments so that the non-default values comes first.", i, parameter.value(), method.getName());
            }
            seenDefault = defaultValue.isPresent();
            signature.add(new FieldSignature(name, valueConverter.type(), defaultValue));
        } catch (ProcedureException e) {
            throw new ProcedureException(e.status(), "Argument `%s` at position %d in `%s` with%n" + "type `%s` cannot be converted to a Neo4j type: %s", name, i, method.getName(), param.getType().getSimpleName(), e.getMessage());
        }
    }
    return signature;
}
Also used : NeoValueConverter(org.neo4j.kernel.impl.proc.TypeMappers.NeoValueConverter) ArrayList(java.util.ArrayList) FieldSignature(org.neo4j.kernel.api.proc.FieldSignature) Name(org.neo4j.procedure.Name) Type(java.lang.reflect.Type) Parameter(java.lang.reflect.Parameter) ProcedureException(org.neo4j.kernel.api.exceptions.ProcedureException)

Example 2 with FieldSignature

use of org.neo4j.kernel.api.proc.FieldSignature in project neo4j by neo4j.

the class OutputMappers method mapper.

public OutputMapper mapper(Class<?> userClass) throws ProcedureException {
    assertIsValidRecordClass(userClass);
    List<Field> fields = instanceFields(userClass);
    FieldSignature[] signature = new FieldSignature[fields.size()];
    FieldMapper[] fieldMappers = new FieldMapper[fields.size()];
    for (int i = 0; i < fields.size(); i++) {
        Field field = fields.get(i);
        if (!isPublic(field.getModifiers())) {
            throw new ProcedureException(Status.Procedure.TypeError, "Field `%s` in record `%s` cannot be accessed. Please ensure the field is marked as `public`.", field.getName(), userClass.getSimpleName());
        }
        try {
            TypeMappers.NeoValueConverter mapper = typeMappers.converterFor(field.getGenericType());
            MethodHandle getter = lookup.unreflectGetter(field);
            FieldMapper fieldMapper = new FieldMapper(getter, mapper);
            fieldMappers[i] = fieldMapper;
            signature[i] = new FieldSignature(field.getName(), mapper.type());
        } catch (ProcedureException e) {
            throw new ProcedureException(e.status(), e, "Field `%s` in record `%s` cannot be converted to a Neo4j type: %s", field.getName(), userClass.getSimpleName(), e.getMessage());
        } catch (IllegalAccessException e) {
            throw new ProcedureException(Status.Procedure.TypeError, e, "Field `%s` in record `%s` cannot be accessed: %s", field.getName(), userClass.getSimpleName(), e.getMessage());
        }
    }
    return new OutputMapper(signature, fieldMappers);
}
Also used : FieldSignature(org.neo4j.kernel.api.proc.FieldSignature) Field(java.lang.reflect.Field) ProcedureException(org.neo4j.kernel.api.exceptions.ProcedureException) MethodHandle(java.lang.invoke.MethodHandle)

Example 3 with FieldSignature

use of org.neo4j.kernel.api.proc.FieldSignature in project neo4j by neo4j.

the class OutputMappersTest method shouldSkipStaticFields.

@Test
public void shouldSkipStaticFields() throws Throwable {
    // When
    OutputMapper mapper = mapper(RecordWithStaticFields.class);
    // Then
    assertThat(mapper.signature(), contains(new FieldSignature("includeMe", Neo4jTypes.NTString)));
    assertThat(asList(mapper.apply(new RecordWithStaticFields("hello, world!"))), contains("hello, world!"));
}
Also used : FieldSignature(org.neo4j.kernel.api.proc.FieldSignature) OutputMapper(org.neo4j.kernel.impl.proc.OutputMappers.OutputMapper) Test(org.junit.Test)

Example 4 with FieldSignature

use of org.neo4j.kernel.api.proc.FieldSignature in project neo4j by neo4j.

the class OutputMappersTest method shouldMapSimpleRecordWithString.

@Test
public void shouldMapSimpleRecordWithString() throws Throwable {
    // When
    OutputMapper mapper = mapper(SingleStringFieldRecord.class);
    // Then
    assertThat(mapper.signature(), contains(new FieldSignature("name", Neo4jTypes.NTString)));
    assertThat(asList(mapper.apply(new SingleStringFieldRecord("hello, world!"))), contains("hello, world!"));
}
Also used : FieldSignature(org.neo4j.kernel.api.proc.FieldSignature) OutputMapper(org.neo4j.kernel.impl.proc.OutputMappers.OutputMapper) Test(org.junit.Test)

Example 5 with FieldSignature

use of org.neo4j.kernel.api.proc.FieldSignature in project neo4j by neo4j.

the class ProcedureSignatureTest method inputSignatureShouldNotBeModifiable.

@Test
public void inputSignatureShouldNotBeModifiable() throws Throwable {
    // Expect
    exception.expect(UnsupportedOperationException.class);
    // When
    signature.inputSignature().add(new FieldSignature("b", Neo4jTypes.NTAny));
}
Also used : FieldSignature(org.neo4j.kernel.api.proc.FieldSignature) Test(org.junit.Test)

Aggregations

FieldSignature (org.neo4j.kernel.api.proc.FieldSignature)13 Test (org.junit.Test)8 ProcedureException (org.neo4j.kernel.api.exceptions.ProcedureException)5 MethodHandle (java.lang.invoke.MethodHandle)4 ComponentInjectionException (org.neo4j.kernel.api.exceptions.ComponentInjectionException)3 ProcedureSignature (org.neo4j.kernel.api.proc.ProcedureSignature)3 OutputMapper (org.neo4j.kernel.impl.proc.OutputMappers.OutputMapper)3 Method (java.lang.reflect.Method)2 UserFunctionSignature (org.neo4j.kernel.api.proc.UserFunctionSignature)2 Field (java.lang.reflect.Field)1 Parameter (java.lang.reflect.Parameter)1 Type (java.lang.reflect.Type)1 ArrayList (java.util.ArrayList)1 CallableProcedure (org.neo4j.kernel.api.proc.CallableProcedure)1 CallableUserAggregationFunction (org.neo4j.kernel.api.proc.CallableUserAggregationFunction)1 CallableUserFunction (org.neo4j.kernel.api.proc.CallableUserFunction)1 FailedLoadAggregatedFunction (org.neo4j.kernel.api.proc.FailedLoadAggregatedFunction)1 FailedLoadFunction (org.neo4j.kernel.api.proc.FailedLoadFunction)1 FailedLoadProcedure (org.neo4j.kernel.api.proc.FailedLoadProcedure)1 NeoValueConverter (org.neo4j.kernel.impl.proc.TypeMappers.NeoValueConverter)1