Overview | Package | Class | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.sun.mdm.index.matching
Interface MatcherAPI

All Known Implementing Classes:
  SbmeMatcherAdapter

public interface MatcherAPI

The interface a match engine adapter has to implement to enable communication between the framework and the specific match engine.

Method Summary
`java.util.ArrayList` | `findWeights(SystemObject base, QueryResults block, MatchOptions matchOptions)` Find all the match weights comparing the bases systemobject to the 'block' records retrieved from the DB
`void` | `initialize(MatchEngineConfiguration config)` Initialize the match engine and the adapter called once upon startup for each adapter instance
`void` | `shutdown()` Shutdown and release any resources associated with the match engine and the adapter Called once per adapter instance before the adapter is discarded by the framework

Method Detail

### findWeights

    public java.util.ArrayList findWeights(SystemObject base,
                                           QueryResults block,
                                           MatchOptions matchOptions)
                                    throws MatchingException

  Find all the match weights comparing the bases systemobject to the 'block' records retrieved from the DB

  Parameters:
    `base` - the system object to match against
    `block` - the block of DB records to compare with
    `matchOptions` - controls any matcher options such as minimum score
  Returns:
    An ArrayList containing the ScoreElements with the weights associated with an EUID.
  Throws:
    `MatchingException` - if the Matching failed

### initialize

    public void initialize(MatchEngineConfiguration config)
                    throws MatchingException

  Initialize the match engine and the adapter called once upon startup for each adapter instance

  Parameters:
    `config` - the match engine configuration configured
  Throws:
    `MatchingException` - if the initialization failed

### shutdown

    public void shutdown()
                  throws MatchingException

  Shutdown and release any resources associated with the match engine and the adapter Called once per adapter instance before the adapter is discarded by the framework

  Throws:
    `MatchingException` - if the shutdown failed

Overview | Package | Class | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Sun Microsystems, Inc.