ddf.catalog.data.impl

Class MetacardImpl

java.lang.Object

ddf.catalog.data.impl.MetacardImpl

All Implemented Interfaces:

Metacard, Serializable

Direct Known Subclasses:

DeletedMetacardImpl, HandlebarsMetacard, IdAndUriMetacard, MetacardVersionImpl, QueryMetacardImpl, WorkspaceMetacardImpl

public class MetacardImpl
extends Object
implements Metacard

Implements the Metacard's required attributes.

Serialization Note

This class is Serializable and care should be taken with compatibility if changes are made.

For backward and forward compatibility, ObjectOutputStream.defaultWriteObject() is invoked when this object is serialized because it provides "enhanced flexibility" (Joshua Block Effective Java, Second Edition Item 75). Invoking ObjectOutputStream.defaultWriteObject() allows the flexibility to add nontransient instance fields in later versions if necessary. If earlier versions do not have the newly added fields, those fields will be ignored and the deserialization will still take place. In addition, ObjectInputStream.defaultReadObject() is necessary to facilitate any of the written fields.

For what constitutes a compatible change in serialization, see Sun's Guidelines.

Author:

ddf.isgs@lmco.com

See Also:

Serialized Form

Field Summary

Fields inherited from interface ddf.catalog.data.Metacard

ANY_DATE, ANY_GEO, ANY_TEXT, CHECKSUM, CHECKSUM_ALGORITHM, CONTENT_TYPE, CONTENT_TYPE_VERSION, CREATED, DEFAULT_TAG, DERIVED, DERIVED_RESOURCE_DOWNLOAD_URL, DERIVED_RESOURCE_URI, DESCRIPTION, EFFECTIVE, EXPIRATION, GEOGRAPHY, ID, METADATA, MODIFIED, POINT_OF_CONTACT, RELATED, RESOURCE_DOWNLOAD_URL, RESOURCE_SIZE, RESOURCE_URI, SECURITY, SECURITY_MATCH_ALL, SECURITY_MATCH_ONE, SOURCE_ID, TAGS, TARGET_NAMESPACE, THUMBNAIL, TITLE

Constructor Summary

Constructors

Constructor and Description
MetacardImpl() Creates a Metacard with a type of BasicTypes.BASIC_METACARD and empty Attributes.
MetacardImpl(Metacard metacard) Creates a Metacard with the provided Metacard.
MetacardImpl(Metacard metacard, MetacardType type) Creates a Metacard with the provided Metacard and MetacardType.
MetacardImpl(MetacardType type) Creates a Metacard with the provided MetacardType and empty Attribute s.

Method Summary

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.
String	getDescription() Returns the description for the Metacard
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	getPointOfContact() Returns the Point of Contact for the Metacard
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.
Map<String,List<String>>	getSecurity() Returns the security relevant markings on the Metacard.
String	getSourceId() Returns the source ID of the source the metacard is located.
byte[]	getThumbnail() Returns the thumbnail associated with this Metacard.
String	getTitle() Returns the title of this Metacard.
int	hashCode()
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(Attribute attribute) Sets Attribute with new 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	setDescription(String description) Sets the description of the Metacard.
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	setModifiedDate(Date modified) Sets the date/time the Metacard was last modifed.
void	setPointOfContact(String pointOfContact) Sets the point of contact for the Metacard.
void	setResourceSize(String dadSize) Sets the size of the resource which may or may not contain a unit.
void	setResourceURI(URI uri) Sets the value of this Metacards Resource URI and in the form of a URI Object.
void	setSecurity(HashMap<String,List<String>> security) Sets the security markings on this Metacard.
void	setSourceId(String sourceId) Sets the source ID of the source the metacard is located.
void	setTags(Set<String> tags) Sets the tags associated with this metacard
void	setTargetNamespace(URI targetNamespace) Some types of metadata use different content types.
void	setThumbnail(byte[] bytes) Sets the thumbnail associated with this Metacard.
void	setTitle(String title) Sets the title of this Metacard.
void	setType(MetacardType type) Sets the MetacardType of the Metacard.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ddf.catalog.data.Metacard

getTags

Constructor Detail

MetacardImpl

public MetacardImpl()

Creates a Metacard with a type of BasicTypes.BASIC_METACARD and empty Attributes.

MetacardImpl

public MetacardImpl(MetacardType type)

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

Parameters:

type - the MetacardType

MetacardImpl

public MetacardImpl(Metacard metacard)

Creates a Metacard with the provided Metacard.

Parameters:

metacard - the Metacard to create this new Metacard from

MetacardImpl

public MetacardImpl(Metacard metacard,
                    MetacardType type)

Creates a Metacard with the provided Metacard and MetacardType. This method does not simply wrap the metacard and keep its type, but will create a new metacard and clone any attributes defined by the MetacardType that exist on the given Metacard. Note, this means any attributes with null values will not be copied over.

Parameters:

metacard - the Metacard to create this new Metacard from

type - the MetacardType of metacard to create

Method Detail

getCreatedDate

public Date getCreatedDate()

Description copied from interface: Metacard

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

Specified by:

getCreatedDate in interface Metacard

Returns:

Date - when this Metacard was created.

See Also:

Metacard.CREATED

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

getModifiedDate

public Date getModifiedDate()

Description copied from interface: Metacard

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

Specified by:

getModifiedDate in interface Metacard

Returns:

Date - when this Metacard was last modified.

See Also:

Metacard.MODIFIED

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()

Description copied from interface: Metacard

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

Specified by:

getExpirationDate in interface Metacard

Returns:

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

See Also:

Metacard.EXPIRATION

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()

Description copied from interface: Metacard

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

Specified by:

getEffectiveDate in interface Metacard

Returns:

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

See Also:

Metacard.EFFECTIVE

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()

Description copied from interface: Metacard

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

Specified by:

getId in interface Metacard

Returns:

unique identifier of the Metacard

See Also:

Metacard.ID

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()

Description copied from interface: Metacard

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

Specified by:

getLocation in interface Metacard

Returns:

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

See Also:

Metacard.GEOGRAPHY

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()

Description copied from interface: Metacard

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

Specified by:

getSourceId in interface Metacard

setSourceId

public void setSourceId(String sourceId)

Description copied from interface: Metacard

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

Specified by:

setSourceId in interface Metacard

Parameters:

sourceId - unique name of source location of metacard

getThumbnail

public byte[] getThumbnail()

Description copied from interface: Metacard

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

Specified by:

getThumbnail in interface Metacard

Returns:

thumbnail for the Metacard

See Also:

Metacard.THUMBNAIL

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

getTitle

public String getTitle()

Description copied from interface: Metacard

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

Specified by:

getTitle in interface Metacard

Returns:

Title of the Metacard

See Also:

Metacard.TITLE

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

getMetadata

public String getMetadata()

Description copied from interface: Metacard

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

Specified by:

getMetadata in interface Metacard

Returns:

XML metadata

See Also:

Metacard.METADATA

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 MetacardType getMetacardType()

Description copied from interface: Metacard

Return the MetacardType of this Metacard.

Specified by:

getMetacardType in interface Metacard

Returns:

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

setType

public void setType(MetacardType type)

Sets the MetacardType of the Metacard.

Parameters:

type - MetacardType of the Metacard

See Also:

MetacardType

getContentTypeNamespace

public URI getContentTypeNamespace()

Description copied from interface: Metacard

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

Specified by:

getContentTypeNamespace in interface Metacard

Returns:

URI - the sub-type, null if unused

See Also:

Metacard.TARGET_NAMESPACE

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()

Description copied from interface: Metacard

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

Specified by:

getContentTypeName in interface Metacard

Returns:

name of content type of the Metacard

See Also:

Metacard.CONTENT_TYPE

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

setTags

public void setTags(Set<String> tags)

Sets the tags associated with this metacard

Parameters:

tags - set of tags

getPointOfContact

public String getPointOfContact()

Returns the Point of Contact for the Metacard

Returns:

A String representing the Point of Contact for the Metacard.

setPointOfContact

public void setPointOfContact(String pointOfContact)

Sets the point of contact for the Metacard.
Convenience method for setAttribute(new AttributeImpl(Metacard.POINT_OF_CONTACT, pointOfContact))

Parameters:

pointOfContact - the point of contact for the Metacard

See Also:

Metacard.POINT_OF_CONTACT

getDescription

public String getDescription()

Returns the description for the Metacard

Returns:

A String representing the description for the Metacard.

setDescription

public void setDescription(String description)

Sets the description of the Metacard.
Convenience method for setAttribute(new AttributeImpl(Metacard.DESCRIPTION, description))

Parameters:

description - the description of the Metacard

See Also:

Metacard.DESCRIPTION

getContentTypeVersion

public String getContentTypeVersion()

Description copied from interface: Metacard

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

Specified by:

getContentTypeVersion in interface Metacard

Returns:

version of content type of the Metacard

See Also:

Metacard.CONTENT_TYPE_VERSION

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()

Description copied from interface: Metacard

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

Specified by:

getResourceURI in interface Metacard

Returns:

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

setResourceURI

public void setResourceURI(URI uri)

Sets the value of this Metacards Resource URI and in the form of a URI Object.
Convenience method for setAttribute(new AttributeImpl(Metacard.RESOURCE_URI, uri))

Parameters:

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

See Also:

Metacard.RESOURCE_URI

getResourceSize

public String getResourceSize()

Description copied from interface: Metacard

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

Specified by:

getResourceSize in interface Metacard

Returns:

String - String representation of the size

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

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

See Also:

requestData(String, Class)

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

See Also:

requestData(String, Class)

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

See Also:

requestData(String, Class)

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

See Also:

requestData(String, Class)

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

See Also:

requestData(String, Class)

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

See Also:

requestData(String, Class)

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

See Also:

requestData(String, Class)

getAttribute

public Attribute getAttribute(String name)

Description copied from interface: Metacard

Returns Attribute for given attribute name.

Specified by:

getAttribute in interface Metacard

Parameters:

name - name of attribute

Returns:

Attribute for given name, or null if not available

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(Attribute attribute)

Description copied from interface: Metacard

Sets Attribute with new attribute.

Specified by:

setAttribute in interface Metacard

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.

hashCode

public int hashCode()

Overrides:

hashCode in class Object