All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.googlecode.sarasvati.load.GraphFactory Maven / Gradle / Ivy

    The newest version!
    /*
    This file is part of Sarasvati.

    Sarasvati is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as
    published by the Free Software Foundation, either version 3 of the
    License, or (at your option) any later version.

    Sarasvati is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with Sarasvati.  If not, see .

    Copyright 2008-2009 Paul Lorenz
*/
package com.googlecode.sarasvati.load;

import java.util.List;

import com.googlecode.sarasvati.Arc;
import com.googlecode.sarasvati.ArcToken;
import com.googlecode.sarasvati.ArcTokenSetMember;
import com.googlecode.sarasvati.CustomNode;
import com.googlecode.sarasvati.Engine;
import com.googlecode.sarasvati.ExecutionType;
import com.googlecode.sarasvati.External;
import com.googlecode.sarasvati.Graph;
import com.googlecode.sarasvati.GraphProcess;
import com.googlecode.sarasvati.JoinType;
import com.googlecode.sarasvati.Node;
import com.googlecode.sarasvati.NodeToken;
import com.googlecode.sarasvati.NodeTokenSetMember;
import com.googlecode.sarasvati.TokenSet;
import com.googlecode.sarasvati.load.definition.CustomDefinition;

public interface GraphFactory
{
  /**
   * Generates a new graph instance with the given name and version.
   *
   * @param name The name of the graph to create
   * @param version The version of the graph to create
   * @param customId The custom id of the graph.
   *
   * @return A new {@link Graph}
   */
  Graph newGraph (String name, int version, String customId);

  /**
   * Creates a new {@link Arc} with given start node, end node and node name.
   *
   * @param startNode The arc starting node
   * @param endNode   The arc ending node
   * @param name      The arc name
   *
   * @return The new Arc
   *
   * @throws SarasvatiLoadException If the arc can not be created, or if it is passed invalid data.
   */
  Arc newArc (Graph graph, Node startNode, Node endNode, String name) throws SarasvatiLoadException;

  /**
   * Creates a new {@link Node}.
   *
   * @param graph The graph which the node is part of
   * @param name  The node name
   * @param type  The node type
   * @param joinType The node's join type
   * @param joinParam The node's join parameter.
   * @param isStart Indicates whether the node is a start node
   * @param guard  The node guard
   * @param customList A list of custom attributes from the process definition. May be empty or null.
   *
   * @return The new Node
   *
   * @throws SarasvatiLoadException If an error occurs while loading, such as incorrect custom data is given.
   */
  Node newNode (Graph graph,
                String name,
                String type,
                JoinType joinType,
                String joinParam,
                boolean isStart,
                String guard,
                List customList)
    throws SarasvatiLoadException;

  /**
   * Creates a new {@link External}.
   *
   * @param name The external name
   * @param graph The graph the external is defined in
   * @param externalGraph The graph the external references
   * @param customDefinition A container for a list of custom attributes. May be empty or null.
   * @return A new {@link External}
   *
   * @throws SarasvatiLoadException If an error occurs while loading, such as invalid custom data.
   */
  External newExternal (String name, Graph graph, Graph externalGraph, CustomDefinition customDefinition) throws SarasvatiLoadException;

  /**
   * Imports a node from an external graph into the given graph.
   *
   * @param graph The graph to import the node into
   * @param node  The node to import.
   * @param external The external the node belongs to
   *
   * @return The new, imported node
   */
  Node importNode (Graph graph, Node node, External external);

  /**
   * Generates a new {@link GraphProcess} for the given {@link Graph}. Execution
   * of the process is not started by this method.
   *
   * The method will be used by {@link Engine#startProcess(Graph)}.
   *
   * @param graph The {@link Graph} the GraphProcess will be executing.
   * @return A new {@link GraphProcess}
   */
  GraphProcess newProcess (Graph graph);

  /**
   * Generates a new {@link GraphProcess} for the given {@link Graph}. Execution
   * of the process is not started by this method. This method is specfically
   * for created a new nested process.
   *
   * @param graph The {@link Graph} the GraphProcess will be executing.
   * @param parentToken The {@link NodeToken} whose execution is causing this
   *                    nested process to be created.
   * @return A new {@link GraphProcess}
   */
  GraphProcess newNestedProcess (Graph graph, NodeToken parentToken);

