org.jactr.core.buffer.six

Class AbstractCapacityBuffer6

java.lang.Object

org.jactr.core.utils.DefaultAdaptable

org.jactr.core.buffer.AbstractActivationBuffer

org.jactr.core.buffer.six.AbstractActivationBuffer6

org.jactr.core.buffer.six.AbstractRequestableBuffer6

org.jactr.core.buffer.six.AbstractCapacityBuffer6

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCapacityPMActivationBuffer6, DefaultCapacityGoalBuffer6

public abstract class AbstractCapacityBuffer6
extends AbstractRequestableBuffer6
implements ICapacityBuffer

Nested Class Summary

Nested classes/interfaces inherited from interface org.jactr.core.buffer.ICapacityBuffer

ICapacityBuffer.EjectionPolicy

Field Summary

Fields

Modifier and Type	Field and Description
protected ICapacityBuffer.EjectionPolicy	_ejectionPolicy

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.ICapacityBuffer

EJECTION_POLICY_PARAM

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

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected IChunk	addSourceChunkInternal(IChunk chunkToInsert) return the source chunk that was actually inserted into the buffer (i.e.
protected void	chunkInserted(IChunk insertedChunk) set the status slots after insertion
protected void	chunkRemoved(IChunk removedChunk)
void	dispose() clean up resources, called by the module that created the buffer
protected java.util.Map<IChunk,java.lang.Double>	getChunksAndTimes()
ICapacityBuffer.EjectionPolicy	getEjectionPolicy()
java.lang.String	getParameter(java.lang.String key) return parameter value - null if not defined.
java.util.Collection<java.lang.String>	getPossibleParameters() Return all parameters that can be read
java.util.Collection<java.lang.String>	getSetableParameters() Return list of all parameters that can be set.
protected IChunk	getSourceChunkInternal() return the first source chunk.
protected java.util.Collection<IChunk>	getSourceChunksInternal(java.util.Collection<IChunk> container) return the contents of the buffer.
protected java.util.Map<java.lang.Double,IChunk>	getTimesAndChunks() returns the actual backing map used.
void	initialize() intialize this component
protected abstract boolean	isCapacityReached() return true if the capacity has been reached and someone needs to be removed
protected abstract boolean	isValidChunkType(IChunkType chunkType) return true if a chunk of this type can be added to the buffer
protected boolean	matchedInternal(IChunk chunk) when a chunk is matched against, we modify its insertion time..
protected boolean	removeSourceChunkInternal(IChunk chunkToRemove) do the actual work of removing chunkToRemove from the buffer.
void	setEjectionPolicy(ICapacityBuffer.EjectionPolicy policy)
void	setParameter(java.lang.String key, java.lang.String value) Set the named parameter

Methods inherited from class org.jactr.core.buffer.six.AbstractRequestableBuffer6

request, requestInternal

Methods inherited from class org.jactr.core.buffer.six.AbstractActivationBuffer6

addListener, addSlot, addSourceChunk, bind, checkStatusSlotContent, clearInternal, getBusyChunk, getEmptyChunk, getErrorChunk, getFreeChunk, getFullChunk, getRequestedChunk, getSlot, getSlots, getSlots, getUnrequestedChunk, grabReferences, hasSlot, isBufferEmpty, isBufferFull, isBufferRequested, isBufferUnrequested, isErrorSet, isStateBusy, isStateError, isStateFree, removeListener, removeSlot, setBufferChunk, setErrorChunk, setStateChunk, setStatusSlotContent, shouldAcceptAsSource, shouldCopyOnInsertion, sourceChunkCopied, valueChanged

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

addListener, clear, contains, containsExact, getActivation, getActivationSpreader, getEventDispatcher, getG, getLock, getModel, getModule, getName, getSourceChunk, getSourceChunks, getSourceChunks, handlesEncoding, isStrictHarvestingEnabled, matched, removeListener, removeSourceChunk, setActivation, setActivationSpreader, setG, 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.ICapacityBuffer

getSourceChunks

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

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

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

getAdapter

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

willAccept

Field Detail

_ejectionPolicy

protected ICapacityBuffer.EjectionPolicy _ejectionPolicy

Constructor Detail

AbstractCapacityBuffer6

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

Method Detail

initialize

public void initialize()

Description copied from interface: IInitializable

intialize this component

Specified by:

initialize in interface IInitializable

Overrides:

initialize in class AbstractActivationBuffer

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 AbstractActivationBuffer6

isCapacityReached

protected abstract boolean isCapacityReached()

return true if the capacity has been reached and someone needs to be removed

Returns:

isValidChunkType

protected abstract boolean isValidChunkType(IChunkType chunkType)

return true if a chunk of this type can be added to the buffer

Returns:

getTimesAndChunks

protected java.util.Map<java.lang.Double,IChunk> getTimesAndChunks()

returns the actual backing map used. This should only be used with great caution and be sure when you do so you are wrapped within at least a readlock

Returns:

getChunksAndTimes

protected java.util.Map<IChunk,java.lang.Double> getChunksAndTimes()

addSourceChunkInternal

protected IChunk addSourceChunkInternal(IChunk chunkToInsert)

Description copied from class: AbstractActivationBuffer

return the source chunk that was actually inserted into the buffer (i.e. a copy of chunkToInsert if chunkToInsert has already been encoded).

Specified by:

addSourceChunkInternal in class AbstractActivationBuffer

Parameters:

chunkToInsert - the chunk to be inserted, will never be null nor already in the buffer

Returns:

actual chunk inserted. if null, no events are fired or activation spread

chunkInserted

protected void chunkInserted(IChunk insertedChunk)

set the status slots after insertion

Parameters:

insertedChunk -

getSourceChunkInternal

protected IChunk getSourceChunkInternal()

return the first source chunk. which will be returned depends upon ejection order, the next to get the boot will be returned

Specified by:

getSourceChunkInternal in class AbstractActivationBuffer

Returns:

getSourceChunksInternal

protected java.util.Collection<IChunk> getSourceChunksInternal(java.util.Collection<IChunk> container)

return the contents of the buffer. The order of the chunks returned is determined by the ejection policy, such that the chunk most likely to be given the book is first.

Specified by:

getSourceChunksInternal in class AbstractActivationBuffer

removeSourceChunkInternal

protected boolean removeSourceChunkInternal(IChunk chunkToRemove)

Description copied from class: AbstractActivationBuffer

do the actual work of removing chunkToRemove from the buffer.

Specified by:

removeSourceChunkInternal in class AbstractActivationBuffer

Parameters:

chunkToRemove - chunk that is in the buffer, never null

Returns:

true if activation is to be reset and an event fired

chunkRemoved

protected void chunkRemoved(IChunk removedChunk)

matchedInternal

protected boolean matchedInternal(IChunk chunk)

when a chunk is matched against, we modify its insertion time..

Overrides:

matchedInternal in class AbstractActivationBuffer

Returns:

getEjectionPolicy

public ICapacityBuffer.EjectionPolicy getEjectionPolicy()

Specified by:

getEjectionPolicy in interface ICapacityBuffer

setEjectionPolicy

public void setEjectionPolicy(ICapacityBuffer.EjectionPolicy policy)

Specified by:

setEjectionPolicy in interface ICapacityBuffer

getPossibleParameters

public java.util.Collection<java.lang.String> getPossibleParameters()

Description copied from interface: IParameterized

Return all parameters that can be read

Specified by:

getPossibleParameters in interface IParameterized

Overrides:

getPossibleParameters in class AbstractActivationBuffer

Returns:

The possibleParameters value

See Also:

IParameterized.getPossibleParameters()

getSetableParameters

public java.util.Collection<java.lang.String> getSetableParameters()

Description copied from interface: IParameterized

Return list of all parameters that can be set.

Specified by:

getSetableParameters in interface IParameterized

Overrides:

getSetableParameters in class AbstractActivationBuffer

Returns:

The setableParameters value

See Also:

IParameterized.getSetableParameters()

getParameter

public java.lang.String getParameter(java.lang.String key)

Description copied from interface: IParameterized

return parameter value - null if not defined.

Specified by:

getParameter in interface IParameterized

Overrides:

getParameter in class AbstractActivationBuffer

Parameters:

key - Description of the Parameter

Returns:

The parameter value

See Also:

IParameterized.getParameter(java.lang.String)

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)

Description copied from interface: IParameterized

Set the named parameter

Specified by:

setParameter in interface IParameterized

Overrides:

setParameter in class AbstractActivationBuffer

See Also:

IParameterized.setParameter(java.lang.String, String)