org.eclipse.scout.rt.client.deeplink

Class AbstractDeepLinkHandler

java.lang.Object

org.eclipse.scout.rt.client.deeplink.AbstractDeepLinkHandler

All Implemented Interfaces:

IDeepLinkHandler

Direct Known Subclasses:

OutlineDeepLinkHandler

public abstract class AbstractDeepLinkHandler
extends Object
implements IDeepLinkHandler

Base class for all classes that provide deep-link logic.

Field Summary

Fields

Modifier and Type	Field and Description
protected Pattern	m_pattern

Fields inherited from interface org.eclipse.scout.rt.client.deeplink.IDeepLinkHandler

NUMERIC_REGEX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDeepLinkHandler(Pattern pattern)

Method Summary

Modifier and Type	Method and Description
protected static Pattern	defaultPattern(String handlerName, String dataGroup) Creates a regexp pattern to validate/parse the value of the deep-link URL parameter.
boolean	handle(String path) Executes the deep-link action on the model.
protected abstract void	handleImpl(Matcher matcher) Implement logic to display the deep-link's corresponding entity.
boolean	matches(String path)
protected String	toDeepLinkPath(String handlerData) This method creates a deep-link path to be used in the URL parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scout.rt.client.deeplink.IDeepLinkHandler

getName

Field Detail

m_pattern

protected final Pattern m_pattern

Constructor Detail

AbstractDeepLinkHandler

protected AbstractDeepLinkHandler(Pattern pattern)

Method Detail

defaultPattern

protected static Pattern defaultPattern(String handlerName,
                                        String dataGroup)

Creates a regexp pattern to validate/parse the value of the deep-link URL parameter.

toDeepLinkPath

protected String toDeepLinkPath(String handlerData)

This method creates a deep-link path to be used in the URL parameter. The returned value has the format: [handler name]-[handler data]. Example outline-12345.

Parameters:

handlerData -

Returns:

matches

public boolean matches(String path)

Specified by:

matches in interface IDeepLinkHandler

Returns:

True if this handler can handle the given path, false otherwise

handle

public boolean handle(String path)
               throws DeepLinkException

Description copied from interface: IDeepLinkHandler

Executes the deep-link action on the model.

Specified by:

handle in interface IDeepLinkHandler

Returns:

True if this handler has handled the given path, false otherwise

Throws:

DeepLinkException - when something went wrong while executing the #handleImpl(Matcher, IClientSession) method. For instance the user has no permissions to view the requested resource or the resource is not available

handleImpl

protected abstract void handleImpl(Matcher matcher)
                            throws DeepLinkException

Implement logic to display the deep-link's corresponding entity. If the handler is not able to process the deep-link URL a DeepLinkException must be thrown to ensure correct handling in the UI.

Parameters:

matcher -

Throws:

DeepLinkException