Package com.im.df.api.support
Class DFUpdateDescription
- java.lang.Object
-
- com.im.df.api.support.DFUpdateDescription
-
public final class DFUpdateDescription extends java.lang.Object
Description of a single data update operation.- Author:
- Petr Hamernik
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DFUpdateDescription
create(DFEntity entity, java.lang.Comparable<?> rowId, java.util.Map<java.lang.String,java.lang.Object> valuesToUpdate)
Creates an update operation description for a single row ID.static DFUpdateDescription
create(DFEntity entity, java.util.List<? extends java.lang.Comparable<?>> rowIds, java.util.Map<java.lang.String,java.lang.Object> valuesToUpdate)
Creates an update operation description for a set of rows.static DFUpdateDescription
createForAllIds(DFEntity entity, java.util.Map<java.lang.String,java.lang.Object> valuesToUpdate)
Creates an update operation description for updating all rows in an entity.DFEntity
getEntity()
java.util.List<? extends java.lang.Comparable<?>>
getRowIds()
Current implementation can returnnull
if expression is specified.java.util.Map<java.lang.String,java.lang.Object>
getValuesToUpdate()
java.lang.String
toString()
-
-
-
Method Detail
-
createForAllIds
public static DFUpdateDescription createForAllIds(DFEntity entity, java.util.Map<java.lang.String,java.lang.Object> valuesToUpdate)
Creates an update operation description for updating all rows in an entity.- Parameters:
entity
- The entity to update.valuesToUpdate
- ThefieldId-to-value
map of new values to set in the row. Must not benull
nor an empty map.- Returns:
- The new
DFUpdateDescription
instance describing an update operation on the entity. - Since:
- 6.3
-
create
public static DFUpdateDescription create(DFEntity entity, java.lang.Comparable<?> rowId, java.util.Map<java.lang.String,java.lang.Object> valuesToUpdate)
Creates an update operation description for a single row ID.- Parameters:
entity
- The entity to update.rowId
- The entity's ID field value identifying the row to update.valuesToUpdate
- ThefieldId-to-value
map of new values to set in the row. Must not benull
nor an empty map.- Returns:
- The new
DFUpdateDescription
instance describing an update operation on the entity.
-
create
public static DFUpdateDescription create(DFEntity entity, java.util.List<? extends java.lang.Comparable<?>> rowIds, java.util.Map<java.lang.String,java.lang.Object> valuesToUpdate)
Creates an update operation description for a set of rows.- Parameters:
entity
- The entity to update.rowIds
- The entity's ID field values identifying the rows to update. Must not benull
nor an empty list.valuesToUpdate
- ThefieldId-to-value
map of new values to set in the row. Must not benull
nor an empty map.- Returns:
- The new
DFUpdateDescription
instance describing an update operation on the entity.
-
getValuesToUpdate
public java.util.Map<java.lang.String,java.lang.Object> getValuesToUpdate()
-
getEntity
public DFEntity getEntity()
-
getRowIds
public java.util.List<? extends java.lang.Comparable<?>> getRowIds()
Current implementation can returnnull
if expression is specified.- Returns:
- The changed rows' ids or possibly
null
.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-