Package ddf.catalog.data

Interface Metacard

All Superinterfaces:

Serializable

public interface Metacard
extends Serializable

A Metacard is a container for Metadata.

It is modeled after the OGC SimpleFeature and does two additional things:

1. Represents a resource.
2. Contains or can be represented as XML metadata.

This interface does not extend the OGC SimpleFeature interface due to added complexity that was deemed to conflict with the goal of simplicity for this API.
The Metacard can include key/value-style Attributes, and includes several standard properties: id, title, document, location, source name, dates(created, modified, effective, expiration), and thumbnail.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANY_DATE	Attribute name for querying all dates of all temporal properties of a Metacard.
static final String	ANY_GEO	Attribute name for querying all geometries of all geometric properties of a Metacard Used in Queries only
static final String	ANY_TEXT	Attribute name for querying all text of all textual properties of a Metacard.
static final String	CHECKSUM	Attribute checksum value for the RESOURCE_URI
static final String	CHECKSUM_ALGORITHM	Attribute algorithm used to calculate the checksum on the RESOURCE_URI for local resources
static final String	CONTENT_TYPE	Attribute name for querying the metadata content type of a Metacard.
static final String	CONTENT_TYPE_VERSION	Attribute name for querying the version of the metadata content type of a Metacard.
static final String	CREATED	Attribute name for accessing the date/time this Metacard was created.
static final String	DEFAULT_TAG	The default tag type for all metacards
static final String	DERIVED	Attribute name for derived Metacard ids.
static final String	DERIVED_RESOURCE_DOWNLOAD_URL	Attribute name for accessing the derived resource download URL for the derived products of this Metacard.
static final String	DERIVED_RESOURCE_URI	Attribute that provides URIs for derived formats of the Metacard.RESOURCE_URI
static final String	DESCRIPTION	Attribute description associated with the Metacard
static final String	EFFECTIVE	Attribute name for accessing the date/time the Metacard was last known to be up-to-date.
static final String	EXPIRATION	Attribute name for accessing the date/time the Metacard is no longer valid and could be removed.
static final String	GEOGRAPHY	Attribute name for accessing the location for this Metacard.
static final String	ID	Attribute name for accessing the ID of the Metacard.
static final String	METADATA	Attribute name for accessing the XML metadata for this Metacard.
static final String	MODIFIED	Attribute name for accessing the date/time this Metacard was last modified.
static final String	POINT_OF_CONTACT	Attribute name for accessing the point of contact to the product this Metacard represents.
static final String	RELATED	Attribute name for related Metacard ids.
static final String	RESOURCE_DOWNLOAD_URL	Attribute name for accessing the resource download URL for the product this Metacard represents.
static final String	RESOURCE_SIZE	Attribute name for accessing the size (in bytes) of the product this Metacard represents.
static final String	RESOURCE_URI	Attribute name for accessing the URI reference to the product this Metacard represents.
static final String	SECURITY	Attribute name for accessing the security relevant markings on the product that this Metacard represents.
static final String	SECURITY_MATCH_ALL	Deprecated. Not to be used anymore, replaced with SECURITY attribute.
static final String	SECURITY_MATCH_ONE	Deprecated. Not to be used anymore, replaced with SECURITY attribute.
static final String	SOURCE_ID	Deprecated.
static final String	TAGS	Attribute name for accessing the tags of the Metacard.
static final String	TARGET_NAMESPACE	Attribute name for querying the target namespace of the metadata content type of a Metacard.
static final String	THUMBNAIL	Attribute name for accessing the thumbnail image of the product this Metacard represents.
static final String	TITLE	Attribute name for accessing the title of the Metacard.

Method Summary

Modifier and Type	Method	Description
Attribute	getAttribute(String name)	Returns Attribute for given attribute name.
String	getContentTypeName()	Returns the name of the content type of the Metacard.
URI	getContentTypeNamespace()	Some types of metadata use different content types.
String	getContentTypeVersion()	Returns the version of the content type of the Metacard.
Date	getCreatedDate()	Returns the date/time this Metacard was created.
Date	getEffectiveDate()	Returns the date/time this Metacard was last known to be valid.
Date	getExpirationDate()	Returns the date/time this Metacard is no longer valid and could be removed.
String	getId()	Returns the ID of this Metacard.
String	getLocation()	Returns the WKT representation of the geometry.
MetacardType	getMetacardType()	Return the MetacardType of this Metacard.
String	getMetadata()	Returns the metadata associated with this Metacard.
Date	getModifiedDate()	Returns the date/time this Metacard was last modifed.
String	getResourceSize()	This is the size of the resource which may or may not contain a unit.
URI	getResourceURI()	Get the value of this Metacards Resource URI and in the form of a URI Object.
String	getSourceId()	Returns the source ID of the source the metacard is located.
default Set<String>	getTags()	Returns the tags associated with this metacard.
byte[]	getThumbnail()	Returns the thumbnail associated with this Metacard.
String	getTitle()	Returns the title of this Metacard.
void	setAttribute(Attribute attribute)	Sets Attribute with new attribute.
void	setSourceId(String sourceId)	Sets the source ID of the source the metacard is located.

Field Details

ANY_TEXT

static final String ANY_TEXT

Attribute name for querying all text of all textual properties of a Metacard. Used in Queries only

See Also:

• Constant Field Values

ANY_GEO

static final String ANY_GEO

Attribute name for querying all geometries of all geometric properties of a Metacard Used in Queries only

See Also:

• Constant Field Values

ANY_DATE

static final String ANY_DATE

Attribute name for querying all dates of all temporal properties of a Metacard. Used in Queries only

See Also:

• Constant Field Values

SOURCE_ID

static final String SOURCE_ID

Deprecated.

Attribute name for the ID of the source where the Metacard is cataloged.

See Also:

• Constant Field Values

CONTENT_TYPE

static final String CONTENT_TYPE

Attribute name for querying the metadata content type of a Metacard.

See Also:

• MetacardType
• Constant Field Values

CONTENT_TYPE_VERSION

static final String CONTENT_TYPE_VERSION

Attribute name for querying the version of the metadata content type of a Metacard.

See Also:

• Constant Field Values

TARGET_NAMESPACE

static final String TARGET_NAMESPACE

Attribute name for querying the target namespace of the metadata content type of a Metacard.

See Also:

• Constant Field Values

ID

static final String ID

Attribute name for accessing the ID of the Metacard.
Every Source is required to return this attribute.

See Also:

• Constant Field Values

TAGS

static final String TAGS

Attribute name for accessing the tags of the Metacard.

See Also:

• Constant Field Values

TITLE

static final String TITLE

Attribute name for accessing the title of the Metacard.

See Also:

• Constant Field Values

METADATA

static final String METADATA

Attribute name for accessing the XML metadata for this Metacard.

See Also:

• Constant Field Values

GEOGRAPHY

static final String GEOGRAPHY

Attribute name for accessing the location for this Metacard.

See Also:

• Constant Field Values

CREATED

static final String CREATED

Attribute name for accessing the date/time this Metacard was created.

See Also:

• Constant Field Values

MODIFIED

static final String MODIFIED

Attribute name for accessing the date/time this Metacard was last modified.

See Also:

• Constant Field Values

EXPIRATION

static final String EXPIRATION

Attribute name for accessing the date/time the Metacard is no longer valid and could be removed.

See Also:

• Constant Field Values

EFFECTIVE

static final String EFFECTIVE

Attribute name for accessing the date/time the Metacard was last known to be up-to-date.

See Also:

• Constant Field Values

POINT_OF_CONTACT

static final String POINT_OF_CONTACT

Attribute name for accessing the point of contact to the product this Metacard represents.

See Also:

• Constant Field Values

RESOURCE_URI

static final String RESOURCE_URI

Attribute name for accessing the URI reference to the product this Metacard represents.

See Also:

• Constant Field Values

RESOURCE_DOWNLOAD_URL

static final String RESOURCE_DOWNLOAD_URL

Attribute name for accessing the resource download URL for the product this Metacard represents.

See Also:

• Constant Field Values

RESOURCE_SIZE

static final String RESOURCE_SIZE

Attribute name for accessing the size (in bytes) of the product this Metacard represents.

See Also:

• Constant Field Values

THUMBNAIL

static final String THUMBNAIL

Attribute name for accessing the thumbnail image of the product this Metacard represents. The thumbnail must be of MIME Type image/jpeg and 128 kilobytes or less.

See Also:

• Constant Field Values

SECURITY_MATCH_ALL

static final String SECURITY_MATCH_ALL

Deprecated.

Not to be used anymore, replaced with SECURITY attribute.

Attribute name for accessing the security relevant markings on the product that this Metacard represents.

See Also:

• Constant Field Values

SECURITY_MATCH_ONE

static final String SECURITY_MATCH_ONE

Deprecated.

Not to be used anymore, replaced with SECURITY attribute.

Attribute name for accessing the security relevant markings on the product that this Metacard represents.

See Also:

• Constant Field Values

SECURITY

static final String SECURITY

Attribute name for accessing the security relevant markings on the product that this Metacard represents.

Since:

DDF-2.2.0.RC1

See Also:

• Constant Field Values

DESCRIPTION

static final String DESCRIPTION

Attribute description associated with the Metacard

Since:

DDF-2.8.0

See Also:

• Constant Field Values

DEFAULT_TAG

static final String DEFAULT_TAG

The default tag type for all metacards

See Also:

• Constant Field Values

CHECKSUM_ALGORITHM

static final String CHECKSUM_ALGORITHM

Attribute algorithm used to calculate the checksum on the RESOURCE_URI for local resources

Since:

DDF-2.9.0

See Also:

• Constant Field Values

RELATED

static final String RELATED

Attribute name for related Metacard ids.

Since:

DDF-2.9.0

