org.jactr.core.chunktype

Interface ISymbolicChunkType

All Superinterfaces:

IAdaptable, ISlotContainer, IUniqueSlotContainer

All Known Subinterfaces:

IRemovableSymbolicChunkType

All Known Implementing Classes:

BasicSymbolicChunkType

public interface ISymbolicChunkType
extends IUniqueSlotContainer, IAdaptable

This is the basic interface for the symbolic component of chunktypes. Since ChunkTypes can utilize an inheritance structure, implementations must be sure that added slots are propagated to children chunktypes and chunk instances. Likewise, the addition of new parents (not a common occurrence) should be propogated appropriately.

Author:

harrison

Method Summary

Modifier and Type	Method and Description
void	addChild(IChunkType ct) add a chunktype as a child,
void	addChunk(IChunk c) add an encoded chunk to this chunktypes collection
IChunkType	addParent(IChunkType ct) add a parent of this chunktype
void	dispose() Description of the Method
void	encode()
java.util.Collection<IChunkType>	getChildren() return an array of all the children chunk types
java.util.Collection<IChunk>	getChunks() return all chunks of this type
java.lang.String	getName() Return the unique chunktype name.
int	getNumberOfChildren() Gets the numberOfChildren attribute of the ISymbolicChunkType object
int	getNumberOfChunks() Gets the numberOfChunks attribute of the ISymbolicChunkType object
IChunkType	getParent() single inheritance parent access.
java.util.Collection<IChunkType>	getParents() Return the immediate parent of this chunktype.
boolean	isA(IChunkType ct)
void	setName(java.lang.String name) Set the chunktype name.

Methods inherited from interface org.jactr.core.slot.IUniqueSlotContainer

getSlot, hasSlot

Methods inherited from interface org.jactr.core.slot.ISlotContainer

addSlot, getSlots, getSlots, removeSlot

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

getAdapter

Method Detail

getName

java.lang.String getName()

Return the unique chunktype name. All chunktypes, like chunks, must have unique names.

Returns:

The chunkTypeName value

Since:

setName

void setName(java.lang.String name)

Set the chunktype name. This should only be called once ? reseting the name after the model has added the chunktype can have unpredictable results.

Parameters:

name - The new chunkTypeName value

Since:

getParent

IChunkType getParent()

single inheritance parent access.

Returns:

Throws:

java.lang.IllegalStateException - if there are more than one parent

getParents

java.util.Collection<IChunkType> getParents()

Return the immediate parent of this chunktype. multiple parents are possible to support multiple inheritance

Returns:

The parent value

Since:

getChildren

java.util.Collection<IChunkType> getChildren()

return an array of all the children chunk types

Returns:

The children value

Since:

getNumberOfChildren

int getNumberOfChildren()

Gets the numberOfChildren attribute of the ISymbolicChunkType object

Returns:

The numberOfChildren value

Since:

addParent

IChunkType addParent(IChunkType ct)

add a parent of this chunktype

Returns:

addChild

void addChild(IChunkType ct)

add a chunktype as a child,

getChunks

java.util.Collection<IChunk> getChunks()

return all chunks of this type

Returns:

The chunks value

Since:

addChunk

void addChunk(IChunk c)

add an encoded chunk to this chunktypes collection

getNumberOfChunks

int getNumberOfChunks()

Gets the numberOfChunks attribute of the ISymbolicChunkType object

Returns:

The numberOfChunks value

Since:

isA

boolean isA(IChunkType ct)

dispose

void dispose()

Description of the Method

Since:

encode

void encode()