com.conversationkit.impl.node.DialogTreeNode Maven / Gradle / Ivy
Show all versions of conversation-kit Show documentation
/*
* 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.node;
import com.conversationkit.impl.edge.DialogTreeEdge;
import com.conversationkit.model.IConversationEdge;
import com.conversationkit.model.IConversationSnippetButton;
import com.conversationkit.model.IConversationState;
import com.conversationkit.model.SnippetContentType;
import com.conversationkit.model.SnippetType;
import java.util.ArrayList;
import java.util.List;
/**
* A DialogTreeNode is a restricted implementation of
* IConversationNode that
* holds a text string to represent the displayed conversation snippet and
* retrieves a list of allowed responses from the outbound edges.
* By default the snippet and allowed
* responses will be rendered unchanged, but this class can easily be extended
* to use a template engine for string substitution.
*
* 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. Each DialogTreeNode represents either a question
* or statement presented to the user by the bot.
*
* A DialogTreeNode can either be a statement or question.
* A statement will not
* stop the conversation, continuing along the outbound edge to the next node if
* available. A question will stop the conversation and wait for a a response
* from the user. The suggested responses for a question are taken from the
* content of the outbound edges.
*
* @author pdtyreus
* @param an implementation of IConversationState to store the state of the
* conversation for the current user
*/
public class DialogTreeNode extends ConversationNode {
protected final String content;
/**
* Creates a node with the specified text.
*
* @param id the unique ID of the node from the underlying data store
* @param type whether the node should be a QUESTION or STATEMENT
* @param content the text prompt displayed to the user
*/
public DialogTreeNode(int id, SnippetType type, String content) {
super(id, type);
this.content = content;
}
@Override
public String renderContent(S state) {
return content;
}
@Override
public Iterable getSuggestedResponses(S state) {
if (getType() == SnippetType.STATEMENT) {
return null;
}
List allowed = new ArrayList();
for (IConversationEdge edge : edges) {
if (edge instanceof DialogTreeEdge) {
DialogTreeEdge dtEdge = (DialogTreeEdge) edge;
allowed.add(dtEdge.getAnswer());
}
}
return allowed;
}
@Override
public SnippetContentType getContentType() {
return SnippetContentType.TEXT;
}
@Override
public Iterable getButtons() {
return null;
}
}