com.conversationkit.impl.edge.RegexEdge 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;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * Matches responses based on a regular expression pattern. If a stateKey is
 * provided, the onMatch method sets the value of this key in the
 * conversation state equal to the first group found in the match or to the
 * stateValue constructor argument if specified.
 *
 * @author pdtyreus
 * @param  an implementation of IConversationState
 */
public class RegexEdge extends ConversationEdge {

    protected final Pattern pattern;
    protected final String stateKey;
    protected final Object stateValue;

    /**
     * Creates a RegEx edge that matches the pattern specified. The value of
     * flags is passed to Pattern.compile() to generate Pattern. If a stateKey is
     * provided, the onMatch method sets the value of this key in the
     * conversation state equal to the first group found in the match or to the
     * stateValue constructor argument if specified.
     * 
     * @param matchRegex RegEx string pattern 
     * @param stateKey state key to update
     * @param stateValue value for state key
     * @param flags value passed to Pattern.compile()
     * @param endNode next node after a match
     */
    public RegexEdge(String matchRegex, String stateKey, Object stateValue, int flags, IConversationNode endNode) {
        super(endNode);
        this.stateKey = stateKey;
        this.pattern = Pattern.compile(matchRegex, flags);
        this.stateValue = stateValue;
    }
    
     /**
     * Creates a RegEx edge that matches the pattern specified. The RegEx is case
     * insensitive by default. If a stateKey is
     * provided, the onMatch method sets the value of this key in the
     * conversation state equal to the first group found in the match or to the
     * stateValue constructor argument if specified.
     * 
     * @param matchRegex RegEx string pattern 
     * @param stateKey state key to update
     * @param stateValue value for the state key
     * @param endNode next node after a match
     */
    public RegexEdge(String matchRegex, String stateKey, Object stateValue, IConversationNode endNode) {
        super(endNode);
        this.stateKey = stateKey;
        this.pattern = Pattern.compile(matchRegex, Pattern.CASE_INSENSITIVE);
        this.stateValue = stateValue;
    }

    /**
     * Creates a RegEx edge that matches the pattern specified. The RegEx is case
     * insensitive by default. If a stateKey is
     * provided, the onMatch method sets the value of this key in the
     * conversation state equal to the first group found in the match.
     * 
     * @param matchRegex RegEx string pattern 
     * @param stateKey state key to update
     * @param endNode next node after a match
     */
    public RegexEdge(String matchRegex, String stateKey, IConversationNode endNode) {
        super(endNode);
        this.stateKey = stateKey;
        this.pattern = Pattern.compile(matchRegex, Pattern.CASE_INSENSITIVE);
        this.stateValue = null;
    }

     /**
     * Creates a RegEx edge that matches the pattern specified. The RegEx is case
     * insensitive by default. 
     * 
     * @param matchRegex RegEx string pattern 
     * @param endNode next node after a match
     */
    public RegexEdge(String matchRegex, IConversationNode endNode) {
        super(endNode);
        this.stateKey = null;
        this.stateValue = null;
        this.pattern = Pattern.compile(matchRegex, Pattern.CASE_INSENSITIVE);
    }


    @Override
    public boolean isMatchForState(S state) {
        if (state.getMostRecentResponse() != null) {
            Matcher matcher = pattern.matcher(state.getMostRecentResponse());
            return matcher.find();
        } else {
            return false;
        }
    }

    @Override
    public void onMatch(S state) {
        if (stateValue != null) {
            state.set(stateKey, stateValue);
        } else {
            Matcher matcher = pattern.matcher(state.getMostRecentResponse());
            if ((stateKey != null) && matcher.find()) {
                state.set(stateKey, matcher.group());
            }
        }
    }

    public String toString() {
        return "RegexEdge {" + pattern.pattern() + '}';
    }

}