net.di2e.ecdr.commons

Class CDRMetacard

Show UML class diagram

java.lang.Object

net.di2e.ecdr.commons.CDRMetacard

All Implemented Interfaces:

ddf.catalog.data.Metacard, Serializable

public class CDRMetacard
extends Object
implements ddf.catalog.data.Metacard, Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	LINK_REL_PREVIEW
static String	METACARD_CONTENT_COLLECTION_ATTRIBUTE
static String	RESOURCE_MIME_TYPE
static String	RESOURCE_TITLE
static String	THUMBNAIL_LENGTH
static String	THUMBNAIL_LINK_TITLE
static String	THUMBNAIL_MIMETYPE
static String	WRAP_METADATA

Fields inherited from interface ddf.catalog.data.Metacard

ANY_DATE, ANY_GEO, ANY_TEXT, CONTENT_TYPE, CONTENT_TYPE_VERSION, CREATED, EFFECTIVE, EXPIRATION, GEOGRAPHY, ID, METADATA, MODIFIED, RESOURCE_SIZE, RESOURCE_URI, SECURITY, SECURITY_MATCH_ALL, SECURITY_MATCH_ONE, SOURCE_ID, TARGET_NAMESPACE, THUMBNAIL, TITLE

Constructor Summary

Constructors

Constructor and Description
CDRMetacard() Creates a Metacard with a and empty Attributes.
CDRMetacard(ddf.catalog.data.Metacard metacard) Creates a Metacard with the provided Metacard.
CDRMetacard(ddf.catalog.data.MetacardType mt) Creates a Metacard with the provided MetacardType and empty Attribute s.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAtomId()
ddf.catalog.data.Attribute	getAttribute(String name)
protected <T> T	getAttributeValue(ddf.catalog.data.Attribute attribute, Class<T> returnType)
String	getContentTypeName()
URI	getContentTypeNamespace()
String	getContentTypeVersion()
Date	getCreatedDate()
Date	getEffectiveDate()
Date	getExpirationDate()
String	getId()
String	getLocation()
Map<String,ddf.catalog.data.Attribute>	getMap()
ddf.catalog.data.MetacardType	getMetacardType()
String	getMetadata()
URI	getMetadataURL()
Date	getModifiedDate()
String	getResourceMIMETypeString()
String	getResourceSize()
long	getResourceSizeLong()
URI	getResourceURI()
Map<String,List<String>>	getSecurity() Returns the security relevant markings on the Metacard.
String	getSourceId()
byte[]	getThumbnail()
long	getThumbnailLength()
String	getThumbnailLinkTitle()
MimeType	getThumbnailMIMEType()
URI	getThumbnailURL()
String	getTitle()
int	hashCode()
boolean	hasLocation()
boolean	hasResource()
boolean	hasThumbnail()
protected byte[]	requestBytes(String key) Get byte[] data from the map or wrapped metacard.
protected <T> T	requestData(String attributeName, Class<T> returnType) The brains of the operation -- does the interaction with the map or the wrapped metacard.
protected Date	requestDate(String key) Get Date data from the map or wrapped metacard.
protected Double	requestDouble(String key) Get Double data from the map or wrapped metacard.
protected InputStream	requestInputStream(String key) Get BinaryContent data from the map or wrapped metacard.
protected Integer	requestInteger(String key) Get Integer data from the map or wrapped metacard.
protected Long	requestLong(String key) Get Long data from the map or wrapped metacard.
protected String	requestString(String key) Get String data from the map or wrapped metacard.
void	setAttribute(ddf.catalog.data.Attribute attribute)
void	setAttribute(String name, Serializable value) Set an attribute via a name/value pair.
void	setContentTypeName(String contentType) Sets the name of the content type of the Metacard.
void	setContentTypeVersion(String contentTypeVersion) Sets the version of the content type of the Metacard.
void	setCreatedDate(Date created) Sets the date/time the Metacard was created.
void	setEffectiveDate(Date effective) Sets the date/time the Metacard was last known to be valid.
void	setExpirationDate(Date expiration) Sets the date/time this Metacard is no longer valid and could be removed.
void	setId(String id) Sets the ID of the Metacard.
void	setLocation(String wkt) Sets the WKT representation of the geometry.
void	setMetadata(String metadata) Sets the metadata associated with this Metacard.
void	setMetadataLinkURI(URI uri)
void	setModifiedDate(Date modified) Sets the date/time the Metacard was last modifed.
void	setResourceSize(String dadSize) Sets the size of the resource which may or may not contain a unit.
void	setResourceURI(URI uri)
void	setSecurity(HashMap<String,List<String>> security) Sets the security markings on this Metacard.
void	setSourceId(String id)
void	setTargetNamespace(URI targetNamespace) Some types of metadata use different content types.
void	setThumbnail(byte[] bytes) Sets the thumbnail associated with this Metacard.
void	setThumbnailLinkURI(URI uri)
void	setTitle(String title) Sets the title of this Metacard.
void	setType(ddf.catalog.data.MetacardType mt) Sets the MetacardType of the Metacard.

