org.jactr.core.buffer.six

Class AbstractActivationBuffer6

java.lang.Object

org.jactr.core.utils.DefaultAdaptable

org.jactr.core.buffer.AbstractActivationBuffer

org.jactr.core.buffer.six.AbstractActivationBuffer6

All Implemented Interfaces:

IActivationBuffer, IStatusBuffer, INotifyingSlotContainer, ISlotContainer, IUniqueSlotContainer, IAdaptable, IInitializable, IParameterized

Direct Known Subclasses:

AbstractRequestableBuffer6, BasicBuffer6

public abstract class AbstractActivationBuffer6
extends AbstractActivationBuffer
implements IStatusBuffer

template for an activation buffer that handles it's own status and inserts only copies of chunks

Author:

developer

Field Summary

Fields inherited from class org.jactr.core.buffer.AbstractActivationBuffer

ACTIVATION_PARAM, GOAL_VALUE_PARAM, STRICT_HARVESTING_PARAM

Fields inherited from interface org.jactr.core.buffer.six.IStatusBuffer

BUFFER_SLOT, ERROR_CHANGED_TOO_MUCH_CHUNK, ERROR_DELETED_CHUNK, ERROR_INVALID_INDEX_CHUNK, ERROR_NO_LONGER_AVAILABLE_CHUNK, ERROR_NOTHING_AVAILABLE_CHUNK, ERROR_NOTHING_MATCHES_CHUNK, ERROR_SLOT, ERROR_UNKNOWN_CHUNK, STATE_SLOT

Fields inherited from interface org.jactr.core.buffer.IActivationBuffer

AURAL, AURAL_LOCATION, GOAL, IMAGINAL, MOTOR, RETRIEVAL, VISUAL, VISUAL_LOCATION, VOCAL

Constructor Summary

Constructors

Constructor and Description
AbstractActivationBuffer6(java.lang.String name, IModule module)

Method Summary

