carnival-data / carnival

JVM property graph data unification framework

Home Page:https://carnival-data.github.io/carnival/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CoreGraph to Carnival

augustearth opened this issue · comments

CoreGraph to Carnival

Re-brand the CoreGraph as a Carnival. A Carnival is an object that encapsulates the graph model, validator, and underlying graph database.

  • Class renames and removals
  • Replace Defaults with configuration object
  • Remove CarnivalLocalDirInit

Questions?

  • All the graph methods that take a Graph and/or GraphTraversalSource as parameters, do they now accept a Carnival?
  • When and how are graph models applied/associated with a Carnival?

Originally posted by @augustearth in #59 (comment)

Class Renames and Removals

Class Removals

  • Remove CoreGraphValidator

Class Rename

  • CoreGraph to Carnival
  • CoreGraphNeo4j to CarnivalNeo4j
  • CoreGraphTinker to CarnivalTinker
  • CoreGraphUtils to CarnivalUtils
  • CoreGraphSchema to DefaultGraphSchema
  • GremlinGraphValidator to DefaultGraphValidator

Replace Defaults with configuration object

References to remove

  • MappedDataTable
  • DataTableVineMethod
  • JsonVineMethod
  • VineMethod

Files to delete

  • Defaults.groovy

CarnivalConfiguration

  • Create a CarnivalNeo4jConfiguration class that contains everything needed to create a CarnivalNeo4j
  • Create a CarnivalNeo4 with a CarnivalNeo4jConfiguration

Vine Configuration

  • VineConfiguration object with everything that VineMethod, JsonVineMethod, and DataTableVineMethod need
  • Add a constructor VineMethod(VineConfiguration)

Remove CarnivalLocalDirInit

CarnivalLocalDirInit is there because running Carnival in a CI environment needed it to create the required directories. The directory situation needs to be more explicit. I think that the sub-directories should be created automatically if they are not present. Need to coordinate with @hjwilli to make sure whatever used CarnivalLocalDirInit will be ok after the removal.

Files to delete

  • CarnivalLocalDirInit.groovy