Package com.graphdbapi.algo

Interface CypherProcedure

  • public interface CypherProcedure
    CYPHER调用信息。
    Since:
    3.5.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addConfiguration​(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.Object defaultValue)
      增加配置参数信息。
      void addParameters​(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.Object defaultValue)
      增加输入参数信息。
      void addResults​(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.Object defaultValue)
      增加返回结果信息。
      boolean containsConfiguration​(java.lang.String name)
      是否存在特定参数名的配置信息。
      boolean containsParameters​(java.lang.String name)
      是否存在特定参数名的输入参数信息。
      boolean containsResults​(java.lang.String name)
      是否存在特定参数名的返回结果信息。
      java.util.List<java.lang.String> getConfiguration()
      获取配置参数信息（可选的配置）。
      java.lang.String getDescription()
      获取描述注解@Description信息。
      java.lang.String getName()
      获取调用注解Procedure or UserFunction信息。
      java.util.List<java.lang.String> getParameters()
      获取参数注解@Name信息。
      java.util.List<java.lang.String> getResults()
      获取返回结果信息。
      void removeConfiguration​(java.lang.String name)
      移除配置参数信息。
      void removeParameters​(java.lang.String name)
      移除输入配置参数信息。
      void removeResults​(java.lang.String name)
      移除返回结果信息。
      void updateConfiguration​(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.Object defaultValue)
      更新配置参数信息。
      void updateParameters​(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.Object defaultValue)
      更新输入参数信息。
      void updateResults​(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.Object defaultValue)
      更新返回结果信息。

    • Method Detail

      • getName

        java.lang.String getName()
        获取调用注解Procedure or UserFunction信息。
        Returns:
        调用注解信息。

      • getDescription

        java.lang.String getDescription()
        获取描述注解@Description信息。
        Returns:
        描述注解信息。

      • getParameters

        java.util.List<java.lang.String> getParameters()
        获取参数注解@Name信息。
        Returns:
        参数注解信息。

      • getConfiguration

        java.util.List<java.lang.String> getConfiguration()
        获取配置参数信息（可选的配置）。
        Returns:
        配置参数信息。

      • getResults

        java.util.List<java.lang.String> getResults()
        获取返回结果信息。
        Returns:
        返回结果信息。

      • containsConfiguration

        boolean containsConfiguration​(java.lang.String name)
        是否存在特定参数名的配置信息。
        Parameters:
        name - 参数名，不允许为空。
        Returns:
        true表示存在。

      • addConfiguration

        void addConfiguration​(java.lang.String name,
                      java.lang.String description,
                      java.lang.String type,
                      java.lang.Object defaultValue)
        增加配置参数信息。
        Parameters:
        name - 参数名，不允许为空。
        description - 参数描述。
        type - 参数类型。
        defaultValue - 参数默认值。

      • removeConfiguration

        void removeConfiguration​(java.lang.String name)
        移除配置参数信息。
        Parameters:
        name - 参数名，不允许为空。

      • updateConfiguration

        void updateConfiguration​(java.lang.String name,
                         java.lang.String description,
                         java.lang.String type,
                         java.lang.Object defaultValue)
        更新配置参数信息。
        Parameters:
        name - 参数名。
        description - 参数描述。
        type - 参数类型。
        defaultValue - 参数默认值。

      • containsParameters

        boolean containsParameters​(java.lang.String name)
        是否存在特定参数名的输入参数信息。
        Parameters:
        name - 参数名，不允许为空。
        Returns:
        true表示存在。

      • addParameters

        void addParameters​(java.lang.String name,
                   java.lang.String description,
                   java.lang.String type,
                   java.lang.Object defaultValue)
        增加输入参数信息。
        Parameters:
        name - 参数名，不允许为空。
        description - 参数描述。
        type - 参数类型。
        defaultValue - 参数默认值。

      • removeParameters

        void removeParameters​(java.lang.String name)
        移除输入配置参数信息。
        Parameters:
        name - 参数名，不允许为空。

      • updateParameters

        void updateParameters​(java.lang.String name,
                      java.lang.String description,
                      java.lang.String type,
                      java.lang.Object defaultValue)
        更新输入参数信息。
        Parameters:
        name - 参数名。
        description - 参数描述。
        type - 参数类型。
        defaultValue - 参数默认值。

      • containsResults

        boolean containsResults​(java.lang.String name)
        是否存在特定参数名的返回结果信息。
        Parameters:
        name - 参数名，不允许为空。
        Returns:
        true表示存在。

      • addResults

        void addResults​(java.lang.String name,
                java.lang.String description,
                java.lang.String type,
                java.lang.Object defaultValue)
        增加返回结果信息。
        Parameters:
        name - 参数名，不允许为空。
        description - 参数描述。
        type - 参数类型。
        defaultValue - 参数默认值。

      • removeResults

        void removeResults​(java.lang.String name)
        移除返回结果信息。
        Parameters:
        name - 参数名，不允许为空。

      • updateResults

        void updateResults​(java.lang.String name,
                   java.lang.String description,
                   java.lang.String type,
                   java.lang.Object defaultValue)
        更新返回结果信息。
        Parameters:
        name - 参数名。
        description - 参数描述。
        type - 参数类型。
        defaultValue - 参数默认值。