Methods inherited from class java.lang.Object

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

Field Detail

METACARD_CONTENT_COLLECTION_ATTRIBUTE

public static final String METACARD_CONTENT_COLLECTION_ATTRIBUTE

See Also:

Constant Field Values

LINK_REL_PREVIEW

public static final String LINK_REL_PREVIEW

See Also:

Constant Field Values

RESOURCE_MIME_TYPE

public static final String RESOURCE_MIME_TYPE

See Also:

Constant Field Values

RESOURCE_TITLE

public static final String RESOURCE_TITLE

See Also:

Constant Field Values

THUMBNAIL_LENGTH

public static final String THUMBNAIL_LENGTH

See Also:

Constant Field Values

THUMBNAIL_MIMETYPE

public static final String THUMBNAIL_MIMETYPE

See Also:

Constant Field Values

THUMBNAIL_LINK_TITLE

public static final String THUMBNAIL_LINK_TITLE

See Also:

Constant Field Values

WRAP_METADATA

public static final String WRAP_METADATA

See Also:

Constant Field Values

Constructor Detail

CDRMetacard

public CDRMetacard()

Creates a Metacard with a and empty Attributes.

CDRMetacard

public CDRMetacard(ddf.catalog.data.MetacardType mt)

Creates a Metacard with the provided MetacardType and empty Attribute s.

Parameters:

type - the MetacardType

CDRMetacard

public CDRMetacard(ddf.catalog.data.Metacard metacard)

Creates a Metacard with the provided Metacard.

Parameters:

metacard - the Metacard to create this new Metacard from

Method Detail

getMap

public Map<String,ddf.catalog.data.Attribute> getMap()

hasLocation

public boolean hasLocation()

hasResource

public boolean hasResource()

getResourceMIMETypeString

public String getResourceMIMETypeString()

getResourceSizeLong

public long getResourceSizeLong()

hasThumbnail

public boolean hasThumbnail()

getThumbnailLength

public long getThumbnailLength()

getAtomId

public String getAtomId()

getMetadataURL

public URI getMetadataURL()

getThumbnailURL

public URI getThumbnailURL()

getThumbnailMIMEType

public MimeType getThumbnailMIMEType()

getThumbnailLinkTitle

public String getThumbnailLinkTitle()

getMetadata

public String getMetadata()

Specified by:

getMetadata in interface ddf.catalog.data.Metacard

getModifiedDate

public Date getModifiedDate()

Specified by:

getModifiedDate in interface ddf.catalog.data.Metacard

getResourceSize

public String getResourceSize()

Specified by:

getResourceSize in interface ddf.catalog.data.Metacard

getThumbnail

public byte[] getThumbnail()

Specified by:

getThumbnail in interface ddf.catalog.data.Metacard

getTitle

public String getTitle()

Specified by:

getTitle in interface ddf.catalog.data.Metacard

getCreatedDate

public Date getCreatedDate()

Specified by:

getCreatedDate in interface ddf.catalog.data.Metacard

setCreatedDate

public void setCreatedDate(Date created)

Sets the date/time the Metacard was created.
Convenience method for setAttribute(new AttributeImpl(Metacard.CREATED, created))

Parameters:

created - Date when this Metacard was created.

See Also:

Metacard.CREATED

setModifiedDate

public void setModifiedDate(Date modified)

Sets the date/time the Metacard was last modifed.
Convenience method for setAttribute(new AttributeImpl(Metacard.MODIFIED, modified))

Parameters:

modified - Date when this Metacard was last modified.

See Also:

Metacard.MODIFIED

getExpirationDate

public Date getExpirationDate()

Specified by:

getExpirationDate in interface ddf.catalog.data.Metacard

setExpirationDate

public void setExpirationDate(Date expiration)

Sets the date/time this Metacard is no longer valid and could be removed.
Convenience method for setAttribute(new AttributeImpl(Metacard.EXPIRATION, expiration))

Parameters:

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

See Also:

Metacard.EXPIRATION

getEffectiveDate

public Date getEffectiveDate()

Specified by:

getEffectiveDate in interface ddf.catalog.data.Metacard

setEffectiveDate

public void setEffectiveDate(Date effective)

Sets the date/time the Metacard was last known to be valid.
Convenience method for setAttribute(new AttributeImpl(Metacard.EFFECTIVE, effective))

Parameters:

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

See Also:

Metacard.EFFECTIVE

getId

public String getId()

Specified by:

getId in interface ddf.catalog.data.Metacard

setId

public void setId(String id)

Sets the ID of the Metacard.
Convenience method for setAttribute(new AttributeImpl(Metacard.ID, id))

Parameters:

id - unique identifier of the Metacard.

See Also:

Metacard.ID

getLocation

public String getLocation()

Specified by:

getLocation in interface ddf.catalog.data.Metacard

setLocation

public void setLocation(String wkt)

Sets the WKT representation of the geometry.
Convenience method for setAttribute(new AttributeImpl(Metacard.GEOGRAPHY, wkt))

Parameters:

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

See Also:

Metacard.GEOGRAPHY

getSourceId

public String getSourceId()

Specified by:

getSourceId in interface ddf.catalog.data.Metacard

setSourceId

public void setSourceId(String id)

Specified by:

setSourceId in interface ddf.catalog.data.Metacard

setThumbnail

public void setThumbnail(byte[] bytes)

Sets the thumbnail associated with this Metacard.
Convenience method for setAttribute(new AttributeImpl(Metacard.THUMBNAIL, bytes))

Parameters:

bytes - thumbnail for the Metacard.

See Also:

Metacard.THUMBNAIL

setTitle

public void setTitle(String title)

Sets the title of this Metacard.
Convenience method for setAttribute(new AttributeImpl(Metacard.TITLE, id))

Parameters:

title - Title of the Metacard

See Also:

Metacard.TITLE

setMetadata

public void setMetadata(String metadata)

Sets the metadata associated with this Metacard.
Convenience method for setAttribute(new AttributeImpl(Metacard.METADATA, metadata))

Parameters:

metadata - Associated metadata of the Metacard

See Also:

Metacard.METADATA

getMetacardType

public ddf.catalog.data.MetacardType getMetacardType()

Specified by:

getMetacardType in interface ddf.catalog.data.Metacard

setType

public void setType(ddf.catalog.data.MetacardType mt)

Sets the MetacardType of the Metacard.

Parameters:

type - MetacardType of the Metacard

See Also:

MetacardType

getContentTypeNamespace

public URI getContentTypeNamespace()

Specified by:

getContentTypeNamespace in interface ddf.catalog.data.Metacard

setTargetNamespace

public void setTargetNamespace(URI targetNamespace)

Some types of metadata use different content types. If utilized, sets the URI of the content type.
Convenience method for setAttribute(new AttributeImpl(Metacard.TARGET_NAMESPACE, targetNamespace))

Parameters:

targetNamespace - URI of the sub-type, null if unused

See Also:

Metacard.TARGET_NAMESPACE

getContentTypeName

public String getContentTypeName()

Specified by:

getContentTypeName in interface ddf.catalog.data.Metacard

setContentTypeName

public void setContentTypeName(String contentType)

Sets the name of the content type of the Metacard.
Convenience method for setAttribute(new AttributeImpl(Metacard.CONTENT_TYPE, contentType))

Parameters:

contentType - name of content type of the Metacard

See Also:

Metacard.CONTENT_TYPE

getContentTypeVersion

public String getContentTypeVersion()

Specified by:

getContentTypeVersion in interface ddf.catalog.data.Metacard

