org.jactr.modules.declarative

Class DelegatedDeclarativeModule

java.lang.Object

org.jactr.modules.declarative.DelegatedDeclarativeModule

All Implemented Interfaces:

IDeclarativeModule, IModule, IAdaptable, IInitializable, IInstallable, IParameterized

Direct Known Subclasses:

DefaultVersionedDeclarativeModule

public class DelegatedDeclarativeModule
extends java.lang.Object
implements IDeclarativeModule, IParameterized

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	_deferredParameters
protected IDeclarativeModule	_delegate
protected IModel	_model
static java.lang.String	DECLARATIVE_DELEGATE_PARAM

Constructor Summary

Constructors

Constructor and Description
DelegatedDeclarativeModule()

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<IChunk>	addChunk(IChunk chunk) add this chunk to the model and optionally check for duplicates so that it can be merged if necessary
java.util.concurrent.CompletableFuture<IChunkType>	addChunkType(IChunkType chunkType) add the chunktype to the model.
void	addListener(IDeclarativeModuleListener listener, java.util.concurrent.Executor executor)
java.util.concurrent.CompletableFuture<IChunk>	copyChunk(IChunk sourceChunk) return a copy of source chunk
java.util.concurrent.CompletableFuture<IChunk>	copyChunk(IChunk sourceChunk, boolean copySubsymbolics)
java.util.concurrent.CompletableFuture<IChunk>	createChunk(IChunkType parent, java.lang.String name) create a chunk to later be inserted.
java.util.concurrent.CompletableFuture<IChunkType>	createChunkType(java.util.Collection<IChunkType> parents, java.lang.String name) create a new chunktype to be added after its symbolic contents have been set.
java.util.concurrent.CompletableFuture<IChunkType>	createChunkType(IChunkType parent, java.lang.String name)
void	dispose() release any resources.
void	dispose(IChunk chunk) request that this chunk be disposed.
java.util.concurrent.CompletableFuture<java.util.Collection<IChunk>>	findExactMatches(ChunkTypeRequest request, java.util.Comparator<IChunk> sorter, IChunkFilter filter) search DM for all the chunks that match pattern, sorting using sorter, that are above activationThreshold
java.util.concurrent.CompletableFuture<java.util.Collection<IChunk>>	findPartialMatches(ChunkTypeRequest request, java.util.Comparator<IChunk> sorter, IChunkFilter filter) search DM for all the chunks that partially match
void	flush() force all pending deferred operations to execute (dispose, encode, etc)
java.lang.Object	getAdapter(java.lang.Class adapterClass)
IAssociativeLinkageSystem	getAssociativeLinkageSystem() code responsible for the setting up and maintaining of associative links, may be null.
IChunk	getBusyChunk() snag the busy chunk. Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.
java.util.concurrent.CompletableFuture<IChunk>	getChunk(java.lang.String name) return the named chunk, case insensitive but preserving
java.util.concurrent.CompletableFuture<java.util.Collection<IChunk>>	getChunks() return all chunks.
java.util.concurrent.CompletableFuture<IChunkType>	getChunkType(java.lang.String name) return the named chunktype.
java.util.concurrent.CompletableFuture<java.util.Collection<IChunkType>>	getChunkTypes() return all the chunk types in this model
IDeclarativeModule	getDelegate()
IChunk	getEmptyChunk() snag the busy chunk. Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.
IChunk	getErrorChunk() snag the busy chunk. Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.
IChunk	getFreeChunk() snag the busy chunk. Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.
IChunk	getFullChunk() snag the busy chunk. Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.
IModel	getModel() return the model this module is installed into
java.lang.String	getName() the name of the module
IChunk	getNewChunk() snag the busy chunk. Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.
long	getNumberOfChunks() return the number of chunks in the model.
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
IChunk	getRequestedChunk() snag the busy chunk. Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.
java.util.Collection<java.lang.String>	getSetableParameters() Return list of all parameters that can be set.
IChunk	getUnrequestedChunk() snag the busy chunk. Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.
void	initialize() this will be called after all the modules have been installed permitting the module to attach listeners to other modules.
void	install(IModel model) called from the model during IModel.install(IModule).
void	removeListener(IDeclarativeModuleListener listener)
void	reset() reset the module.
void	setAssociativeLinkageSystem(IAssociativeLinkageSystem linkageSystem) the code responsible for linking memories.
void	setParameter(java.lang.String key, java.lang.String value) Set the named parameter
void	uninstall(IModel model) remove the element from this model.
boolean	willEncode(IChunk chunk) because encoding might be async, we need a method to determine if a given chunk is scheduled for encoding

Methods inherited from class java.lang.Object

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

Field Detail

_delegate

protected IDeclarativeModule _delegate

_model

protected IModel _model

_deferredParameters

protected java.util.Map<java.lang.String,java.lang.String> _deferredParameters

DECLARATIVE_DELEGATE_PARAM

public static final java.lang.String DECLARATIVE_DELEGATE_PARAM

See Also:

Constant Field Values