Modifier and Type	Method and Description
void	addListener(ISlotContainerListener listener, java.util.concurrent.Executor executor)
void	addSlot(ISlot slot) Adds a slot
IChunk	addSourceChunk(IChunk sourceChunk) ensure that all chunks added are copies
int	bind(SlotBasedRequest request, VariableBindings bindings, boolean isIterative) Required to permit status buffers to participate in the variable binding process of production instantiation.
protected boolean	checkStatusSlotContent(java.lang.String slotName, java.lang.Object value)
protected java.util.Collection<IChunk>	clearInternal() clear the status slots too
void	dispose() clean up resources, called by the module that created the buffer
IChunk	getBusyChunk()
IChunk	getEmptyChunk()
IChunk	getErrorChunk()
IChunk	getFreeChunk()
IChunk	getFullChunk()
IChunk	getRequestedChunk()
ISlot	getSlot(java.lang.String name) return the actual named slot.
java.util.Collection<? extends ISlot>	getSlots() return a duplicate copy of all the slots
java.util.Collection<ISlot>	getSlots(java.util.Collection<ISlot> slots)
IChunk	getUnrequestedChunk()
protected void	grabReferences() called once the model is started.
boolean	hasSlot(java.lang.String name)
boolean	isBufferEmpty() this actually checks the contents of the buffer slot which might not be the best test in the case of buffers that share a common set of state slots (i.e.
boolean	isBufferFull()
boolean	isBufferRequested()
boolean	isBufferUnrequested()
boolean	isErrorSet()
boolean	isStateBusy()
boolean	isStateError()
boolean	isStateFree()
void	removeListener(ISlotContainerListener listener)
void	removeSlot(ISlot slot) remove a slot
void	setBufferChunk(IChunk bufferState)
void	setErrorChunk(IChunk chunk)
void	setStateChunk(IChunk chunk)
protected void	setStatusSlotContent(java.lang.String slotName, java.lang.Object value)
protected boolean	shouldAcceptAsSource(IChunk futureSourceChunk)
protected boolean	shouldCopyOnInsertion(IChunk chunk) return true if this chunk should be copied, currently it just returns IChunk.isEncoded() or BufferUtilities.getContainingBuffers(IChunk, boolean).size()!=0.
protected void	sourceChunkCopied(IChunk originalChunk, IChunk nextSourceChunk) called when we have to copy the source chunk before adding it.
void	valueChanged(ISlot slot, java.lang.Object oldValue, java.lang.Object newValue) method used by the owned slot to communicate its change of value to the container

Methods inherited from class org.jactr.core.buffer.AbstractActivationBuffer

addListener, addSourceChunkInternal, clear, contains, containsExact, getActivation, getActivationSpreader, getEventDispatcher, getG, getLock, getModel, getModule, getName, getParameter, getPossibleParameters, getSetableParameters, getSourceChunk, getSourceChunkInternal, getSourceChunks, getSourceChunks, getSourceChunksInternal, handlesEncoding, initialize, isStrictHarvestingEnabled, matched, matchedInternal, removeListener, removeSourceChunk, removeSourceChunkInternal, setActivation, setActivationSpreader, setG, setParameter, setStrictHarvestingEnabled, toString

Methods inherited from class org.jactr.core.utils.DefaultAdaptable

addAdapterFactory, getAdapter, removeAdapterFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jactr.core.buffer.IActivationBuffer

addListener, clear, contains, getActivation, getG, getModel, getModule, getName, getSourceChunk, getSourceChunks, getSourceChunks, handlesEncoding, isStrictHarvestingEnabled, matched, removeListener, removeSourceChunk, setActivation, setG

Methods inherited from interface org.jactr.core.utils.IInitializable

initialize

Methods inherited from interface org.jactr.core.utils.IAdaptable

getAdapter

Constructor Detail

AbstractActivationBuffer6

public AbstractActivationBuffer6(java.lang.String name,
                                 IModule module)

Method Detail

dispose

public void dispose()

Description copied from interface: IActivationBuffer

clean up resources, called by the module that created the buffer

Specified by:

dispose in interface IActivationBuffer

Overrides:

dispose in class AbstractActivationBuffer

clearInternal

protected java.util.Collection<IChunk> clearInternal()

clear the status slots too

Overrides:

clearInternal in class AbstractActivationBuffer

Returns:

the chunks that were removed

See Also:

AbstractActivationBuffer.clear()

addListener

public void addListener(ISlotContainerListener listener,
                        java.util.concurrent.Executor executor)

Specified by:

addListener in interface INotifyingSlotContainer

removeListener

public void removeListener(ISlotContainerListener listener)

Specified by:

removeListener in interface INotifyingSlotContainer

valueChanged

public void valueChanged(ISlot slot,
                         java.lang.Object oldValue,
                         java.lang.Object newValue)

Description copied from interface: INotifyingSlotContainer

method used by the owned slot to communicate its change of value to the container

Specified by:

valueChanged in interface INotifyingSlotContainer

addSlot

public void addSlot(ISlot slot)

Description copied from interface: ISlotContainer

Adds a slot

Specified by:

addSlot in interface ISlotContainer

Parameters:

slot - The feature to be added to the ISlot attribute

removeSlot

public void removeSlot(ISlot slot)

Description copied from interface: ISlotContainer

remove a slot

Specified by:

removeSlot in interface ISlotContainer

Parameters:

slot - Description of Parameter

getSlot

public ISlot getSlot(java.lang.String name)

Description copied from interface: IUniqueSlotContainer

return the actual named slot. this is the backing slot, changes to it are propogated throughout the model

Specified by:

getSlot in interface IUniqueSlotContainer

Returns:

hasSlot

public boolean hasSlot(java.lang.String name)

Specified by:

hasSlot in interface IUniqueSlotContainer

getSlots

public java.util.Collection<? extends ISlot> getSlots()

Description copied from interface: ISlotContainer

return a duplicate copy of all the slots

Specified by:

getSlots in interface ISlotContainer

Returns:

The slots value

getSlots

public java.util.Collection<ISlot> getSlots(java.util.Collection<ISlot> slots)

Specified by:

getSlots in interface ISlotContainer

shouldCopyOnInsertion

protected boolean shouldCopyOnInsertion(IChunk chunk)

return true if this chunk should be copied, currently it just returns IChunk.isEncoded() or BufferUtilities.getContainingBuffers(IChunk, boolean).size()!=0. In other words, copy the chunk if its been encoded or is currently in another buffer

Parameters:

chunk -

Returns:

isStateFree

public boolean isStateFree()

Specified by:

isStateFree in interface IStatusBuffer

isStateBusy

public boolean isStateBusy()

Specified by:

isStateBusy in interface IStatusBuffer

isStateError

public boolean isStateError()

Specified by:

isStateError in interface IStatusBuffer

isBufferUnrequested

public boolean isBufferUnrequested()

Specified by:

isBufferUnrequested in interface IStatusBuffer

isBufferRequested

public boolean isBufferRequested()

Specified by:

isBufferRequested in interface IStatusBuffer

isBufferFull

public boolean isBufferFull()

Specified by:

isBufferFull in interface IStatusBuffer

isBufferEmpty

public boolean isBufferEmpty()

this actually checks the contents of the buffer slot which might not be the best test in the case of buffers that share a common set of state slots (i.e. visual and visual-location)

Specified by:

isBufferEmpty in interface IStatusBuffer

See Also:

IStatusBuffer.isBufferEmpty()

checkStatusSlotContent

protected boolean checkStatusSlotContent(java.lang.String slotName,
                                         java.lang.Object value)

setStatusSlotContent

protected void setStatusSlotContent(java.lang.String slotName,
                                    java.lang.Object value)

setStateChunk

public void setStateChunk(IChunk chunk)

Specified by:

setStateChunk in interface IStatusBuffer

setErrorChunk

public void setErrorChunk(IChunk chunk)

Specified by:

setErrorChunk in interface IStatusBuffer

isErrorSet

public boolean isErrorSet()

Specified by:

isErrorSet in interface IStatusBuffer

setBufferChunk

public void setBufferChunk(IChunk bufferState)

Specified by:

setBufferChunk in interface IStatusBuffer

getFreeChunk

public IChunk getFreeChunk()

getBusyChunk

public IChunk getBusyChunk()

getEmptyChunk

public IChunk getEmptyChunk()

getFullChunk

public IChunk getFullChunk()

getErrorChunk

public IChunk getErrorChunk()

getRequestedChunk

public IChunk getRequestedChunk()

getUnrequestedChunk

public IChunk getUnrequestedChunk()

grabReferences

protected void grabReferences()

Description copied from class: AbstractActivationBuffer

called once the model is started. this is the hook to grab references to chunks & types

Overrides:

grabReferences in class AbstractActivationBuffer

addSourceChunk

public IChunk addSourceChunk(IChunk sourceChunk)

ensure that all chunks added are copies

Specified by:

addSourceChunk in interface IActivationBuffer

Overrides:

addSourceChunk in class AbstractActivationBuffer

Parameters:

sourceChunk - chunk to be added

Returns:

the actual chunk added (in case a copy was made)

See Also:

IActivationBuffer.addSourceChunk(org.jactr.core.chunk.IChunk)

sourceChunkCopied

protected void sourceChunkCopied(IChunk originalChunk,
                                 IChunk nextSourceChunk)

called when we have to copy the source chunk before adding it.

Parameters:

originalChunk -

nextSourceChunk -

shouldAcceptAsSource

protected boolean shouldAcceptAsSource(IChunk futureSourceChunk)

bind

public int bind(SlotBasedRequest request,
                VariableBindings bindings,
                boolean isIterative)
         throws CannotMatchException

Description copied from interface: IStatusBuffer

Required to permit status buffers to participate in the variable binding process of production instantiation. Since we don't know a priori what the slots the status buffers will contain or their possible values, it is up to the status buffers to attempt to bind variable values

Specified by:

bind in interface IStatusBuffer

Returns:

Throws:

CannotMatchException