setContentTypeVersion

public void setContentTypeVersion(String contentTypeVersion)

Sets the version of the content type of the Metacard.
Convenience method for setAttribute(new AttributeImpl(Metacard.CONTENT_TYPE_VERSION, contentTypeVersion))

Parameters:

contentTypeVersion - version of content type of the Metacard

See Also:

Metacard.CONTENT_TYPE_VERSION

getResourceURI

public URI getResourceURI()

Specified by:

getResourceURI in interface ddf.catalog.data.Metacard

setResourceURI

public void setResourceURI(URI uri)

See Also:

Metacard.RESOURCE_URI

setMetadataLinkURI

public void setMetadataLinkURI(URI uri)

setThumbnailLinkURI

public void setThumbnailLinkURI(URI uri)

setResourceSize

public void setResourceSize(String dadSize)

Sets the size of the resource which may or may not contain a unit.
Convenience method for setAttribute(new AttributeImpl(Metacard.RESOURCE_SIZE, dadSize))

Parameters:

dadSize - String representation of the size

See Also:

Metacard.RESOURCE_SIZE

getSecurity

public Map<String,List<String>> getSecurity()

Returns the security relevant markings on the Metacard.

Returns:

security markings

setSecurity

public void setSecurity(HashMap<String,List<String>> security)

Sets the security markings on this Metacard.
Convenience method for setAttribute(new AttributeImpl(Metacard.SECURITY, security))

Parameters:

security -

requestData

protected <T> T requestData(String attributeName,
                Class<T> returnType)

The brains of the operation -- does the interaction with the map or the wrapped metacard.

Type Parameters:

T - the type of the Attribute value expected

Parameters:

attributeName - the name of the Attribute to retrieve

returnType - the class that the value of the AttributeType is expected to be bound to

Returns:

the value of the requested Attribute name

getAttributeValue

protected <T> T getAttributeValue(ddf.catalog.data.Attribute attribute,
                      Class<T> returnType)

requestDate

protected Date requestDate(String key)

Get Date data from the map or wrapped metacard.
Convenience method for requestData(key, Date.class))

Parameters:

key - the name of the Attribute to retrieve

Returns:

the value of the requested Attribute name

requestDouble

protected Double requestDouble(String key)

Get Double data from the map or wrapped metacard.
Convenience method for requestData(key, Double.class))

Parameters:

key - the name of the Attribute to retrieve

Returns:

the value of the requested Attribute name

requestInputStream

protected InputStream requestInputStream(String key)

Get BinaryContent data from the map or wrapped metacard.
Convenience method for requestData(key, BinaryContent.class))

Parameters:

key - the name of the Attribute to retrieve

Returns:

the value of the requested Attribute name

requestInteger

protected Integer requestInteger(String key)

Get Integer data from the map or wrapped metacard.
Convenience method for requestData(key, Integer.class))

Parameters:

key - the name of the Attribute to retrieve

Returns:

the value of the requested Attribute name

requestLong

protected Long requestLong(String key)

Get Long data from the map or wrapped metacard.
Convenience method for requestData(key, Long.class))

Parameters:

key - the name of the Attribute to retrieve

Returns:

the value of the requested Attribute name

requestString

protected String requestString(String key)

Get String data from the map or wrapped metacard.
Convenience method for requestData(key, String.class))

Parameters:

key - the name of the Attribute to retrieve

Returns:

the value of the requested Attribute name

requestBytes

protected byte[] requestBytes(String key)

Get byte[] data from the map or wrapped metacard.
Convenience method for requestData(key, byte[].class))

Parameters:

key - the name of the Attribute to retrieve

Returns:

the value of the requested Attribute name

getAttribute

public ddf.catalog.data.Attribute getAttribute(String name)

Specified by:

getAttribute in interface ddf.catalog.data.Metacard

setAttribute

public void setAttribute(String name,
                Serializable value)

Set an attribute via a name/value pair.

Parameters:

name - the name of the Attribute

value - the value of the Attribute

setAttribute

public void setAttribute(ddf.catalog.data.Attribute attribute)

Specified by:

setAttribute in interface ddf.catalog.data.Metacard

hashCode

public int hashCode()

Overrides:

hashCode in class Object