Constructor Detail

DelegatedDeclarativeModule

public DelegatedDeclarativeModule()

Method Detail

getDelegate

public IDeclarativeModule getDelegate()

install

public void install(IModel model)

Description copied from interface: IModule

called from the model during IModel.install(IModule). The module should handle any nondependent initialization here. Since no chunks will have been installed yet, the module should make not attempt to make reference to any until just before the model runs. Likewise, you should not install listeners into modules that this one is dependent upon until initialize() is called.

Specified by:

install in interface IModule

Specified by:

install in interface IInstallable

See Also:

IInstallable.install(org.jactr.core.model.IModel)

initialize

public void initialize()

Description copied from interface: IModule

this will be called after all the modules have been installed permitting the module to attach listeners to other modules. if you want to get access to chunks,types, or productions before the model runs, attach a model listener and do that during the modelStarted call

Specified by:

initialize in interface IModule

Specified by:

initialize in interface IInitializable

getName

public java.lang.String getName()

Description copied from interface: IModule

the name of the module

Specified by:

getName in interface IModule

Returns:

getModel

public IModel getModel()

Description copied from interface: IModule

return the model this module is installed into

Specified by:

getModel in interface IModule

dispose

public void dispose()

Description copied from interface: IModule

release any resources. this should only be called by the model during its own dispose method (assuming that this module is still installed) and should not result in the propogation of ANY events. The module should dispose of all its resources, including buffers

Specified by:

dispose in interface IModule

reset

public void reset()

Description copied from interface: IModule

reset the module. This will typically clear the owned buffers and abort any module specific operations

Specified by:

reset in interface IModule

uninstall

public void uninstall(IModel model)

Description copied from interface: IInstallable

remove the element from this model. this is called after the model terminates

Specified by:

uninstall in interface IInstallable

getAdapter

public java.lang.Object getAdapter(java.lang.Class adapterClass)

Specified by:

getAdapter in interface IAdaptable

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

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

Parameters:

key - Description of the Parameter

Returns:

The parameter value

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

Returns:

The possibleParameters value

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

Returns:

The setableParameters value

createChunkType

public java.util.concurrent.CompletableFuture<IChunkType> createChunkType(IChunkType parent,
                                                                          java.lang.String name)

Specified by:

createChunkType in interface IDeclarativeModule

createChunkType

public java.util.concurrent.CompletableFuture<IChunkType> createChunkType(java.util.Collection<IChunkType> parents,
                                                                          java.lang.String name)

Description copied from interface: IDeclarativeModule

create a new chunktype to be added after its symbolic contents have been set. typically this will just delegate to the factory methods, but is provided here so that declarative modules can insert custom creators

Specified by:

createChunkType in interface IDeclarativeModule

Returns:

addChunkType

public java.util.concurrent.CompletableFuture<IChunkType> addChunkType(IChunkType chunkType)

Description copied from interface: IDeclarativeModule

add the chunktype to the model. this chunktype should have been created by createChunkType(). It will call the IChunkType.encode() method, add this chunktype to the parent's list of children (if there is a parent) and then add it to the internal data stores

Specified by:

addChunkType in interface IDeclarativeModule

Returns:

getChunkType

public java.util.concurrent.CompletableFuture<IChunkType> getChunkType(java.lang.String name)

Description copied from interface: IDeclarativeModule

return the named chunktype. Case insensitive, but preserving

Specified by:

getChunkType in interface IDeclarativeModule

Returns:

getChunkTypes

public java.util.concurrent.CompletableFuture<java.util.Collection<IChunkType>> getChunkTypes()

Description copied from interface: IDeclarativeModule

return all the chunk types in this model

Specified by:

getChunkTypes in interface IDeclarativeModule

Returns:

createChunk

public java.util.concurrent.CompletableFuture<IChunk> createChunk(IChunkType parent,
                                                                  java.lang.String name)

Description copied from interface: IDeclarativeModule

create a chunk to later be inserted.

Specified by:

createChunk in interface IDeclarativeModule

Parameters:

parent - must not be null (duh)

Returns:

dispose

public void dispose(IChunk chunk)

Description copied from interface: IDeclarativeModule

request that this chunk be disposed.

Specified by:

dispose in interface IDeclarativeModule

getAssociativeLinkageSystem

public IAssociativeLinkageSystem getAssociativeLinkageSystem()

Description copied from interface: IDeclarativeModule

code responsible for the setting up and maintaining of associative links, may be null.

Specified by:

getAssociativeLinkageSystem in interface IDeclarativeModule

Returns:

setAssociativeLinkageSystem

public void setAssociativeLinkageSystem(IAssociativeLinkageSystem linkageSystem)

Description copied from interface: IDeclarativeModule

the code responsible for linking memories. Can be null if this is unsupported. Typically this will be called by a declarative learning module to install custom version

Specified by:

setAssociativeLinkageSystem in interface IDeclarativeModule

copyChunk

public java.util.concurrent.CompletableFuture<IChunk> copyChunk(IChunk sourceChunk)