  /**
   * Generates a new {@link NodeToken} for the given {@link GraphProcess}, pointing
   * to the given {@link Node}.
   *
   * @param process The {@link GraphProcess} which the new {@link NodeToken} will belong to
   * @param node    The {@link Node} the new {@link NodeToken} is being placed on
   * @param parents The list of ArcTokens which preceded this {@link NodeToken}
   * @return        A new {@link NodeToken}
   */
  NodeToken newNodeToken (GraphProcess process, Node node, List parents);

  /**
   * Generates a new {@link NodeToken} for the given {@link GraphProcess}, pointing
   * to the given {@link Node}.
   *
   * @param process The {@link GraphProcess} which the new {@link NodeToken} will belong to
   * @param node    The {@link Node} the new {@link NodeToken} is being placed on
   * @param executionType The {@link ExecutionType} represented by this node token.
   * @param parents The list of ArcTokens which preceded this {@link NodeToken}
   * @param envToken The token who's parents the new token should take its environment from.
   *                 This means the new token will have the same starting environment as
   *                 the passed in token.
   * @return        A new {@link NodeToken}
   */
  NodeToken newNodeToken (GraphProcess process,
                          Node node,
                          ExecutionType executionType,
                          List parents,
                          NodeToken envToken);

  /**
   * Generates a new {@link ArcToken} for the given {@link GraphProcess}, pointing
   * to the given {@link Arc}.
   *
   * @param process          The {@link GraphProcess} which the new ArcToken will belong to
   * @param arc              The {@link Arc} the new ArcToken is being placed on
   * @param executionType    The {@link ExecutionType} represented by this arc token.
   * @param parent           The {@link NodeToken} which preceded this {@link ArcToken}.
   * @param isTokenSetMember Flag indicating if the token is a member of a token set
   *
   * @return A new {@link ArcToken}
   */
  ArcToken newArcToken (GraphProcess process,
                        Arc arc,
                        ExecutionType executionType,
                        NodeToken parent,
                        boolean isTokenSetMember);

  /**
   * Creates a new token set.
   *
   * @param process The process that the token set belongs to
   * @param name The name given to the token set
   * @param maxMemberIndex The maximum member index (which should equals the number of initial members in the set)
   * @param level The token set level
   *
   * @return The newly created token set
   */
  TokenSet newTokenSet (GraphProcess process, String name, int maxMemberIndex, int level);

  /**
   * Creates a new membership of a token in a token set.
   *
   * @param tokenSet The token set the given token is to be added to
   * @param token The token being added to the given token set
   * @param memberIndex The member index of the token within the token set.
   *
   * @return The new arc token set member
   */
  ArcTokenSetMember newArcTokenSetMember (TokenSet tokenSet, ArcToken token, int memberIndex);

  /**
   * Creates a new membership of a token in a token set.
   *
   * @param tokenSet The token set the given token is to be added to
   * @param token The token being added to the given token set
   * @param memberIndex The member index of the token within the token set.
   *
   * @return The new node token set member
   */
  NodeTokenSetMember newNodeTokenSetMember (TokenSet tokenSet, NodeToken token, int memberIndex);

  /**
   * Adds the type to the {@link GraphFactory} for this engine. Specifies
   * what class will be used for a given node type, when loading process
   * definitions from XML file.
   *
   * @param type The type identifier, as used in the process definition file
   * @param nodeClass The node class which will be instantiated for this type
   */
  void addType (String type, Class nodeClass );

  /**
   * Adds the type to the {@link GraphFactory} for this engine. Specifies
   * what class will be used for a given node type, when loading process
   * definitions from XML file.
   * 
    
   * Adds a class for a custom node type globally, for all GraphFactory instances.
   * Only custom types can have global instances, since they are backend agnostic.
   *
   * @param type The type identifier, as used in the process definition file
   * @param nodeClass The custom node class which will be instantiated for this type
   */
  void addGlobalCustomType (String type, Class nodeClass);

  /**
   * Allows custom loading logic to be used to create nodes of a specific type.
   *
   * @param type The node type, as used in the process definition XML file
   * @param nodeFactory The factory used to create nodes of this type
   */
  void addNodeFactory (String type, NodeFactory nodeFactory);

  /**
   * Returns the {@link NodeFactory} for the given node type. If no factory has
   * been specified (via {@link GraphFactory#addNodeFactory(String, NodeFactory)}),
   * a default factory may be returned.
   *
   * @param type The node type
   * @return A node factory for the given type. If no factory has been specified
   *         for the given type, a default node factory may be returned.
   */
  NodeFactory getNodeFactory (String type);
}    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy