public interface Metacard extends Serializable
Metacard
is a container for Metadata.
It is modeled after the OGC SimpleFeature and does two additional things:
Metacard
can include key/value-style Attribute
s, and includes several
standard properties: id, title, document, location, source name, dates(created, modified,
effective, expiration), and thumbnail.Modifier and Type | Field and Description |
---|---|
static String |
ANY_DATE
Attribute name for querying all dates of all temporal properties of a
Metacard . |
static String |
ANY_GEO
Attribute name for querying all geometries of all geometric properties of a
Metacard
Used in Queries only |
static String |
ANY_TEXT
Attribute name for querying all text of all textual properties of a
Metacard . |
static String |
CHECKSUM
Attribute checksum value for the RESOURCE_URI |
static String |
CHECKSUM_ALGORITHM
Attribute algorithm used to calculate the checksum on the RESOURCE_URI
for local resources |
static String |
CONTENT_TYPE
Attribute name for querying the metadata content type of a
Metacard . |
static String |
CONTENT_TYPE_VERSION
Attribute name for querying the version of the metadata content type of a
Metacard . |
static String |
CREATED
|
static String |
DEFAULT_TAG
The default tag type for all metacards
|
static String |
DERIVED
|
static String |
DERIVED_RESOURCE_DOWNLOAD_URL
|
static String |
DERIVED_RESOURCE_URI
Attribute that provides URIs for derived formats of the Metacard.RESOURCE_URI |
static String |
DESCRIPTION
|
static String |
EFFECTIVE
|
static String |
EXPIRATION
|
static String |
GEOGRAPHY
|
static String |
ID
|
static String |
METADATA
|
static String |
MODIFIED
|
static String |
POINT_OF_CONTACT
|
static String |
RELATED
|
static String |
RESOURCE_DOWNLOAD_URL
|
static String |
RESOURCE_SIZE
|
static String |
RESOURCE_URI
|
static String |
SECURITY
|
static String |
SECURITY_MATCH_ALL
Deprecated.
Not to be used anymore, replaced with SECURITY attribute.
|
static String |
SECURITY_MATCH_ONE
Deprecated.
Not to be used anymore, replaced with SECURITY attribute.
|
static String |
SOURCE_ID
Deprecated.
|
static String |
TAGS
|
static String |
TARGET_NAMESPACE
Attribute name for querying the target namespace of the metadata content type of a
Metacard . |
static String |
THUMBNAIL
|
static String |
TITLE
|
Modifier and Type | Method and 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()
|
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.
|
static final String ANY_TEXT
Metacard
. Used
in Queries onlystatic final String ANY_GEO
Metacard
Used in Queries onlystatic final String ANY_DATE
Metacard
.
Used in Queries onlystatic final String SOURCE_ID
Metacard
is cataloged.static final String CONTENT_TYPE
Metacard
.MetacardType
,
Constant Field Valuesstatic final String CONTENT_TYPE_VERSION
Metacard
.static final String TARGET_NAMESPACE
Metacard
.static final String ID
Attribute
name for accessing the ID of the Metacard
. Source
is required to return this attribute.static final String TAGS
static final String TITLE
static final String METADATA
static final String GEOGRAPHY
static final String CREATED
static final String MODIFIED
static final String EXPIRATION
static final String EFFECTIVE
static final String POINT_OF_CONTACT
static final String RESOURCE_URI
static final String RESOURCE_DOWNLOAD_URL
static final String RESOURCE_SIZE
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. static final String SECURITY_MATCH_ALL
Attribute
name for accessing the security relevant markings on the product that this
Metacard
represents.static final String SECURITY_MATCH_ONE
Attribute
name for accessing the security relevant markings on the product that 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 DESCRIPTION
static final String DEFAULT_TAG
static final String CHECKSUM_ALGORITHM
Attribute
algorithm used to calculate the checksum on the RESOURCE_URI
for local resourcesstatic final String RELATED
static final String DERIVED
static final String CHECKSUM
Attribute
checksum value for the RESOURCE_URI
static final String DERIVED_RESOURCE_URI
Attribute
that provides URIs for derived formats of the Metacard.RESOURCE_URIstatic final String DERIVED_RESOURCE_DOWNLOAD_URL
Attribute
name for accessing the derived resource download URL for the derived products
of this Metacard
. Attribute getAttribute(String name)
Attribute
for given attribute name.name
- name of attributeAttribute
for given name, or null
if not availableMetacardType getMetacardType()
MetacardType
of this Metacard
.MetacardType
- the type of this Metacard
, MetacardType is required and
must not be null
default Set<String> getTags()
Date getCreatedDate()
Date getModifiedDate()
Date getExpirationDate()
Metacard
is no longer valid and could be removed.
getAttribute
(EXPIRATION
)
Date
- when this Metacard
expires and should be removed from any
stores.EXPIRATION
Date getEffectiveDate()
Metacard
was last known to be valid.
getAttribute
(EFFECTIVE
)
String getLocation()
getAttribute
(GEOGRAPHY
)
String getSourceId()
void setSourceId(String sourceId)
sourceId
- unique name of source location of metacardURI getResourceURI()
Metacard
s Resource URI and in the form of a URI
Object.
new URI(getAttribute
(RESOURCE_URI
));
URI
- a URI
representation of the Metacard
's Resource URI
which itself is stored as a String
ddf.catalog.data.AttributeType.AttributeFormat
String getResourceSize()
String getContentTypeName()
Metacard
.
getAttribute
(CONTENT_TYPE
)
Metacard
CONTENT_TYPE
String getContentTypeVersion()
Metacard
.
getAttribute
(CONTENT_TYPE_VERSION
)
Metacard
CONTENT_TYPE_VERSION
URI getContentTypeNamespace()
URI
of the
content type.
getAttribute
(TARGET_NAMESPACE
)
URI
- the sub-type, null if unusedTARGET_NAMESPACE
This work is licensed under a Creative Commons Attribution 4.0 International License.