org.azyva.dragom.model.plugin

Interface ModuleVersionMatcherPlugin

All Superinterfaces:

ModulePlugin, NodePlugin

public interface ModuleVersionMatcherPlugin
extends ModulePlugin

Filters the matched ModuleVersion. Used by many jobs when traversing a reference graph.

Allows to implement ModuleVersion matching strategies which cannot be expressed with ReferencePathMatcher. Note that this matching is performed in addition to the matching performed by other means, such as with the ReferencePathMatcher, and all matchers must match for a ModuleVersion to be deemed matched.

Jobs which are aware of ModuleVersionFilter (essentially all jobs based on RootModuleVersionJobAbstractImpl from dragom-core) generally obtain this plugin with a null plugin ID. It is up to the configuration to provide or not an implementation of the plugin, or to use RuntimeSelectionPluginFactory from dragom-core to allow selecting the filtering strategy at runtime.

Author:

David Raymond

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ModuleVersionMatcherPlugin.MatchFlag Defines the match flags.

Method Summary

Modifier and Type	Method and Description
EnumSet<ModuleVersionMatcherPlugin.MatchFlag>	matches(ReferencePath referencePath, ModuleVersion moduleVersion, ByReference<String> byReferenceMessage) Called to verify if a ModuleVersion matches.

Methods inherited from interface org.azyva.dragom.model.plugin.ModulePlugin

getModule

Methods inherited from interface org.azyva.dragom.model.plugin.NodePlugin

getNode

Method Detail

matches

EnumSet<ModuleVersionMatcherPlugin.MatchFlag> matches(ReferencePath referencePath,
                                                      ModuleVersion moduleVersion,
                                                      ByReference<String> byReferenceMessage)

Called to verify if a ModuleVersion matches.

Generally, jobs which use this plugin are expected to accumulate the messages returned through byReferenceMessage and provide them to the user at the end of the job execution.

Parameters:

referencePath - ReferencePath of the ModuleVersion.

moduleVersion - ModuleVersion (corresponds necessarily to the leaf of the ReferencePath).

byReferenceMessage - Allows the method to return a message justifying the decision to include or exclude a ModuleVersion and/or its children. Generally it is expected that such a message be provided for negative responses only.

Returns:

EnumSet of MatchFlag.