com.conversationkit.impl.DirectedConversationEngine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of conversation-kit Show documentation
A directed graph model for conversational UIs.
There is a newer version: 2.0.1
/*
 * The MIT License
 *
 * Copyright 2016 Synclab Consulting LLC.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.conversationkit.impl;

import com.conversationkit.model.IConversationEngine;
import com.conversationkit.model.IConversationEdge;
import com.conversationkit.model.IConversationNode;
import com.conversationkit.model.IConversationNodeIndex;
import com.conversationkit.model.IConversationSnippet;
import com.conversationkit.model.IConversationState;
import com.conversationkit.model.SnippetContentType;
import com.conversationkit.model.SnippetType;
import com.conversationkit.model.UnexpectedResponseException;
import com.conversationkit.model.UnmatchedResponseException;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Logger;

/**
 *
 * @author pdtyreus
 */
public class DirectedConversationEngine implements IConversationEngine {

    private static Logger logger = Logger.getLogger(DirectedConversationEngine.class.getName());
    protected final IConversationNodeIndex nodeIndex;

    public DirectedConversationEngine(IConversationNodeIndex nodeIndex) {
        this.nodeIndex = nodeIndex;
    }

    @Override
    public Iterable startConversationFromState(S state) {
        List nodes = new ArrayList();
        IConversationNode nextNode = nodeIndex.getNodeAtIndex(state.getCurrentNodeId());
        if (nextNode.getContentType() != SnippetContentType.NOTHING) {
            nodes.add(nextNode);
        }
        boolean matchFound = true;
        while (matchFound && (nextNode.getType() == SnippetType.STATEMENT)) {
            //if nothing has matched, we are done
            matchFound = false;
            for (IConversationEdge edge : nextNode.getEdges()) {
                //find the first edge that matches and move to that node
                if (!matchFound) {
                    logger.fine(String.format("evaluating STATEMENT edge %s", edge));
                    if (edge.isMatchForState(state)) {
                        matchFound = true;
                        state = moveToNextNode(state, edge);
                        nextNode = nodeIndex.getNodeAtIndex(state.getCurrentNodeId());
                        if (nextNode.getContentType() != SnippetContentType.NOTHING) {
                            nodes.add(nextNode);
                        }
                    }
                }
            }
        }
        return nodes;
    }

    @Override
    public S updateStateWithResponse(S state, String response) throws UnmatchedResponseException, UnexpectedResponseException {
        IConversationNode currentSnippet = nodeIndex.getNodeAtIndex(state.getCurrentNodeId());

        if (currentSnippet.getType() == SnippetType.QUESTION) {
            state.setMostRecentResponse(response);
            logger.info(String.format("processing response '%s' for node of type %s", response, currentSnippet.getType()));
            boolean matchFound = false;

            for (IConversationEdge edge : currentSnippet.getEdges()) {
                if (!matchFound) {
                    logger.fine(String.format("inspecting possible edge %s, already matched %s", edge, matchFound));

                    if (edge.isMatchForState(state)) {
                        matchFound = true;
                        moveToNextNode(state, edge);
                    }
                }
            }

            if (!matchFound) {
                throw new UnmatchedResponseException();
            }
        } else {
            throw new UnexpectedResponseException(String.format("received response '%s' to node %d which is not a QUESTION",response,state.getCurrentNodeId()));
        }

        return state;
    }

    private S moveToNextNode(S state, IConversationEdge edge) {
        IConversationNode nextNode = edge.getEndNode();
        state.setCurrentNodeId(nextNode.getId());
        if (state.getMostRecentResponse() != null) {
            logger.info(String.format("response '%s' matches edge '%s'", state.getMostRecentResponse(), edge));
        } else {
            logger.info(String.format("edge '%s' matches", edge));
        }
        logger.fine(String.format("adding node '%s' of type %s", nextNode.renderContent(state), nextNode.getType()));
        edge.onMatch(state);
        return state;
    }
}