jadex.bridge.component.impl.remotecommands.AbstractResultCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jadex-platform-bridge Show documentation

Jadex bridge is a base package for kernels and platforms, i.e., it is used by both and provides commonly used interfaces and classes for active components and their management.

There is a newer version: 4.0.267

Show newest version

package jadex.bridge.component.impl.remotecommands;

import java.util.Map;
import java.util.PriorityQueue;

import jadex.bridge.IInternalAccess;
import jadex.bridge.component.impl.IOrderedConversation;
import jadex.bridge.component.impl.IRemoteOrderedConversationCommand;
import jadex.bridge.service.types.security.ISecurityInfo;
import jadex.commons.future.IFuture;

/**
 *  Base class for Jadex built-in remote commands.
 *  Handles result counter for intermediate results.
 */
public abstract class AbstractResultCommand extends AbstractInternalRemoteCommand implements IRemoteOrderedConversationCommand
{
	/** Count of the result for ordering. */
	protected Integer resultcount;
	
	/**
	 *  Create a remote command.
	 */
	public AbstractResultCommand()
	{
		// Bean constructor.
	}
	
	/**
	 *  Create a remote command.
	 */
	public AbstractResultCommand(Map nonfunc)
	{
		super(nonfunc);
	}
	
	/**
	 *  Gets the result count.
	 *   
	 *  @return The result count.
	 */
	public Integer getResultCount()
	{
		return resultcount;
	}
	
	/**
	 *  Sets the result count.
	 *  
	 *  @param resultcount The result count.
	 */
	public void setResultCount(Integer resultcount)
	{
		this.resultcount = resultcount;
	}
	
	/**
	 *  Execute a command.
	 *  @param access The agent to run the command on.
	 *  @param conv The active conversation.
	 *  @param secinf The established security level to decide if the command is allowed.
	 */
	public void	execute(IInternalAccess access, IOrderedConversation conv, ISecurityInfo secinf)
	{
		PriorityQueue dc = conv.getDeferredCommands();
		dc.offer(this);
		
		AbstractResultCommand next = dc.peek();
		while (next != null && (next.getResultCount() == null || next.getResultCount() == conv.getNextResultCount()))
		{
			dc.poll();
			next.doExecute(access, conv.getFuture(), secinf);
			if (next.getResultCount() != null)
				conv.incNextResultCount();
			next = dc.peek();
		}
	}
	
	/**
	 *  Execute a command.
	 *  @param access The agent to run the command on.
	 *  @param future Future of the active conversation.
	 *  @param secinf The established security level to decide if the command is allowed.
	 */
	public abstract void doExecute(IInternalAccess access, IFuture future, ISecurityInfo secinf);
}