com.clarkparsia.pellet.rules

Class ObjectVariableBindingHelper

java.lang.Object

com.clarkparsia.pellet.rules.ObjectVariableBindingHelper

All Implemented Interfaces:

BindingHelper

public class ObjectVariableBindingHelper
extends Object
implements BindingHelper

Title: Object Variable Binding Helper

Description: A binding helper that will iterate over all named individuals in the abox.

Copyright: Copyright (c) 2007

Company: Clark & Parsia, LLC.

Author:

Ron Alford

Constructor Summary

Constructors

Constructor and Description
ObjectVariableBindingHelper(ABox abox, AtomIVariable var)

Method Summary

Methods

Modifier and Type	Method and Description
Collection<AtomIVariable>	getBindableVars(Collection<AtomVariable> bound) Returns a set of variables which this binding helper can bind.
Collection<AtomIVariable>	getPrerequisiteVars(Collection<AtomVariable> bound) Returns a set of variables which must be bound before this helper can generate bindings.
void	rebind(VariableBinding newBinding) Set the incoming binding for this helper.
boolean	selectNextBinding() Selects the next binding.
void	setCurrentBinding(VariableBinding currentBinding) Set the variables this pattern uses in the given map.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectVariableBindingHelper

public ObjectVariableBindingHelper(ABox abox,
                           AtomIVariable var)

Method Detail

getBindableVars

public Collection<AtomIVariable> getBindableVars(Collection<AtomVariable> bound)

Description copied from interface: BindingHelper

Returns a set of variables which this binding helper can bind.

Specified by:

getBindableVars in interface BindingHelper

getPrerequisiteVars

public Collection<AtomIVariable> getPrerequisiteVars(Collection<AtomVariable> bound)

Description copied from interface: BindingHelper

Returns a set of variables which must be bound before this helper can generate bindings.

Specified by:

getPrerequisiteVars in interface BindingHelper

rebind

public void rebind(VariableBinding newBinding)

Description copied from interface: BindingHelper

Set the incoming binding for this helper. This fixes any variables that are already bound by a preceding Binding Helper.

Specified by:

rebind in interface BindingHelper

Parameters:

newBinding - Binding map. Implementation will copy map if needed.

selectNextBinding

public boolean selectNextBinding()

Description copied from interface: BindingHelper

Selects the next binding.

Specified by:

selectNextBinding in interface BindingHelper

Returns:

True if a binding was available for this pattern given the initial binding. False otherwise. Will return if the binding is not set.

setCurrentBinding

public void setCurrentBinding(VariableBinding currentBinding)

Description copied from interface: BindingHelper

Set the variables this pattern uses in the given map.

Specified by:

setCurrentBinding in interface BindingHelper

toString

public String toString()

Overrides:

toString in class Object