com.conversationkit.impl.edge.DialogTreeEdge 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.edge;

import com.conversationkit.model.IConversationEdge;
import com.conversationkit.model.IConversationNode;
import com.conversationkit.model.IConversationState;

/**
 * A DialogTreeEdge is an implementation of
 * IConversationEdge that connects one
 * IConversationNode that is a QUESTION to the
 * IConversationNode matching the answer.
 * 
 * A Dialog Tree is a type of branching conversation often seen in adventure
 * video games. The user is given a choice of what to say and makes subsequent
 * choices until the conversation ends. The responses to the user are scripted
 * based on the choices made. Since the user can only answer questions using one
 * the supplied suggestions from the DialogTreeNode, this edge type
 * does a string match between the answer stored in the edge and the response
 * provided by the user.
 *
 * @author pdtyreus
 * @param  an implementation of IConversationState
 */
public class DialogTreeEdge extends ConversationEdge {

    private final String answer;
    private final String stateKey;

    /**
     * Only an exact match for the answer stored in this node will cause the
     * conversion to advance to the endNode. The value of the response will be
     * stored as the stateKey key in the conversation state.
     *
     * @param answer string value to match
     * @param stateKey the value of the key to update in the conversation state
     * @param endNode next node in the conversation
     */
    public DialogTreeEdge(String answer, String stateKey, IConversationNode endNode) {
        super(endNode);
        this.stateKey = stateKey;
        this.answer = answer;
    }

    /**
     * Only an exact match for the answer stored in this node will cause the
     * conversion to advance to the endNode.
     *
     * @param answer string value to match
     * @param endNode next node in the conversation
     */
    public DialogTreeEdge(String answer, IConversationNode endNode) {
        super(endNode);
        this.stateKey = null;
        this.answer = answer;
    }

    @Override
    public boolean isMatchForState(S state) {
        return answer.equals(state.getMostRecentResponse());
    }

    @Override
    public void onMatch(S state) {
        if (this.stateKey != null) {
            state.set(this.stateKey, state.getMostRecentResponse());
        }
    }

    public String getAnswer() {
        return answer;
    }

    @Override
    public String toString() {
        return "DialogTreeEdge {" + answer + '}';
    }
}