Package com.illumon.iris.gui.filterlink

Class FilterLinkHelper

java.lang.Object

com.illumon.iris.gui.filterlink.FilterLinkHelper

public class FilterLinkHelper
extends Object

A helper class that implements basic Filter Link functionality. Classes that implement LinkSource or LinkTarget can delegate many of their methods to this class.

Constructor Summary

Constructors

Constructor	Description
FilterLinkHelper(com.fishlib.io.logger.Logger log, IrisView view, Linkable linkable)
FilterLinkHelper(com.fishlib.io.logger.Logger log, IrisView view, Linkable linkable, Consumer<ImageIcon> filterIconChangedHandler)

Method Summary

Modifier and Type	Method	Description
void	addTarget(LinkTarget target)
void	editLinks(Window win)	Opens the link editor dialog.
void	fireEvent(LinkEvent event)	Sends a link event to all targets.
void	forEachTarget(Consumer<LinkTarget> action)	Execute the specified action against each target of this linkable.
ImageIcon	getLinkIcon()	Get the appropriate link icon for the currently established set of links.
Map<LinkSource,Collection<LinkDescriptor>>	getLinks()
Collection<LinkDescriptor>	getLinks(LinkSource source)
Set<String>	getSourceLinkColumns()
Collection<LinkTarget>	getTargets()
void	init()
boolean	isLinked()
void	makeLink(LinkSource from, String sourceColumn, String targetColumn, Condition condition)
void	maybeUpdateIcon()	If this helper was constructed with an iconChangedHandler it invokes that with the appropriate icon, otherwise it will update the view icon based on the current link status.
void	removeAllLinks()
void	removeAllLinks(LinkSource from)
void	removeBrokenLinks(LinkTarget target)	Search for and remove all links to the specified target that are broken (a column does not exist on one or both sides)
void	removeLink(LinkSource from, String srcColumn, String targetColumn, Condition condition)
void	removeLink(LinkTarget to, String srcColumn, String targetColumn, Condition condition)	Remove the specified link from this object to the specified target.
void	removeTarget(LinkTarget target)
void	tryLinkFrom(Window win)	Initiates the process of creating a link from another Linkable.
void	tryLinkTo(Window win)	Initiates the process of creating a link to another Linkable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FilterLinkHelper

public FilterLinkHelper(@NotNull com.fishlib.io.logger.Logger log, @Nullable IrisView view, @NotNull Linkable linkable)

FilterLinkHelper

public FilterLinkHelper(@NotNull com.fishlib.io.logger.Logger log, @Nullable IrisView view, @NotNull Linkable linkable, @Nullable Consumer<ImageIcon> filterIconChangedHandler)

Method Details

init

public void init()

addTarget

public void addTarget(LinkTarget target)

See Also:

LinkSource.addTarget(LinkTarget)

removeTarget

public void removeTarget(LinkTarget target)

See Also:

LinkSource.removeTarget(LinkTarget)

getTargets

public Collection<LinkTarget> getTargets()

See Also:

LinkSource.getTargets()

makeLink

public void makeLink(LinkSource from, String sourceColumn, String targetColumn, Condition condition)

See Also:

LinkTarget.makeLink(LinkSource, String, String, Condition)

removeLink

public void removeLink(LinkSource from, String srcColumn, String targetColumn, Condition condition)

See Also:

LinkTarget.removeLink(LinkSource, String, String, Condition)

removeLink

public void removeLink(LinkTarget to, String srcColumn, String targetColumn, Condition condition)

Remove the specified link from this object to the specified target.

Parameters:

to - the target object of the link

srcColumn - the source column of the link

targetColumn - the target column of the link

condition - the link condition

removeAllLinks

public void removeAllLinks(LinkSource from)

See Also:

LinkTarget.removeAllLinks(LinkSource)

getLinks

public Map<LinkSource,Collection<LinkDescriptor>> getLinks()

See Also:

LinkTarget.getLinks()

getLinks

public Collection<LinkDescriptor> getLinks(LinkSource source)

See Also:

LinkTarget.getLinks(LinkSource)

removeAllLinks

public void removeAllLinks()

See Also:

Linkable.removeAllLinks()

isLinked

public boolean isLinked()

See Also:

Linkable.isLinked()

getSourceLinkColumns

public Set<String> getSourceLinkColumns()

See Also:

LinkSource.getSourceLinkColumns()

maybeUpdateIcon

public void maybeUpdateIcon()

If this helper was constructed with an iconChangedHandler it invokes that with the appropriate icon, otherwise it will update the view icon based on the current link status.

getLinkIcon

public ImageIcon getLinkIcon()

Get the appropriate link icon for the currently established set of links.

Returns:

an ImageIcon representing the proper link state, or null if no links

tryLinkFrom

public void tryLinkFrom(Window win)

Initiates the process of creating a link from another Linkable.

Parameters:

win - the parent window for the link dialog

tryLinkTo

public void tryLinkTo(Window win)

Initiates the process of creating a link to another Linkable.

Parameters:

win - the parent window for the link dialog

editLinks

public void editLinks(Window win)

Opens the link editor dialog.

Parameters:

win - the parent window for the link dialog

fireEvent

public void fireEvent(LinkEvent event)

Sends a link event to all targets. This may be hooked up to a double click. If any links are detected as broken it will notify the user with an option to ignore, repair, or break the suspect links.

Parameters:

event - the link event to send

forEachTarget

public void forEachTarget(Consumer<LinkTarget> action)

Execute the specified action against each target of this linkable.

Parameters:

action - the action to execute

removeBrokenLinks

public void removeBrokenLinks(LinkTarget target)

Search for and remove all links to the specified target that are broken (a column does not exist on one or both sides)

Parameters:

target - the target to remove broken links from