ddf.catalog.content.data.impl

Class ContentItemImpl

java.lang.Object

ddf.catalog.content.data.impl.ContentItemImpl

All Implemented Interfaces:

ContentItem

Direct Known Subclasses:

RESTEndpoint.IncomingContentItem

public class ContentItemImpl
extends Object
implements ContentItem

Field Summary

Fields

Modifier and Type	Field and Description
protected String	qualifier
protected URI	uri

Fields inherited from interface ddf.catalog.content.data.ContentItem

CONTENT_SCHEME, DEFAULT_FILE_NAME, DEFAULT_MIME_TYPE, QUALIFIER

Constructor Summary

Constructors

Constructor and Description
ContentItemImpl(String id, com.google.common.io.ByteSource byteSource, String mimeTypeRawData, Metacard metacard) An incoming content item where the item's GUID should be known.
ContentItemImpl(String id, com.google.common.io.ByteSource byteSource, String mimeTypeRawData, String filename, long size, Metacard metacard) An incoming content item where the item's GUID and size should be known.
ContentItemImpl(String id, String qualifier, com.google.common.io.ByteSource byteSource, String mimeTypeRawData, Metacard metacard) An incoming content item where the item's GUID and size should be known.
ContentItemImpl(String id, String qualifier, com.google.common.io.ByteSource byteSource, String mimeTypeRawData, String filename, long size, Metacard metacard) An incoming content item where the item's GUID and size should be known.

Method Summary

Modifier and Type	Method and Description
String	getFilename() Return the filename of the ContentItem.
String	getId() Return the globally unique ID for the content item.
InputStream	getInputStream() Return the input stream containing the item's actual data content.
Metacard	getMetacard() Return the metacard associated with this product.
MimeType	getMimeType() Return the mime type for the content item, e.g., image/nitf or application/pdf.
String	getMimeTypeRawData() Return the mime type raw data for the content item, e.g., image/nitf or application/json;id=geojson.
String	getQualifier() Return the optional field to describe the ContentItem as an additional product for a Metacard.
long	getSize() Return the total number of bytes in the item's input stream.
String	getUri() Return the URI of the content item.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

uri

protected URI uri

qualifier

protected String qualifier

Constructor Detail

ContentItemImpl

public ContentItemImpl(String id,
                       com.google.common.io.ByteSource byteSource,
                       String mimeTypeRawData,
                       Metacard metacard)

An incoming content item where the item's GUID should be known.

Parameters:

id - the ContentItem's GUID - can be null

byteSource - the ContentItem's input stream containing its actual data

mimeTypeRawData - the ContentItem's mime type

metacard - the ContentItem's associated metacard

ContentItemImpl

public ContentItemImpl(String id,
                       String qualifier,
                       com.google.common.io.ByteSource byteSource,
                       String mimeTypeRawData,
                       Metacard metacard)

An incoming content item where the item's GUID and size should be known.

Parameters:

id - the ContentItem's GUID - can be null

qualifier - the ContentItem's qualifier - can be null; blank qualifiers are treated as null

byteSource - the ContentItem's input stream containing its actual data

mimeTypeRawData - the ContentItem's mime type

metacard - the ContentItem's associated metacard

ContentItemImpl

public ContentItemImpl(String id,
                       com.google.common.io.ByteSource byteSource,
                       String mimeTypeRawData,
                       String filename,
                       long size,
                       Metacard metacard)

An incoming content item where the item's GUID and size should be known.

Parameters:

id - the ContentItem's GUID - can be null

byteSource - the ContentItem's input stream containing its actual data

mimeTypeRawData - the ContentItem's mime type

filename - the ContentItem's file name - can be null

size - the ContentItem's file size

metacard - the ContentItem's associated metacard

ContentItemImpl

public ContentItemImpl(String id,
                       String qualifier,
                       com.google.common.io.ByteSource byteSource,
                       String mimeTypeRawData,
                       String filename,
                       long size,
                       Metacard metacard)

An incoming content item where the item's GUID and size should be known.

Parameters:

id - the ContentItem's GUID - can be null

qualifier - the ContentItem's qualifier - can be null; blank qualifiers are treated as null

byteSource - the ContentItem's input stream containing its actual data

mimeTypeRawData - the ContentItem's mime type

filename - the ContentItem's file name - can be null

size - the ContentItem's file size

metacard - the ContentItem's associated metacard

Method Detail

getId

public String getId()

Description copied from interface: ContentItem

Return the globally unique ID for the content item.

Specified by:

getId in interface ContentItem

Returns:

the content item's ID

getUri

public String getUri()

Description copied from interface: ContentItem

Return the URI of the content item.

This is used by the StorageProvider when the content item is stored in the content repository and will be of the form content:<GUID>#<qualifier>.

Or this is used by the endpoint when the client specifies the content item's location which means the content is stored remote/external to DDF.

Specified by:

getUri in interface ContentItem

Returns:

the URI of the content item

getQualifier

public String getQualifier()

Description copied from interface: ContentItem

Return the optional field to describe the ContentItem as an additional product for a Metacard. ContentItems added to a Metacard as an additional product must have a non-blank qualifier.

Specified by:

getQualifier in interface ContentItem

Returns:

the qualifier of the ContentItem. A null qualifier designates this as the main ContentItem of the associated Metacard.

getFilename

public String getFilename()

Description copied from interface: ContentItem

Return the filename of the ContentItem. If not set it will default to ContentItem.DEFAULT_FILE_NAME.

Specified by:

getFilename in interface ContentItem

Returns:

the filename of the ContentItem

getMimeType

public MimeType getMimeType()

Description copied from interface: ContentItem

Return the mime type for the content item, e.g., image/nitf or application/pdf.

Specified by:

getMimeType in interface ContentItem

Returns:

the mime type for the content item

getMimeTypeRawData

public String getMimeTypeRawData()

Description copied from interface: ContentItem

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

Specified by:

getMimeTypeRawData in interface ContentItem

Returns:

the mime type raw data for the content item

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: ContentItem

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

Specified by:

getInputStream in interface ContentItem

Returns:

the item's input stream

Throws:

IOException - if the input stream is not available

getSize

public long getSize()
             throws IOException

Description copied from interface: ContentItem

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

Specified by:

getSize in interface ContentItem

Returns:

returns the total number of bytes that can be read from the input stream

Throws:

IOException - if the total number of bytes is unknown or not applicable (e.g., in the case of a live stream)

getMetacard

public Metacard getMetacard()

Description copied from interface: ContentItem

Return the metacard associated with this product.

Specified by:

getMetacard in interface ContentItem

Returns:

Metacard

toString

public String toString()

Overrides:

toString in class Object