See Also:

• Constant Field Values

DERIVED

static final String DERIVED

Attribute name for derived Metacard ids.

Since:

DDF-2.9.0

See Also:

• Constant Field Values

CHECKSUM

static final String CHECKSUM

Attribute checksum value for the RESOURCE_URI

Since:

DDF-2.9.0

See Also:

• Constant Field Values

DERIVED_RESOURCE_URI

static final String DERIVED_RESOURCE_URI

Attribute that provides URIs for derived formats of the Metacard.RESOURCE_URI

See Also:

• Constant Field Values

DERIVED_RESOURCE_DOWNLOAD_URL

static final String DERIVED_RESOURCE_DOWNLOAD_URL

Attribute name for accessing the derived resource download URL for the derived products of this Metacard.

See Also:

• Constant Field Values

Method Details

getAttribute

Attribute getAttribute(String name)

Returns Attribute for given attribute name.

Parameters:

name - name of attribute

Returns:

Attribute for given name, or null if not available

setAttribute

void setAttribute(Attribute attribute)

Sets Attribute with new attribute.

Parameters:

attribute - new Attribute to set. If the getValue() call on the passed in attribute returns null, the attribute will be removed from this Metacard.

getMetacardType

MetacardType getMetacardType()

Return the MetacardType of this Metacard.

Returns:

MetacardType - the type of this Metacard, MetacardType is required and must not be null

getId

String getId()

Returns the ID of this Metacard.
Convenience method for getAttribute(ID)

Returns:

unique identifier of the Metacard

See Also:

• ID

getTags

default Set<String> getTags()

Returns the tags associated with this metacard.

Returns:

Returns the TAGS attribute values if it exists otherwise return null

getMetadata

String getMetadata()

Returns the metadata associated with this Metacard.
Convenience method for getAttribute(METADATA)

Returns:

XML metadata

See Also:

• METADATA

getCreatedDate

Date getCreatedDate()

Returns the date/time this Metacard was created.
Convenience method for getAttribute(CREATED)

Returns:

Date - when this Metacard was created.

See Also:

• CREATED

getModifiedDate

Date getModifiedDate()

Returns the date/time this Metacard was last modifed.
Convenience method for getAttribute(MODIFIED)

Returns:

Date - when this Metacard was last modified.

See Also:

• MODIFIED

getExpirationDate

Date getExpirationDate()

Returns the date/time this Metacard is no longer valid and could be removed.
Convenience method for getAttribute(EXPIRATION)

Returns:

Date - when this Metacard expires and should be removed from any stores.

See Also:

• EXPIRATION

getEffectiveDate

Date getEffectiveDate()

Returns the date/time this Metacard was last known to be valid.
Convenience method for getAttribute(EFFECTIVE)

Returns:

Date - when the information represented by this Metacard was last known to be valid.

See Also:

• EFFECTIVE

getLocation

String getLocation()

Returns the WKT representation of the geometry.
Convenience method for getAttribute(GEOGRAPHY)

Returns:

String - WKT-defined geospatial object, returns null if not applicable

See Also:

• GEOGRAPHY

getSourceId

String getSourceId()

Returns the source ID of the source the metacard is located.

setSourceId

void setSourceId(String sourceId)

Sets the source ID of the source the metacard is located.

Parameters:

sourceId - unique name of source location of metacard

getTitle

String getTitle()

Returns the title of this Metacard.
Convenience method for getAttribute(TITLE)

Returns:

Title of the Metacard

See Also:

• TITLE

getResourceURI

URI getResourceURI()

Get the value of this Metacards Resource URI and in the form of a URI Object.
Convenience method for new URI(getAttribute(RESOURCE_URI));

Returns:

URI - a URI representation of the Metacard's Resource URI which itself is stored as a String ddf.catalog.data.AttributeType.AttributeFormat

getResourceSize

String getResourceSize()

This is the size of the resource which may or may not contain a unit.

Returns:

String - String representation of the size

getThumbnail

byte[] getThumbnail()

Returns the thumbnail associated with this Metacard.
Convenience method for getAttribute(THUMBNAIL)

Returns:

thumbnail for the Metacard

See Also:

• THUMBNAIL

getContentTypeName

String getContentTypeName()

Returns the name of the content type of the Metacard.
Convenience method for getAttribute(CONTENT_TYPE)

Returns:

name of content type of the Metacard

See Also:

• CONTENT_TYPE

getContentTypeVersion

String getContentTypeVersion()

Returns the version of the content type of the Metacard.
Convenience method for getAttribute(CONTENT_TYPE_VERSION)

Returns:

version of content type of the Metacard

See Also:

• CONTENT_TYPE_VERSION

getContentTypeNamespace

URI getContentTypeNamespace()

Some types of metadata use different content types. If utilized, returns the URI of the content type.
Convenience method for getAttribute(TARGET_NAMESPACE)

Returns:

URI - the sub-type, null if unused

See Also:

• TARGET_NAMESPACE