org.codice.ddf.endpoints.rest.action

Class MetacardTransformerActionProvider

java.lang.Object

org.codice.ddf.catalog.actions.AbstractMetacardActionProvider

org.codice.ddf.endpoints.rest.action.MetacardTransformerActionProvider

All Implemented Interfaces:

ActionProvider

public class MetacardTransformerActionProvider
extends AbstractMetacardActionProvider

Constructor Summary

Constructors

Constructor and Description
MetacardTransformerActionProvider(String actionProviderId, String metacardTransformerId) Constructor to instantiate this Metacard ActionProvider
MetacardTransformerActionProvider(String actionProviderId, String metacardTransformerId, String attributeName) Constructor to instantiate this Metacard 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

MetacardTransformerActionProvider

public MetacardTransformerActionProvider(String actionProviderId,
                                         String metacardTransformerId)

Constructor to instantiate this Metacard ActionProvider

Parameters:

actionProviderId -

metacardTransformerId -

MetacardTransformerActionProvider

public MetacardTransformerActionProvider(String actionProviderId,
                                         String metacardTransformerId,
                                         String attributeName)

Constructor to instantiate this Metacard ActionProvider

Parameters:

actionProviderId -

metacardTransformerId -

attributeName -

Method Detail

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

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.