ddf.catalog.operation

Interface UpdateRequest

All Superinterfaces:

Operation, Request, Serializable

All Known Implementing Classes:

UpdateRequestImpl

public interface UpdateRequest
extends Request

Interface representing a request to update a Metacard. Requests may be batched, but each Metacard/Attribute pair will only update a single Metacard.

Author:

ddf.isgs@lmco.com

See Also:

CatalogProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	UPDATE_BY_ID Shortcut for the Attribute name used for updating Metacards by ID.
static String	UPDATE_BY_PRODUCT_URI Shortcut for the Attribute name used for updating Metacards by the String value of the Metacard's Resource URI.

Method Summary

Modifier and Type	Method and Description
String	getAttributeName() The attribute name tells the CatalogProvider what type of attribute values are the Map.Entry keys in the update list.
List<Map.Entry<Serializable,Metacard>>	getUpdates() Get the updates to be made.

Methods inherited from interface ddf.catalog.operation.Request

getStoreIds

Methods inherited from interface ddf.catalog.operation.Operation

containsPropertyName, getProperties, getPropertyNames, getPropertyValue, hasProperties

Field Detail

UPDATE_BY_ID

static final String UPDATE_BY_ID

Shortcut for the Attribute name used for updating Metacards by ID.

See Also:

Metacard.ID, Constant Field Values

UPDATE_BY_PRODUCT_URI

static final String UPDATE_BY_PRODUCT_URI

Shortcut for the Attribute name used for updating Metacards by the String value of the Metacard's Resource URI.

See Also:

Metacard.RESOURCE_URI, Constant Field Values

Method Detail

getAttributeName

String getAttributeName()

The attribute name tells the CatalogProvider what type of attribute values are the Map.Entry keys in the update list. For instance, if the attribute name was "id," then the CatalogProvider would know that the Map.Entry keys in the update list ( List<Entry<Serializable, Metacard>>) were id values (such as 575aa9625fa24b338bd3c439f2613709) and could create the appropriate backend search.

Returns:

the name of the attribute, the attribute name must correspond to an Attribute that has an ddf.catalog.data.AttributeType.AttributeFormat of AttributeType.AttributeFormat.STRING

getUpdates

List<Map.Entry<Serializable,Metacard>> getUpdates()

Get the updates to be made. Any Metacards that have an Attribute.getName() that matches the name returned by getAttributeName() and a Attribute.getValue() that matches the Serializable value in an Map.Entry of this List will be updated with the value of the associated Metacard in the List. An entry's key in the List must match zero metacards or one metacard in the Source.

Returns:

List - pairs of Attribute values and associated new Metacards to update if a match is found.