Package org.jesterj.ingest.model

Interface Plan

    • Method Detail

      • getSteps

        Step[] getSteps()
        Return every Step in the plan regardless of whether it will be executing when the plan is activated
        Returns:
        All steps

      • getExecutableSteps

        Step[] getExecutableSteps()
        Get the subset of steps that will execute when the plan is activated. This should be a continuous set of steps that can be traversed in total via Step.getNextSteps(Document).
        Returns:
        an Array of steps in the plan that will be executed

      • getDocIdField

        java.lang.String getDocIdField()
        This is the field that is to be used as a docId
        Returns:
        usually "id" but some legacy indexes may need to use something else

      • findStep

        Step findStep​(java.lang.String stepName)
        Locate the step in the plan that has the given name. All steps in the plan must have a unique name.
        Parameters:
        stepName - the name of the step to find
        Returns:
        the step if found or null if the name does not match any steps.

      • visualize

        guru.nidi.graphviz.engine.Renderer visualize​(guru.nidi.graphviz.engine.Format format)
        Produce an image visualization of this plan
        Parameters:
        format - the format that should be rendered
        Returns:
        An image visualizing the plan as a directed graph.

      • getVersion

        int getVersion()
        A (usually serially incremented) version identifier for a plan. Changing the version of the plan indicates that the processing has changed substantially, and that prior indexing no longer is considered to have produced the desired output. The practical implication of changing the plan version is that all documents will become eligible for re-indexing.
        Returns:
        a numeric identifier which changes when prior indexing is invalidated and there is a need for re-indexing. Monotonically increasing positive numbers are recommended but not absolutely required.