Package com.norconex.committer.neo4j

Class Neo4jCommitterConfig

java.lang.Object
com.norconex.committer.core.BaseCommitterConfig
com.norconex.committer.core.batch.BaseBatchCommitterConfig
com.norconex.committer.neo4j.Neo4jCommitterConfig
All Implemented Interfaces:
Serializable
public class Neo4jCommitterConfig extends BaseBatchCommitterConfig implements Serializable

Neo4j Committer configuration.

Author:
Sylvain Roussy, Pascal Essiembre
See Also:

  • Field Details

  • Constructor Details

    • Neo4jCommitterConfig

      public Neo4jCommitterConfig()

  • Method Details

    • setCredentials

      public void setCredentials(Credentials credentials)

    • getOptionalParameters

      public Set<String> getOptionalParameters()

    • setOptionalParameters

      public void setOptionalParameters(Set<String> optionalParameters)

    • addOptionalParameter

      public void addOptionalParameter(String optionalParameter)

    • getUri

      public String getUri()
      Required connection URI. E.g., "bolt://localhost:7687".

    • getDatabase

      public String getDatabase()
      A database name when using one other than the default one.

    • getCredentials

      public Credentials getCredentials()
      Connection credentials.

    • getMultiValuesJoiner

      public String getMultiValuesJoiner()
      One or more characters to join multi-value fields. Default is "|".

    • getNodeIdProperty

      public String getNodeIdProperty()
      Optional property name where to store the document reference in Neo4j graph entries. Use it as a cypher parameter to uniquely identify your graph entries in your configured "upsertCypher" and "deleteCypher" queries. Default is "id".

    • getNodeContentProperty

      public String getNodeContentProperty()
      Optional property name where to store the document content in Neo4j graph entries. Use it as a cypher parameter in your configured "upsertCypher" query. Default is "content".

    • getUpsertCypher

      public String getUpsertCypher()
      Cypher query for adding relationships to Neo4j. Typically, you want to use MERGE and the "nodeIdProperty" value to update existing entries matching the ID. In order to delete all nodes related to an entry, make sure to add the ID property on all appropriate nodes. The query parameters correspond the document fields.

    • getDeleteCypher

      public String getDeleteCypher()
      Cypher query for adding relationships to Neo4j. Typically, you want to use "nodeIdProperty" value to delete nodes having a matching property value. The query parameters correspond the document fields.

    • setUri

      public Neo4jCommitterConfig setUri(String uri)
      Required connection URI. E.g., "bolt://localhost:7687".
      Returns:
      this.

    • setDatabase

      public Neo4jCommitterConfig setDatabase(String database)
      A database name when using one other than the default one.
      Returns:
      this.

    • setMultiValuesJoiner

      public Neo4jCommitterConfig setMultiValuesJoiner(String multiValuesJoiner)
      One or more characters to join multi-value fields. Default is "|".
      Returns:
      this.

    • setNodeIdProperty

      public Neo4jCommitterConfig setNodeIdProperty(String nodeIdProperty)
      Optional property name where to store the document reference in Neo4j graph entries. Use it as a cypher parameter to uniquely identify your graph entries in your configured "upsertCypher" and "deleteCypher" queries. Default is "id".
      Returns:
      this.

    • setNodeContentProperty

      public Neo4jCommitterConfig setNodeContentProperty(String nodeContentProperty)
      Optional property name where to store the document content in Neo4j graph entries. Use it as a cypher parameter in your configured "upsertCypher" query. Default is "content".
      Returns:
      this.

    • setUpsertCypher

      public Neo4jCommitterConfig setUpsertCypher(String upsertCypher)
      Cypher query for adding relationships to Neo4j. Typically, you want to use MERGE and the "nodeIdProperty" value to update existing entries matching the ID. In order to delete all nodes related to an entry, make sure to add the ID property on all appropriate nodes. The query parameters correspond the document fields.
      Returns:
      this.

    • setDeleteCypher

      public Neo4jCommitterConfig setDeleteCypher(String deleteCypher)
      Cypher query for adding relationships to Neo4j. Typically, you want to use "nodeIdProperty" value to delete nodes having a matching property value. The query parameters correspond the document fields.
      Returns:
      this.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class BaseBatchCommitterConfig

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class BaseBatchCommitterConfig

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class BaseBatchCommitterConfig

    • toString

      public String toString()
      Overrides:
      toString in class BaseBatchCommitterConfig