com.xenonsoft.bridgetown.examples.categoriser
Interface IMatcher

All Known Implementing Classes:

DefaultMatcherImpl

public interface IMatcher

Interface for categorisation matcher

Version:

$Id: IMatcher.java,v 1.2 2005/02/23 01:29:20 peter_pilgrim Exp $

Author:

Peter Pilgrim, Jul 26, 2004 2:05:39 PM

Method Summary

java.util.List	match(java.lang.Object query, java.lang.Object refValue) Attempt to find possible matches with the query object as a template that uses the values contained inside the reference object.
void	setDescription(java.lang.String description) Sets the description
void	setMode(java.lang.String mode) Sets the mode

Method Detail

setDescription

public void setDescription(java.lang.String description)

Sets the description

setMode

public void setMode(java.lang.String mode)

Sets the mode

Parameters:

mode -

match

public java.util.List match(java.lang.Object query,
                            java.lang.Object refValue)

Attempt to find possible matches with the query object as a template that uses the values contained inside the reference object.

Parameters:

query - the query template instance

refValue - the object uses as a reference

Returns:

List collection of probable matching elements. An empty list denotes that no matches can be found.