Description copied from interface: IDeclarativeModule

return a copy of source chunk

Specified by:

copyChunk in interface IDeclarativeModule

Returns:

copyChunk

public java.util.concurrent.CompletableFuture<IChunk> copyChunk(IChunk sourceChunk,
                                                                boolean copySubsymbolics)

Specified by:

copyChunk in interface IDeclarativeModule

addChunk

public java.util.concurrent.CompletableFuture<IChunk> addChunk(IChunk chunk)

Description copied from interface: IDeclarativeModule

add this chunk to the model and optionally check for duplicates so that it can be merged if necessary

Specified by:

addChunk in interface IDeclarativeModule

Returns:

a future wrapper of the actual chunk reference that was installed. if the chunk was actually merged, the original chunk is returned

willEncode

public boolean willEncode(IChunk chunk)

Description copied from interface: IDeclarativeModule

because encoding might be async, we need a method to determine if a given chunk is scheduled for encoding

Specified by:

willEncode in interface IDeclarativeModule

Returns:

getChunk

public java.util.concurrent.CompletableFuture<IChunk> getChunk(java.lang.String name)

Description copied from interface: IDeclarativeModule

return the named chunk, case insensitive but preserving

Specified by:

getChunk in interface IDeclarativeModule

Returns:

getChunks

public java.util.concurrent.CompletableFuture<java.util.Collection<IChunk>> getChunks()

Description copied from interface: IDeclarativeModule

return all chunks. This can be a very expensive operation

Specified by:

getChunks in interface IDeclarativeModule

Returns:

getNumberOfChunks

public long getNumberOfChunks()

Description copied from interface: IDeclarativeModule

return the number of chunks in the model. this might be an estimate

Specified by:

getNumberOfChunks in interface IDeclarativeModule

Returns:

findExactMatches

public java.util.concurrent.CompletableFuture<java.util.Collection<IChunk>> findExactMatches(ChunkTypeRequest request,
                                                                                             java.util.Comparator<IChunk> sorter,
                                                                                             IChunkFilter filter)

Description copied from interface: IDeclarativeModule

search DM for all the chunks that match pattern, sorting using sorter, that are above activationThreshold

Specified by:

findExactMatches in interface IDeclarativeModule

sorter - sort order, may be null

filter - filter function, may be null

Returns:

findPartialMatches

public java.util.concurrent.CompletableFuture<java.util.Collection<IChunk>> findPartialMatches(ChunkTypeRequest request,
                                                                                               java.util.Comparator<IChunk> sorter,
                                                                                               IChunkFilter filter)

Description copied from interface: IDeclarativeModule

search DM for all the chunks that partially match

Specified by:

findPartialMatches in interface IDeclarativeModule

sorter - may be null

filter - TODO

Returns:

getBusyChunk

public IChunk getBusyChunk()

Description copied from interface: IDeclarativeModule

snag the busy chunk.

Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.

Specified by:

getBusyChunk in interface IDeclarativeModule

Returns:

getEmptyChunk

public IChunk getEmptyChunk()

Description copied from interface: IDeclarativeModule

snag the busy chunk.

Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.

Specified by:

getEmptyChunk in interface IDeclarativeModule

Returns:

getErrorChunk

public IChunk getErrorChunk()

Description copied from interface: IDeclarativeModule

snag the busy chunk.

Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.

Specified by:

getErrorChunk in interface IDeclarativeModule

Returns:

getFreeChunk

public IChunk getFreeChunk()

Description copied from interface: IDeclarativeModule

snag the busy chunk.

Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.

Specified by:

getFreeChunk in interface IDeclarativeModule

Returns:

getFullChunk

public IChunk getFullChunk()

Description copied from interface: IDeclarativeModule

snag the busy chunk.

Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.

Specified by:

getFullChunk in interface IDeclarativeModule

Returns:

getNewChunk

public IChunk getNewChunk()

Description copied from interface: IDeclarativeModule

snag the busy chunk.

Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.

Specified by:

getNewChunk in interface IDeclarativeModule

Returns:

getRequestedChunk

public IChunk getRequestedChunk()

Description copied from interface: IDeclarativeModule

snag the busy chunk.

Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.

Specified by:

getRequestedChunk in interface IDeclarativeModule

Returns:

getUnrequestedChunk

public IChunk getUnrequestedChunk()

Description copied from interface: IDeclarativeModule

snag the busy chunk.

Note : this should not be called by the declarative memory module if the retrieval will access the future methods as it might result in deadlock.

Specified by:

getUnrequestedChunk in interface IDeclarativeModule

Returns:

addListener

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

Specified by:

addListener in interface IDeclarativeModule

removeListener

public void removeListener(IDeclarativeModuleListener listener)

Specified by:

removeListener in interface IDeclarativeModule

flush

public void flush()

Description copied from interface: IDeclarativeModule

force all pending deferred operations to execute (dispose, encode, etc)

Specified by:

flush in interface IDeclarativeModule