org.codice.ddf.catalog.async.data.impl

Class ProcessResourceImpl

java.lang.Object

org.codice.ddf.catalog.async.data.impl.ProcessResourceImpl

All Implemented Interfaces:

ProcessResource

public class ProcessResourceImpl
extends Object
implements ProcessResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_SCHEME
static String	DEFAULT_MIME_TYPE
static String	DEFAULT_NAME

Fields inherited from interface org.codice.ddf.catalog.async.data.api.internal.ProcessResource

UNKNOWN_SIZE

Constructor Summary

Constructors

Constructor and Description
ProcessResourceImpl(String metacardId, InputStream inputStream, String mimeType, String name) Creates a ProcessResource with ProcessResource.isModified() set to true and ProcessResource.getQualifier() set to empty string.
ProcessResourceImpl(String metacardId, InputStream inputStream, String mimeType, String name, long size) Creates a ProcessResource with ProcessResource.getQualifier() set to empty string.
ProcessResourceImpl(String metacardId, InputStream inputStream, String mimeType, String name, long size, String qualifier) Creates a new ProcessResource.

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.
void	markAsModified()

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_SCHEME

public static final String CONTENT_SCHEME

See Also:

Constant Field Values

DEFAULT_NAME

public static final String DEFAULT_NAME

See Also:

Constant Field Values

DEFAULT_MIME_TYPE

public static final String DEFAULT_MIME_TYPE

See Also:

Constant Field Values

Constructor Detail

ProcessResourceImpl

public ProcessResourceImpl(String metacardId,
                           InputStream inputStream,
                           @Nullable
                           String mimeType,
                           @Nullable
                           String name)

Creates a ProcessResource with ProcessResource.isModified() set to true and ProcessResource.getQualifier() set to empty string.

Parameters:

metacardId - schema specific part of URI, throws IllegalArgumentException if empty or null

inputStream - InputStream of the ProcessResource, can be null

mimeType - mime type of the ProcessResource, defaults to DEFAULT_MIME_TYPE

name - name of the ProcessResource, defaults to DEFAULT_NAME

ProcessResourceImpl

public ProcessResourceImpl(String metacardId,
                           InputStream inputStream,
                           @Nullable
                           String mimeType,
                           @Nullable
                           String name,
                           long size)

Creates a ProcessResource with ProcessResource.getQualifier() set to empty string.

Parameters:

metacardId - schema specific part of URI, throws IllegalArgumentException if empty or null

inputStream - InputStream of the ProcessResource, can be null

mimeType - mime type of the ProcessResource, defaults to DEFAULT_MIME_TYPE

name - name of the ProcessResource, defaults to DEFAULT_NAME

size - size of the ProcessResource's , throws IllegalArgumentException if less than -1

ProcessResourceImpl

public ProcessResourceImpl(String metacardId,
                           InputStream inputStream,
                           String mimeType,
                           @Nullable
                           String name,
                           long size,
                           @Nullable
                           String qualifier)

Creates a new ProcessResource.

Parameters:

metacardId - schema specific part of URI, throws IllegalArgumentException if empty or null

inputStream - InputStream of the ProcessResource, can be null

mimeType - mime type of the ProcessResource, defaults to DEFAULT_MIME_TYPE

name - name of the ProcessResource, defaults to DEFAULT_NAME

size - size of the ProcessResource's , throws IllegalArgumentException if less than -1

qualifier - fragment of the ProcessResource's URI, defaults to empty string

Method Detail

getUri

public URI getUri()

Description copied from interface: ProcessResource

Gets a URI that represents the resource in the catalog.

Specified by:

getUri in interface ProcessResource

Returns:

the URI of the ProcessResource

getQualifier

public String getQualifier()

Description copied from interface: ProcessResource

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.

Specified by:

getQualifier in interface ProcessResource

Returns:

the qualifier of the ProcessResource

getName

public String getName()

Description copied from interface: ProcessResource

A human friendly readable name.

Specified by:

getName in interface ProcessResource

Returns:

name of the ProcessResource

getMimeType

public String getMimeType()

Description copied from interface: ProcessResource

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

Specified by:

getMimeType in interface ProcessResource

Returns:

the mime type raw data for the ProcessResource

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: ProcessResource

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

Specified by:

getInputStream in interface ProcessResource

Returns:

the ProcessResource's input stream

Throws:

IOException - if the input stream is not available

getSize

public long getSize()

Description copied from interface: ProcessResource

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

Specified by:

getSize in interface ProcessResource

Returns:

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

isModified

public boolean isModified()

Description copied from interface: ProcessResource

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.

Specified by:

isModified in interface ProcessResource

Returns:

true if modified, false otherwise

close

public void close()

Description copied from interface: ProcessResource

This is used to close the input stream.

Look into having the ProcessResource implement InputStream

Specified by:

close in interface ProcessResource

markAsModified

public void markAsModified()