org.jactr.core.production.request

Class SlotBasedRequest

java.lang.Object

org.jactr.core.production.request.SlotBasedRequest

All Implemented Interfaces:

java.lang.Cloneable, IRequest, ISlotContainer

Direct Known Subclasses:

ChunkTypeRequest

public class SlotBasedRequest
extends java.lang.Object
implements IRequest, ISlotContainer

basic slot based request

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Collection<ISlot>	_slots
protected java.util.Collection<ISlot>	_unresolved

Constructor Summary

Constructors

Constructor and Description
SlotBasedRequest()
SlotBasedRequest(java.util.Collection<? extends ISlot> slots)

Method Summary

Modifier and Type	Method and Description
void	addSlot(ISlot slot) Adds a slot
int	bind(IModel model, java.lang.String containerName, IUniqueSlotContainer container, VariableBindings bindings, boolean iterativeCall) bind the slot values in this request against those slots contained in the container.
int	bind(IModel model, VariableBindings bindings, boolean iterativeCall) attempt to resolve all the bindings, returning the number of unresolved.
void	bindSlots(IModel model, java.lang.String containerName, IUniqueSlotContainer container, VariableBindings bindings, java.util.Collection<ISlot> slots) attempt to resolve the slot values using a container
void	bindSlots(IModel model, VariableBindings bindings, java.util.Collection<ISlot> slots) bind and resolve as many slots in the collection as possible.
SlotBasedRequest	clone() duplicate this IRequest so that the clone can be resolved against since the process is destructive
int	countMatches(IChunk chunk, VariableBindings bindings) returns the number of slots in this container that match those in the provided container.
java.util.Collection<? extends ISlot>	getConditionalAndLogicalSlots()
java.util.Collection<? extends IConditionalSlot>	getConditionalSlots()
java.util.Collection<? extends ISlot>	getSlots() return a duplicate copy of all the slots
java.util.Collection<ISlot>	getSlots(java.util.Collection<ISlot> container)
void	removeSlot(ISlot slot) remove a slot
protected boolean	resolveConditionalSlot(IConditionalSlot slotToResolve, VariableBindings bindings, java.lang.String slotContainerName, IUniqueSlotContainer slotContainer) attempt to resolve a single (non logical) slot.
protected boolean	resolveLogicalSlot(ILogicalSlot slotToResolve, VariableBindings bindings, java.lang.String slotContainerName, IUniqueSlotContainer container) resolve a logical slot.
protected boolean	resolveSlot(ISlot slot, VariableBindings bindings, java.lang.String slotContainerName, IUniqueSlotContainer container)
protected void	setLocked(boolean locked)

Methods inherited from class java.lang.Object

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

Field Detail

_slots

protected java.util.Collection<ISlot> _slots

_unresolved

protected java.util.Collection<ISlot> _unresolved

Constructor Detail

SlotBasedRequest

public SlotBasedRequest()

SlotBasedRequest

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

Method Detail

countMatches

public int countMatches(IChunk chunk,
                        VariableBindings bindings)

returns the number of slots in this container that match those in the provided container.

Parameters:

container -

Returns:

resolveSlot

protected boolean resolveSlot(ISlot slot,
                              VariableBindings bindings,
                              java.lang.String slotContainerName,
                              IUniqueSlotContainer container)
                       throws CannotMatchException

Throws:

CannotMatchException

resolveLogicalSlot

protected boolean resolveLogicalSlot(ILogicalSlot slotToResolve,
                                     VariableBindings bindings,
                                     java.lang.String slotContainerName,
                                     IUniqueSlotContainer container)
                              throws CannotMatchException

resolve a logical slot. We do this by recursing down and only checking on the return result and exceptions based on the logical condition

Parameters:

slotToResolve -

bindings -

slotContainerName -

container -

Returns:

Throws:

CannotMatchException

resolveConditionalSlot

protected boolean resolveConditionalSlot(IConditionalSlot slotToResolve,
                                         VariableBindings bindings,
                                         java.lang.String slotContainerName,
                                         IUniqueSlotContainer slotContainer)
                                  throws CannotMatchException

attempt to resolve a single (non logical) slot. this will attempt to resolve variable names and values, in addition to extending the binding set (if there is a container to match against). Impossible matching errors may result in cannot match.

Parameters:

slotToResolve -

model -

bindings -

slotContainer -

Returns:

true if it is fully resolved, false if it cannot be resolved at present

Throws:

CannotMatchException

bind

public int bind(IModel model,
                VariableBindings bindings,
                boolean iterativeCall)
         throws CannotMatchException

attempt to resolve all the bindings, returning the number of unresolved. This is the main entry call for the IRequest class. An alternative entry call is available for those that want to bind against a specific slot container bind(IModel, String, IUniqueSlotContainer, VariableBindings, boolean)

Specified by:

bind in interface IRequest

Returns:

number of unresolved variables in this request

Throws:

CannotMatchException

bind

public int bind(IModel model,
                java.lang.String containerName,
                IUniqueSlotContainer container,
                VariableBindings bindings,
                boolean iterativeCall)
         throws CannotMatchException

bind the slot values in this request against those slots contained in the container. This allows us to generally bind against anything that contains a slot (chunk, chunktype, or buffer for queries)

Parameters:

model -

container -

bindings -

iterativeCall -

Returns:

Throws:

CannotMatchException

bindSlots

public void bindSlots(IModel model,
                      java.lang.String containerName,
                      IUniqueSlotContainer container,
                      VariableBindings bindings,
                      java.util.Collection<ISlot> slots)
               throws CannotMatchException

attempt to resolve the slot values using a container

Parameters:

model -

containerName -

container -

bindings -

slots -

Throws:

CannotMatchException

bindSlots

public void bindSlots(IModel model,
                      VariableBindings bindings,
                      java.util.Collection<ISlot> slots)
               throws CannotMatchException

bind and resolve as many slots in the collection as possible.

Throws:

CannotMatchException - if there is a critical binding error

clone

public SlotBasedRequest clone()

Description copied from interface: IRequest

duplicate this IRequest so that the clone can be resolved against since the process is destructive

Specified by:

clone in interface IRequest

Overrides:

clone in class java.lang.Object

Returns:

deep copy

setLocked

protected void setLocked(boolean locked)

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

getConditionalSlots

public java.util.Collection<? extends IConditionalSlot> getConditionalSlots()

getConditionalAndLogicalSlots

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

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

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

getSlots

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

Specified by:

getSlots in interface ISlotContainer