org.codice.ddf.catalog.actions

Class AbstractMetacardActionProvider

java.lang.Object

org.codice.ddf.catalog.actions.AbstractMetacardActionProvider

All Implemented Interfaces:

ActionProvider

Direct Known Subclasses:

MetacardTransformerActionProvider, PreviewActionProvider, ResourceDownloadActionProvider, ViewMetacardActionProvider

public abstract class AbstractMetacardActionProvider
extends Object
implements ActionProvider

Abstract base class for ActionProviders that can handle Metacard source objects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMetacardActionProvider(String actionProviderId, String title, String description) Constructor that accepts the values to be used when a new Action is created by this ActionProvider.

Method Summary

Modifier and Type	Method and Description
<T> boolean	canHandle(T subject) Default implementation that ensures the subject provided is a Metacard before delegating to canHandleMetacard(Metacard).
protected boolean	canHandleMetacard(Metacard metacard) Determines if this ActionProvider can handle this Metacard.
protected abstract Action	createMetacardAction(String actionProviderId, String title, String description, URL url) Factory method that creates the proper Action object from the information provided.
<T> Action	getAction(T subject) Default implementation that ensures the subject provided is a Metacard with a valid ID before delegating to getMetacardAction(String, Metacard).
String	getId()
protected Action	getMetacardAction(String metacardSource, Metacard metacard) Creates a new Action given a Metacard.
protected abstract URL	getMetacardActionUrl(String metacardSource, Metacard metacard) Gets the URL that will be used when the Action is created.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMetacardActionProvider

protected AbstractMetacardActionProvider(String actionProviderId,
                                         String title,
                                         String description)

Constructor that accepts the values to be used when a new Action is created by this ActionProvider.

Parameters:

actionProviderId - ID that will be assigned to the Action that will be created. Cannot be empty or blank.

title - title that will be used when this ActionProvider creates a new Action

description - description that will be used when this ActionProvider creates a new Action

Method Detail

getAction

public <T> Action getAction(T subject)

Default implementation that ensures the subject provided is a Metacard with a valid ID before delegating to getMetacardAction(String, Metacard).

Specified by:

getAction in interface ActionProvider

Parameters:

subject - object for which the ActionProvider is requested to provide an Action

Returns:

an Action object. If no action can be taken on the input, then null shall be returned

getId

public String getId()

Specified by:

getId in interface ActionProvider

Returns:

a unique identifier to distinguish the type of service this ActionProvider provides

canHandle

public <T> boolean canHandle(T subject)

Default implementation that ensures the subject provided is a Metacard before delegating to canHandleMetacard(Metacard).

canHandleMetacard

protected boolean canHandleMetacard(Metacard metacard)

Determines if this ActionProvider can handle this Metacard. Returns true by default. Should be overwritten if more complex verification is needed.

Parameters:

metacard - metacard to which this ActionProvider could apply

Returns:

true if this ActionProvider applies to the Metacard

toString

public String toString()

Overrides:

toString in class Object

getMetacardAction

protected Action getMetacardAction(String metacardSource,
                                   Metacard metacard)
                            throws Exception

Creates a new Action given a Metacard. This method delegates to getMetacardActionUrl(String, Metacard) and createMetacardAction(String, String, String, URL).

Parameters:

metacardSource - source ID of the Metacard

metacard - Metacard to create an Action from

Returns:

new Action object. Cannot be null.

Throws:

Exception - thrown if an error occurred while creating the Action

createMetacardAction

protected abstract Action createMetacardAction(String actionProviderId,
                                               String title,
                                               String description,
                                               URL url)

Factory method that creates the proper Action object from the information provided. Must be implemented by sub-classes.

Parameters:

actionProviderId - Action ID

title - Action title

description - Action description

url - Action url

Returns:

new Action object. Cannot be null.

getMetacardActionUrl

protected abstract URL getMetacardActionUrl(String metacardSource,
                                            Metacard metacard)
                                     throws Exception

Gets the URL that will be used when the Action is created.

Parameters:

metacardSource - source ID of the Metacard

metacard - Metacard for which a URL needs to be created

Returns:

URL that will be used to create the Action

Throws:

Exception - thrown if the URL couldn't be created