org.jactr.modules.pm.common.memory.map

Class AbstractFeatureMap<T>

java.lang.Object

org.jactr.modules.pm.common.memory.map.AbstractFeatureMap<T>

All Implemented Interfaces:

IAfferentObjectListener, IFeatureMap<T>

Direct Known Subclasses:

AbstractAuralFeatureMap, AbstractSortedFeatureMap, AbstractVisualFeatureMap

public abstract class AbstractFeatureMap<T>
extends java.lang.Object
implements IFeatureMap<T>

Constructor Summary

Constructors

Constructor and Description
AbstractFeatureMap(java.lang.String requestSlotName, java.lang.String crPropertyName)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addInformation(IIdentifier identifier, T data)
void	addListener(IFeatureMapListener listener, java.util.concurrent.Executor executor)
void	afferentObjectAdded(IAfferentObject object)
void	afferentObjectRemoved(IAfferentObject object)
void	afferentObjectUpdated(IAfferentObject object, IObjectDelta delta)
void	clear()
protected abstract void	clearInternal()
protected void	dispatch(FeatureMapEvent event)
void	dispose()
protected abstract T	extractInformation(IAfferentObject afferentObject)
void	fillSlotValues(ChunkTypeRequest mutableRequest, IIdentifier identifier, IChunk encodedChunk, ChunkTypeRequest originalSearchRequest) fill the slot values accordingly for this identifier at the mutablePattern location this is then used to further specify the actual location chunk that will be returned
void	getCandidateRealObjects(ChunkTypeRequest request, java.util.Set<IIdentifier> container) return all the identifiers of all possible objects that can exist at the visual location defined by this search pattern if nothing is available, and empty collection is to be returned
protected abstract void	getCandidates(ChunkTypeRequest request, java.util.Set<IIdentifier> results)
protected abstract T	getCurrentValue(IIdentifier identifier)
T	getInformation(IIdentifier identifier) returns the feature value for this object
protected java.util.concurrent.locks.Lock	getLock()
IPerceptualMemory	getPerceptualMemory()
protected java.lang.String	getRelevantPropertyName()
protected java.lang.String	getRelevantSlotName()
protected boolean	hasListeners()
boolean	isInterestedIn(ChunkTypeRequest request) is getRelevantSlotName() is not null, this will check to see if the request contains that slot name.
protected void	objectAdded(IAfferentObject object, T data) call back after object information has been added, assuming data was not null
protected void	objectRemoved(IAfferentObject object, T data) callback
protected void	objectUpdated(IAfferentObject object, T oldData, T newData)
protected abstract T	removeInformation(IIdentifier identifier)
void	removeListener(IFeatureMapListener listener)
void	setPerceptualMemory(IPerceptualMemory memory)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jactr.modules.pm.common.memory.map.IFeatureMap

normalizeRequest

Methods inherited from interface org.jactr.modules.pm.common.afferent.IAfferentObjectListener

isInterestedIn

Constructor Detail

AbstractFeatureMap

public AbstractFeatureMap(java.lang.String requestSlotName,
                          java.lang.String crPropertyName)

Method Detail

getRelevantSlotName

protected java.lang.String getRelevantSlotName()

getRelevantPropertyName

protected java.lang.String getRelevantPropertyName()

addListener

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

Specified by:

addListener in interface IFeatureMap<T>

removeListener

public void removeListener(IFeatureMapListener listener)

Specified by:

removeListener in interface IFeatureMap<T>

hasListeners

protected boolean hasListeners()

dispatch

protected void dispatch(FeatureMapEvent event)

setPerceptualMemory

public void setPerceptualMemory(IPerceptualMemory memory)

Specified by:

setPerceptualMemory in interface IFeatureMap<T>

getPerceptualMemory

public IPerceptualMemory getPerceptualMemory()

Specified by:

getPerceptualMemory in interface IFeatureMap<T>

getLock

protected java.util.concurrent.locks.Lock getLock()

clearInternal

protected abstract void clearInternal()

clear

public final void clear()

Specified by:

clear in interface IFeatureMap<T>

dispose

public void dispose()

Specified by:

dispose in interface IFeatureMap<T>

fillSlotValues

public void fillSlotValues(ChunkTypeRequest mutableRequest,
                           IIdentifier identifier,
                           IChunk encodedChunk,
                           ChunkTypeRequest originalSearchRequest)

Description copied from interface: IFeatureMap

fill the slot values accordingly for this identifier at the mutablePattern location this is then used to further specify the actual location chunk that will be returned

Specified by:

fillSlotValues in interface IFeatureMap<T>

Parameters:

mutableRequest - the pseudo visual location to be setup

encodedChunk - TODO

getInformation

public final T getInformation(IIdentifier identifier)

Description copied from interface: IFeatureMap

returns the feature value for this object

Specified by:

getInformation in interface IFeatureMap<T>

Returns:

getCandidateRealObjects

public final void getCandidateRealObjects(ChunkTypeRequest request,
                                          java.util.Set<IIdentifier> container)

Description copied from interface: IFeatureMap

return all the identifiers of all possible objects that can exist at the visual location defined by this search pattern if nothing is available, and empty collection is to be returned

Specified by:

getCandidateRealObjects in interface IFeatureMap<T>

isInterestedIn

public boolean isInterestedIn(ChunkTypeRequest request)

is getRelevantSlotName() is not null, this will check to see if the request contains that slot name.

Specified by:

isInterestedIn in interface IFeatureMap<T>

Parameters:

request -

Returns:

See Also:

IFeatureMap.isInterestedIn(org.jactr.core.production.request.ChunkTypeRequest)

afferentObjectAdded

public final void afferentObjectAdded(IAfferentObject object)

Specified by:

afferentObjectAdded in interface IAfferentObjectListener

objectAdded

protected void objectAdded(IAfferentObject object,
                           T data)

call back after object information has been added, assuming data was not null

Parameters:

object -

data -

afferentObjectRemoved

public final void afferentObjectRemoved(IAfferentObject object)

Specified by:

afferentObjectRemoved in interface IAfferentObjectListener

objectRemoved

protected void objectRemoved(IAfferentObject object,
                             T data)

callback

Parameters:

object -

data -

afferentObjectUpdated

public final void afferentObjectUpdated(IAfferentObject object,
                                        IObjectDelta delta)

Specified by:

afferentObjectUpdated in interface IAfferentObjectListener

objectUpdated

protected void objectUpdated(IAfferentObject object,
                             T oldData,
                             T newData)

getCurrentValue

protected abstract T getCurrentValue(IIdentifier identifier)

extractInformation

protected abstract T extractInformation(IAfferentObject afferentObject)

removeInformation

protected abstract T removeInformation(IIdentifier identifier)

addInformation

protected abstract void addInformation(IIdentifier identifier,
                                       T data)

getCandidates

protected abstract void getCandidates(ChunkTypeRequest request,
                                      java.util.Set<IIdentifier> results)