org.codice.ddf.spatial.ogc.csw.catalog.common.transaction

Class UpdateAction

java.lang.Object

org.codice.ddf.spatial.ogc.csw.catalog.common.transaction.CswAction

org.codice.ddf.spatial.ogc.csw.catalog.common.transaction.UpdateAction

public class UpdateAction
extends CswAction

An UpdateAction represents a single update action within a CSW transaction.

Field Summary

Fields inherited from class org.codice.ddf.spatial.ogc.csw.catalog.common.transaction.CswAction

handle, typeName

Constructor Summary

Constructors

Constructor and Description
UpdateAction(Map<String,Serializable> recordProperties, String typeName, String handle, QueryConstraintType constraint, Map<String,String> prefixToUriMappings) Constructs an UpdateAction with the specified map of attributes to new values to update in the metacard, typeName, handle, constraint, and map of XML namespace prefixes to their respective URIs.
UpdateAction(Metacard metacard, String typeName, String handle) Constructs an UpdateAction with the specified metacard, typeName, and handle.

Method Summary

Modifier and Type	Method and Description
QueryConstraintType	getConstraint()
Metacard	getMetacard()
Map<String,String>	getPrefixToUriMappings()
Map<String,Serializable>	getRecordProperties()

Methods inherited from class org.codice.ddf.spatial.ogc.csw.catalog.common.transaction.CswAction

getHandle, getTypeName

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateAction

public UpdateAction(Metacard metacard,
                    String typeName,
                    String handle)

Constructs an UpdateAction with the specified metacard, typeName, and handle. This UpdateAction will replace the existing metacard having the same ID as metacard with metacard.

If an error occurs while processing this update action, handle will be included in the exception report response so the specific action within the transaction that caused the error can be identified.

Parameters:

metacard - the updated metacard that will replace the existing metacard with the same ID

typeName - the type of record being updated, such as csw:Record

handle - the name to associate with this update action

UpdateAction

public UpdateAction(Map<String,Serializable> recordProperties,
                    String typeName,
                    String handle,
                    QueryConstraintType constraint,
                    Map<String,String> prefixToUriMappings)

Constructs an UpdateAction with the specified map of attributes to new values to update in the metacard, typeName, handle, constraint, and map of XML namespace prefixes to their respective URIs. prefixToUriMappings should contain the prefix to URI mappings declared in the transaction request XML.

This UpdateAction will update all metacards matching constraint by updating their attributes according to the attribute names and values specified in recordProperties.

If an error occurs while processing this update action, handle will be included in the exception report response so the specific action within the transaction that caused the error can be identified.

Parameters:

recordProperties - the map of attribute names to update to their new values

typeName - the type of record being updated, such as csw:Record

handle - the name to associate with this update action

constraint - the QueryConstraintType that specifies which metacards this update will be applied to

prefixToUriMappings - the map that contains the XML namespace prefix to URI mappings declared in the transaction request XML

Method Detail

getMetacard

public Metacard getMetacard()

getConstraint

public QueryConstraintType getConstraint()

getRecordProperties

public Map<String,Serializable> getRecordProperties()

getPrefixToUriMappings

public Map<String,String> getPrefixToUriMappings()