org.codice.ddf.catalog.content.resource.reader

Class ContentResourceReader

java.lang.Object

org.codice.ddf.catalog.content.resource.reader.ContentResourceReader

All Implemented Interfaces:

ResourceReader, Describable

public class ContentResourceReader
extends Object
implements ResourceReader

Constructor Summary

Constructors

Constructor and Description
ContentResourceReader(List<StorageProvider> storageProviders)

Method Summary

Modifier and Type	Method and Description
void	bind(StorageProvider storageProvider)
String	getDescription() Returns a description of the describable item.
String	getId() Returns the name, aka ID, of the describable item.
Set<String>	getOptions(Metacard metacard) Obtain a set of all options supported by this ResourceReader.
String	getOrganization() Returns the organization associated with the describable item.
Set<String>	getSupportedSchemes() Returns a set of URI schemes that the ResourceReader can accept when doing a Resource lookup.
String	getTitle() Returns the title of the describable item.
String	getVersion() Retrieve the version.
ResourceResponse	retrieveResource(URI resourceUri, Map<String,Serializable> arguments) Retrieves a Resource based on a URI and provided arguments.
void	unbind(StorageProvider storageProvider)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentResourceReader

public ContentResourceReader(List<StorageProvider> storageProviders)

Method Detail

bind

public void bind(StorageProvider storageProvider)

unbind

public void unbind(StorageProvider storageProvider)

getDescription

public String getDescription()

Description copied from interface: Describable

Returns a description of the describable item.

Specified by:

getDescription in interface Describable

Returns:

description of the item (example: Provider that returns back static results)

getId

public String getId()

Description copied from interface: Describable

Returns the name, aka ID, of the describable item. The name should be unique for each instance.
Example: html for a MetacardTransformer that transforms Metacards to HTML

Specified by:

getId in interface Describable

Returns:

ID of the item

getOrganization

public String getOrganization()

Description copied from interface: Describable

Returns the organization associated with the describable item.

Specified by:

getOrganization in interface Describable

Returns:

organizational name or acronym (example: USAF)

getTitle

public String getTitle()

Description copied from interface: Describable

Returns the title of the describable item. It is generally more verbose than the name (aka ID).

Specified by:

getTitle in interface Describable

Returns:

title of the item (example: Dummy Catalog Provider)

getVersion

public String getVersion()

Description copied from interface: Describable

Retrieve the version.

Specified by:

getVersion in interface Describable

Returns:

the version of the item being described (example: 1.0)

getOptions

public Set<String> getOptions(Metacard metacard)

Description copied from interface: ResourceReader

Obtain a set of all options supported by this ResourceReader. Options are used to obtain the Resource in a unique way.

Specified by:

getOptions in interface ResourceReader

Returns:

Set of all options that this ResourceReader supports. This will be an empty set if no options are supported.

getSupportedSchemes

public Set<String> getSupportedSchemes()

Description copied from interface: ResourceReader

Returns a set of URI schemes that the ResourceReader can accept when doing a Resource lookup. Custom schemes can be created for a ResourceReader to support.

Specified by:

getSupportedSchemes in interface ResourceReader

Returns:

Set of supported schemes

retrieveResource

public ResourceResponse retrieveResource(URI resourceUri,
                                         Map<String,Serializable> arguments)
                                  throws IOException,
                                         ResourceNotFoundException,
                                         ResourceNotSupportedException

Description copied from interface: ResourceReader

Retrieves a Resource based on a URI and provided arguments.

Specified by:

retrieveResource in interface ResourceReader

Parameters:

resourceUri - A URI that defines what Resource to retrieve and how to do it.

arguments - Any additional arguments that should be passed to the ResourceReader.

Returns:

A ResourceResponse containing the retrieved Resource.

Throws:

IOException

ResourceNotFoundException

ResourceNotSupportedException