org.robokind.api.speechrec.messaging.RemoteSpeechRecServiceClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.robokind.api.speechrec Show documentation
The newest version!
/*
 * Copyright 2012 Hanson Robokind LLC.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.robokind.api.speechrec.messaging;

import java.util.logging.Level;
import java.util.logging.Logger;
import org.robokind.api.common.playable.PlayState;
import org.robokind.api.common.utils.EventRepeater;
import org.jflux.api.core.Listener;
import org.jflux.api.messaging.rk.MessageAsyncReceiver;
import org.jflux.api.messaging.rk.MessageSender;
import org.robokind.api.common.utils.TimeUtils;
import org.robokind.api.messaging.services.DefaultServiceClient;
import org.robokind.api.messaging.services.ServiceCommand;
import org.robokind.api.messaging.services.ServiceCommandFactory;
import org.robokind.api.messaging.services.ServiceError;
import org.robokind.api.speechrec.SpeechRecEventList;
import org.robokind.api.speechrec.SpeechRecService;

/**
 * Connects to a remote SpeechRecService through Messaging components.
 * 
 * @author Jason G. Pallack 
 */
public class RemoteSpeechRecServiceClient extends
        DefaultServiceClient implements SpeechRecService{
    private final static Logger theLogger = 
            Logger.getLogger(RemoteSpeechRecServiceClient.class.getName());
    private String mySpeechRecServiceId;
    private MessageAsyncReceiver mySpeechRecReceiver;
    private EventRepeater mySpeechRecEventRepeater;
    /**
     * Creates a new RemoteSpeechRecServiceClients.
     * Call start() to start the service.
     * @param configClass
     * @param speechRecServiceId
     * @param remoteId
     * @param commandSender
     * @param configSender
     * @param errorReceiver
     * @param commandFactory
     * @param speechRecReceiver 
     */
    public RemoteSpeechRecServiceClient(
            Class configClass,
            String speechRecServiceId,
            String remoteId,
            MessageSender commandSender,
            MessageSender configSender,
            MessageAsyncReceiver errorReceiver,
            ServiceCommandFactory commandFactory,
            MessageAsyncReceiver speechRecReceiver){
        super(speechRecServiceId, remoteId, 
                commandSender, configSender, errorReceiver, commandFactory);
        if(speechRecServiceId == null){
            throw new NullPointerException();
        }
        mySpeechRecServiceId = speechRecServiceId;
        mySpeechRecReceiver = speechRecReceiver;
        mySpeechRecEventRepeater = new EventRepeater();
    }
    
    @Override
    public String getSpeechRecServiceId(){
        return mySpeechRecServiceId;
    }
    
    @Override
    public void start(){
        start(TimeUtils.now());
        if(mySpeechRecReceiver != null){
            mySpeechRecReceiver.addListener(mySpeechRecEventRepeater);
        }
    }

    @Override
    public void stop() {
        super.stop(TimeUtils.now());
    }

    @Override
    public boolean onComplete(long time) {
        return playStateChange(super.onStop(time), PlayState.COMPLETED);
    }

    @Override
    public boolean onPause(long time) {
        return playStateChange(super.onStop(time), PlayState.PAUSED);
    }

    @Override
    public boolean onResume(long time) {
        return playStateChange(super.onStop(time), PlayState.RUNNING);
    }

    @Override
    public boolean onStart(long time) {
        return playStateChange(super.onStop(time), PlayState.RUNNING);
    }

    @Override
    public boolean onStop(long time) {
        return playStateChange(super.onStop(time), PlayState.STOPPED);
    }
    
    private boolean playStateChange(boolean attempt, PlayState state){
        if(!attempt){
            return false;
        }else if(mySpeechRecReceiver == null){
            theLogger.log(Level.INFO, "PlayState changed to {0}, " 
                    + "but SpeechRecReceiver is null.", state);
            return true;
        }else if(state == PlayState.RUNNING){
            theLogger.log(Level.INFO, "PlayState changed to {0}, "
                    + "adding repeater to SpeechRecReceiver.", state);
            mySpeechRecReceiver.addListener(mySpeechRecEventRepeater); 
        }else{
            theLogger.log(Level.INFO, "PlayState changed to {0}, "
                    + "removing repeater from SpeechRecReceiver.", state);
            mySpeechRecReceiver.removeListener(mySpeechRecEventRepeater);
        }
        return true;
    }
    
    public void setSpeechRecReceiver(MessageAsyncReceiver receiver){
        if(mySpeechRecReceiver != null){
            mySpeechRecReceiver.removeListener(mySpeechRecEventRepeater);
        }
        mySpeechRecReceiver = receiver;
        if(mySpeechRecReceiver != null && PlayState.RUNNING == getPlayState()){
            mySpeechRecReceiver.addListener(mySpeechRecEventRepeater);
        }
    }
    
    @Override
    public void addSpeechRecListener(Listener listener){
        mySpeechRecEventRepeater.addListener(listener);
    }

    @Override
    public void removeSpeechRecListener(Listener listener) {
        mySpeechRecEventRepeater.removeListener(listener);
    }
}