com.hp.hpl.jena.reasoner.rulesys.builtins
Class Hide

java.lang.Object
  com.hp.hpl.jena.reasoner.rulesys.builtins.BaseBuiltin
      com.hp.hpl.jena.reasoner.rulesys.builtins.Hide

All Implemented Interfaces:

Builtin

public class Hide
extends BaseBuiltin

Register a node as to be hidden from query result iterators.

Version:

$Revision: 1.1 $ on $Date: 2009-06-29 08:55:36 $

Author:

Dave Reynolds

Field Summary

Fields inherited from class com.hp.hpl.jena.reasoner.rulesys.builtins.BaseBuiltin

BASE_URI

Constructor Summary

Hide()

Method Summary

boolean	bodyCall(Node[] args, int length, RuleContext context) This method is invoked when the builtin is called in a rule body.
String	getName() Return a name for this builtin, normally this will be the name of the functor that will be used to invoke it.
void	headAction(Node[] args, int length, RuleContext context) This method is invoked when the builtin is called in a rule head.

Methods inherited from class com.hp.hpl.jena.reasoner.rulesys.builtins.BaseBuiltin

checkArgs, getArg, getArgLength, getURI, isMonotonic, isSafe

Methods inherited from class java.lang.Object

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

Constructor Detail

Hide

public Hide()

Method Detail

getName

public String getName()

Return a name for this builtin, normally this will be the name of the functor that will be used to invoke it.

bodyCall

public boolean bodyCall(Node[] args,
                        int length,
                        RuleContext context)

This method is invoked when the builtin is called in a rule body.

Specified by:

bodyCall in interface Builtin

Overrides:

bodyCall in class BaseBuiltin

Parameters:

args - the array of argument values for the builtin, this is an array of Nodes, some of which may be Node_RuleVariables.

length - the length of the argument list, may be less than the length of the args array for some rule engines

context - an execution context giving access to other relevant data

Returns:

return true if the buildin predicate is deemed to have succeeded in the current environment

headAction

public void headAction(Node[] args,
                       int length,
                       RuleContext context)

This method is invoked when the builtin is called in a rule head. Such a use is only valid in a forward rule.

Specified by:

headAction in interface Builtin

Overrides:

headAction in class BaseBuiltin

Parameters:

args - the array of argument values for the builtin, this is an array of Nodes.

length - the length of the argument list, may be less than the length of the args array for some rule engines

context - an execution context giving access to other relevant data