org.jactr.core.module.retrieval.buffer

Class RetrievalRequestDelegate

java.lang.Object

org.jactr.core.buffer.delegate.AsynchronousRequestDelegate

org.jactr.core.module.retrieval.buffer.RetrievalRequestDelegate

All Implemented Interfaces:

IRequestDelegate

public class RetrievalRequestDelegate
extends AsynchronousRequestDelegate

Constructor Summary

Constructors

Constructor and Description
RetrievalRequestDelegate(IRetrievalModule module)

Method Summary

Modifier and Type	Method and Description
protected void	abortRequest(IRequest request, IActivationBuffer buffer, java.lang.Object startValue) called if the timedevent is aborted
void	clear() clear/cancel any pending requests
protected IRequest	expandRequest(IRequest request) expands chunk requests into chunktype requests, unless indexed retrievals are enabled.
protected void	finishRequest(IRequest request, IActivationBuffer buffer, java.lang.Object startValue) finish the request
static ActivationPolicy	getActivationPolicy(java.lang.String slotName, java.util.Collection<? extends ISlot> slots)
static boolean	getBoolean(java.lang.String slotName, java.util.Collection<? extends ISlot> slots, boolean defaultValue)
static double	getThreshold(IRetrievalModule module, java.util.Collection<? extends ISlot> slots)
static boolean	isIndexRetrievalEnabled(DefaultRetrievalModule6 module, java.util.Collection<? extends ISlot> slots)
static boolean	isPartialMatchEnabled(IDeclarativeModule4 module, java.util.Collection<? extends ISlot> slots)
protected boolean	isValid(IRequest request, IActivationBuffer buffer) test to make sure all the slots are contained in the chunktype
void	setIncludeNullValues(boolean includeNulls) when chunks are expanded into search patterns, this determines whether null slot values will be included in the search pattern, defaults to false
protected java.lang.Object	startRequest(IRequest request, IActivationBuffer buffer, double requestTime) Start the buffer request, optimally returning an object for the AsynchronousRequestDelegate.finishRequest(IRequest, IActivationBuffer, Object) to inspect.
boolean	willAccept(IRequest request)

Methods inherited from class org.jactr.core.buffer.delegate.AsynchronousRequestDelegate

computeCompletionTime, createFinishTimedEvent, getCurrentTimedEvent, getPreviousRequest, isAsynchronous, isBusy, isDelayingStart, isUsingBlockingTimedEvents, postStart, preStart, release, request, setAsynchronous, setBusy, setCurrentTimedEvent, setDelayStart, setError, setError, setFree, setUseBlockingTimedEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RetrievalRequestDelegate

public RetrievalRequestDelegate(IRetrievalModule module)

Method Detail

getThreshold

public static double getThreshold(IRetrievalModule module,
                                  java.util.Collection<? extends ISlot> slots)

getActivationPolicy

public static ActivationPolicy getActivationPolicy(java.lang.String slotName,
                                                   java.util.Collection<? extends ISlot> slots)

getBoolean

public static boolean getBoolean(java.lang.String slotName,
                                 java.util.Collection<? extends ISlot> slots,
                                 boolean defaultValue)

isIndexRetrievalEnabled

public static boolean isIndexRetrievalEnabled(DefaultRetrievalModule6 module,
                                              java.util.Collection<? extends ISlot> slots)

isPartialMatchEnabled

public static boolean isPartialMatchEnabled(IDeclarativeModule4 module,
                                            java.util.Collection<? extends ISlot> slots)

clear

public void clear()

Description copied from interface: IRequestDelegate

clear/cancel any pending requests

Specified by:

clear in interface IRequestDelegate

Overrides:

clear in class AsynchronousRequestDelegate

setIncludeNullValues

public void setIncludeNullValues(boolean includeNulls)

when chunks are expanded into search patterns, this determines whether null slot values will be included in the search pattern, defaults to false

Parameters:

includeNulls -

isValid

protected boolean isValid(IRequest request,
                          IActivationBuffer buffer)
                   throws java.lang.IllegalArgumentException

test to make sure all the slots are contained in the chunktype

Specified by:

isValid in class AsynchronousRequestDelegate

buffer - TODO

Returns:

Throws:

java.lang.IllegalArgumentException

expandRequest

protected IRequest expandRequest(IRequest request)

expands chunk requests into chunktype requests, unless indexed retrievals are enabled.

Overrides:

expandRequest in class AsynchronousRequestDelegate

Parameters:

request -

Returns:

startRequest

protected java.lang.Object startRequest(IRequest request,
                                        IActivationBuffer buffer,
                                        double requestTime)

Description copied from class: AsynchronousRequestDelegate

Start the buffer request, optimally returning an object for the AsynchronousRequestDelegate.finishRequest(IRequest, IActivationBuffer, Object) to inspect. If this is an asynchronous request, this will be fired and finish will be fired at AsynchronousRequestDelegate.computeCompletionTime(double, IRequest, IActivationBuffer)

Specified by:

startRequest in class AsynchronousRequestDelegate

requestTime - TODO

abortRequest

protected void abortRequest(IRequest request,
                            IActivationBuffer buffer,
                            java.lang.Object startValue)

Description copied from class: AsynchronousRequestDelegate

called if the timedevent is aborted

Overrides:

abortRequest in class AsynchronousRequestDelegate

finishRequest

protected void finishRequest(IRequest request,
                             IActivationBuffer buffer,
                             java.lang.Object startValue)

Description copied from class: AsynchronousRequestDelegate

finish the request

Specified by:

finishRequest in class AsynchronousRequestDelegate

willAccept

public boolean willAccept(IRequest request)