org.tm4j.tolog
Interface Extension

All Known Implementing Classes:
DirectInstanceOfExtension, InstanceOfExtension

Deprecated. from 0.9.5 use the package org.tm4j.tologx.

public interface Extension

Classes which implement this interface can be used to provide extension predicates to the Tolog language. To be loaded, an Extension implementation must also provide a no-arguments constructor.


Method Summary
 int getMaxParams()
          Deprecated. The extension should return the maximum number of parameters which it supports.
 void initialise(TopicMap tm)
          Deprecated. This method is called on the extension when the extension is instantiated by the QueryEvaluator and before any calls to the matches() or test() methods.
 boolean matches(java.util.List prParams, java.util.List prMatches)
          Deprecated. Extension should return true if the PlayerRole objects in prPairs specify a combination which is valid under this function.
 boolean test(java.util.List prParams)
          Deprecated. Extension should return true if the PlayerRole objects in prPairs specify a combination which is valid under this function.
 

Method Detail

initialise

public void initialise(TopicMap tm)
Deprecated. 
This method is called on the extension when the extension is instantiated by the QueryEvaluator and before any calls to the matches() or test() methods. Implementations may use this method to perform any implementation-specific initialisation that is required.

Parameters:
tm - the topic map to be queried.

matches

public boolean matches(java.util.List prParams,
                       java.util.List prMatches)
Deprecated. 
Extension should return true if the PlayerRole objects in prPairs specify a combination which is valid under this function.

Parameters:
prParams - A list of PlayerRole objects specifying the value of each parameter in the function. The list is in parameter order.
prMatches - A List to receive each of the possible matches returned by this function (each match is specified as a List of the PlayerRole match value for each parameter postion).

test

public boolean test(java.util.List prParams)
Deprecated. 
Extension should return true if the PlayerRole objects in prPairs specify a combination which is valid under this function.

Parameters:
prParams - A list of PlayerRole objects specifying the value of each parameter in the function. The list is in parameter order.

getMaxParams

public int getMaxParams()
Deprecated. 
The extension should return the maximum number of parameters which it supports. A return value of less than 0 indicates that the extension can support any number of parameters.