ddf.catalog.operation.impl

Class UpdateRequestImpl

java.lang.Object

ddf.catalog.operation.impl.OperationImpl

ddf.catalog.operation.impl.UpdateRequestImpl

All Implemented Interfaces:

Operation, Request, UpdateRequest, Serializable

public class UpdateRequestImpl
extends OperationImpl
implements UpdateRequest

The UpdateRequestImpl represents the default implementation of UpdateRequest.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected List<Map.Entry<Serializable,Metacard>>	updates

Fields inherited from interface ddf.catalog.operation.UpdateRequest

UPDATE_BY_ID, UPDATE_BY_PRODUCT_URI

Constructor Summary

Constructors

Constructor and Description
UpdateRequestImpl(List<Map.Entry<Serializable,Metacard>> updateList, String attributeName, Map<String,Serializable> properties) Instantiates a new UpdateRequestImpl.
UpdateRequestImpl(List<Map.Entry<Serializable,Metacard>> updateList, String attributeName, Map<String,Serializable> properties, Set<String> destinations) Instantiates a new UpdateRequestImpl.
UpdateRequestImpl(String[] ids, List<Metacard> metacards) Instantiates a new UpdateRequestImpl from an array of ids and a list of Metacard
UpdateRequestImpl(String id, Metacard metacard) Instantiates a new UpdateRequestImpl from an id and metacard
UpdateRequestImpl(URI[] uris, List<Metacard> metacards) Instantiates a new UpdateRequestImpl from an array of URI and a list of Metacard

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.
Set<String>	getStoreIds() Returns a set of ids that correspond to catalog destinations
List<Map.Entry<Serializable,Metacard>>	getUpdates() Get the updates to be made.

Methods inherited from class ddf.catalog.operation.impl.OperationImpl

containsPropertyName, getProperties, getPropertyNames, getPropertyValue, hasProperties, setProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface ddf.catalog.operation.Operation

containsPropertyName, getProperties, getPropertyNames, getPropertyValue, hasProperties

Field Detail

name

protected String name

updates

protected List<Map.Entry<Serializable,Metacard>> updates

Constructor Detail

UpdateRequestImpl

public UpdateRequestImpl(List<Map.Entry<Serializable,Metacard>> updateList,
                         String attributeName,
                         Map<String,Serializable> properties,
                         Set<String> destinations)

Instantiates a new UpdateRequestImpl.

Parameters:

updateList - the list of updated Metacard

attributeName - the attribute name (e.g. Metacard.ID, Metacard.PRODUCT_URI)

properties - the properties associated with the operation

destinations - the destination ids this request should be sent to

UpdateRequestImpl

public UpdateRequestImpl(List<Map.Entry<Serializable,Metacard>> updateList,
                         String attributeName,
                         Map<String,Serializable> properties)

Instantiates a new UpdateRequestImpl.

Parameters:

updateList - - the list of updated Metacard

attributeName - the attribute name (e.g. Metacard.ID, Metacard.PRODUCT_URI)

properties - the properties associated with the operation

UpdateRequestImpl

public UpdateRequestImpl(String id,
                         Metacard metacard)

Instantiates a new UpdateRequestImpl from an id and metacard

Parameters:

id - the id of the Metacard to update

metacard - the updated Metacard value.

UpdateRequestImpl

public UpdateRequestImpl(String[] ids,
                         List<Metacard> metacards)
                  throws IllegalArgumentException

Instantiates a new UpdateRequestImpl from an array of ids and a list of Metacard

Parameters:

ids - - the ids associated with the Metacard list

metacards - the updated Metacard values

Throws:

IllegalArgumentException - if the ids array size and list of Metacard size does not match

UpdateRequestImpl

public UpdateRequestImpl(URI[] uris,
                         List<Metacard> metacards)
                  throws IllegalArgumentException

Instantiates a new UpdateRequestImpl from an array of URI and a list of Metacard

Parameters:

uris - - the uris associated with the Metacard list

metacards - the updated Metacard values

Throws:

IllegalArgumentException - if the uris array size and list of Metacard size does not match

Method Detail

getStoreIds

public Set<String> getStoreIds()

Description copied from interface: Request

Returns a set of ids that correspond to catalog destinations

Specified by:

getStoreIds in interface Request

Returns:

getAttributeName

public String getAttributeName()

Description copied from interface: UpdateRequest

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.

Specified by:

getAttributeName in interface UpdateRequest

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

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

Description copied from interface: UpdateRequest

Get the updates to be made. Any Metacards that have an Attribute.getName() that matches the name returned by UpdateRequest.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.

Specified by:

getUpdates in interface UpdateRequest

Returns:

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