com.orchestranetworks.addon.mame.registration

Interface MergeFunctionDeclaration

public interface MergeFunctionDeclaration

Declares a custom merge function.

A merge function can be registered and declared in the context of a MatchAndMergeRegistry.registerMergeFunction(MergeFunctionDeclaration)

Since:

6.0.1

Method Summary

Modifier and Type	Method and Description
com.onwbp.base.text.UserMessage	getDescription() Returns the description of the function.
com.onwbp.base.text.UserMessage	getLabel() Returns the label of the function.
FieldMergeFunction	getMergeFunction() Returns a merge function.
String	getName() Returns the merge function name.

Method Detail

getName

String getName()

Returns the merge function name. The name must be unique across all merge functions. This method is invoked when the custom merge function is registered in the MatchAndMergeRegistry.

Returns:

String The merge function identifier

getLabel

com.onwbp.base.text.UserMessage getLabel()

Returns the label of the function.

This method is invoked when display the merge function localized name in the view.

Returns:

The label of the merge function

getDescription

com.onwbp.base.text.UserMessage getDescription()

Returns the description of the function.

This method is invoked when display the merge function description in the view.

Returns:

The description of the merge function

getMergeFunction

FieldMergeFunction getMergeFunction()

Returns a merge function.

This method is invoked every time the merge sessions are launched.

Returns:

The merge function implementation. Returning a MergeFunction object is mandatory. This accessor is called internally only.