org.codice.ddf.catalog.async.data.api.internal

Interface ProcessResource

All Known Implementing Classes:

LazyProcessResourceImpl, ProcessResourceImpl

public interface ProcessResource

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

A ProcessResource represents a local or remote resource that will be used during processing by the ProcessingFramework.

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNKNOWN_SIZE

Method Summary

Modifier and Type	Method and Description
void	close() This is used to close the input stream.
InputStream	getInputStream() Return the input stream containing the ProcessResource's actual data content.
String	getMimeType() Return the mime type raw data for the ProcessResource, e.g., image/nitf or application/json;id=geojson
String	getName() A human friendly readable name.
String	getQualifier() An optional field to provide additional information about a ProcessResource, that if present, indicates that this ProcessResource is derived from another Resource.
long	getSize() Return the total number of bytes in the ProcessResource's input stream.
URI	getUri() Gets a URI that represents the resource in the catalog.
boolean	isModified() Determines if the ProcessResource has been modified or created by any of the PostProcessPlugins during processing by the ProcessingFramework.

Field Detail

UNKNOWN_SIZE

static final int UNKNOWN_SIZE

See Also:

Constant Field Values

Method Detail

getUri

URI getUri()

Gets a URI that represents the resource in the catalog.

Returns:

the URI of the ProcessResource

getName

String getName()

A human friendly readable name.

Returns:

name of the ProcessResource

getQualifier

String getQualifier()

An optional field to provide additional information about a ProcessResource, that if present, indicates that this ProcessResource is derived from another Resource. The parent content of this ProcessResource is this ProcessResource's URI without the qualifier.

Returns:

the qualifier of the ProcessResource

getMimeType

String getMimeType()

Return the mime type raw data for the ProcessResource, e.g., image/nitf or application/json;id=geojson

Returns:

the mime type raw data for the ProcessResource

getInputStream

InputStream getInputStream()
                    throws IOException

Return the input stream containing the ProcessResource's actual data content.

Returns:

the ProcessResource's input stream

Throws:

IOException - if the input stream is not available

getSize

long getSize()

Return the total number of bytes in the ProcessResource's input stream.

Returns:

returns the total number of bytes that can be read from the input stream, or UNKNOWN_SIZE if the total number of bytes is unknown or not applicable (e.g., in the case of a live stream)

isModified

boolean isModified()

Determines if the ProcessResource has been modified or created by any of the PostProcessPlugins during processing by the ProcessingFramework. This is used to determine whether or not a UpdateStorageRequest for this ProcessResource needs to be made back to the CatalogFramework.

Returns:

true if modified, false otherwise

close

void close()

This is used to close the input stream.

Look into having the ProcessResource implement InputStream