org.codice.ddf.transformer.preview.actions

Class PreviewActionProvider

java.lang.Object

org.codice.ddf.catalog.actions.AbstractMetacardActionProvider

org.codice.ddf.transformer.preview.actions.PreviewActionProvider

All Implemented Interfaces:

ActionProvider

public class PreviewActionProvider
extends AbstractMetacardActionProvider

Constructor Summary

Constructors

Modifier	Constructor and Description
	PreviewActionProvider(String actionProviderId)
protected	PreviewActionProvider(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
protected boolean	canHandleMetacard(Metacard metacard) Determines if this ActionProvider can handle this Metacard.
protected Action	createMetacardAction(String actionProviderId, String title, String description, URL url) Factory method that creates the proper Action object from the information provided.
protected URL	getMetacardActionUrl(String metacardSource, Metacard metacard) Gets the URL that will be used when the Action is created.

Methods inherited from class org.codice.ddf.catalog.actions.AbstractMetacardActionProvider

canHandle, getAction, getId, getMetacardAction, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PreviewActionProvider

protected PreviewActionProvider(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

PreviewActionProvider

public PreviewActionProvider(String actionProviderId)

Method Detail

canHandleMetacard

protected boolean canHandleMetacard(Metacard metacard)

Description copied from class: AbstractMetacardActionProvider

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

Overrides:

canHandleMetacard in class AbstractMetacardActionProvider

Parameters:

metacard - metacard to which this ActionProvider could apply

Returns:

true if this ActionProvider applies to the Metacard

createMetacardAction

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

Description copied from class: AbstractMetacardActionProvider

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

Specified by:

createMetacardAction in class AbstractMetacardActionProvider

Parameters:

actionProviderId - Action ID

title - Action title

description - Action description

url - Action url

Returns:

new Action object. Cannot be null.

getMetacardActionUrl

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

Description copied from class: AbstractMetacardActionProvider

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

Specified by:

getMetacardActionUrl in class AbstractMetacardActionProvider

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