com.j_spaces.sadapter.datasource

Class BulkDataItem

java.lang.Object

com.j_spaces.core.AbstractEntryType

com.j_spaces.core.EntryImpl

com.j_spaces.sadapter.cache.CacheEntry

com.j_spaces.sadapter.datasource.EntryAdapter

com.j_spaces.sadapter.datasource.BulkDataItem

All Implemented Interfaces:

BulkItem, DataSyncOperation, IGSEntry, InternalBulkItem, Serializable

Direct Known Subclasses:

PartialUpdateBulkDataItem

public class BulkDataItem
extends EntryAdapter
implements InternalBulkItem

BulkDataItem is used by the space for execution of bulk operations
in case of transactions and mirror replication.
BulkDataItem contains the data object and the operation that needs to be executed.

Author:

anna

See Also:

Serialized Form

Field Summary

Fields inherited from class com.j_spaces.sadapter.datasource.EntryAdapter

_converter

Fields inherited from class com.j_spaces.core.EntryImpl

_entryHolder

Fields inherited from class com.j_spaces.core.AbstractEntryType

_typeDesc

Fields inherited from interface com.gigaspaces.datasource.BulkItem

CHANGE, PARTIAL_UPDATE, REMOVE, UPDATE, WRITE

Constructor Summary

Constructors

Constructor and Description
BulkDataItem(IEntryHolder entryHolder, ITypeDesc typeDesc, short operation) Constructs a BulkDataItem out of IEntryHolder and TypeTableEntry.
BulkDataItem(IEntryHolder entryHolder, ITypeDesc typeDesc, short operation, IDataConverter<IEntryPacket> converter) Constructs a BulkDataItem out of IEntryHolder and TypeTableEntry. Given converter is used for internal entry conversion.

Method Summary

Modifier and Type	Method and Description
SpaceDocument	getDataAsDocument()
Object	getDataAsObject()
DataSyncOperationType	getDataSyncOperationType()
String	getIdPropertyName()
Object	getIdPropertyValue()
Object	getItem() Return the data item
Map<String,Object>	getItemValues()
short	getOperation() Return the operation to execute
Object	getSpaceId()
String	getTypeName()
String	getUid()
boolean	supportsDataAsDocument()
boolean	supportsDataAsObject()
boolean	supportsGetSpaceId()
boolean	supportsGetTypeDescriptor()
String	toString()

Methods inherited from class com.j_spaces.sadapter.datasource.EntryAdapter

getConverter, getTypeDescriptor, setConverter, toDocument, toDocument, toEntry, toEntry, toEntryPacket, toObject

Methods inherited from class com.j_spaces.sadapter.cache.CacheEntry

getClassName, getEntry, getMapEntry, setClassName, toString

Methods inherited from class com.j_spaces.core.EntryImpl

getFieldsValues, getFieldValue, getFieldValue, getHandback, getNotifyType, getTimeToLive, getUID, getVersion, isTransient, setFieldValue, setFieldValue

Methods inherited from class com.j_spaces.core.AbstractEntryType

getCodebase, getFieldPosition, getFieldsNames, getFieldsTypes, getFieldType, getIndexIndicators, getObject, getPrimaryKeyName, getProperties, getRoutingFieldName, getSuperClassesNames, hasDummyTTE, isFifo, isIndexedField, isReplicatable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.j_spaces.sadapter.datasource.InternalBulkItem

setConverter

Methods inherited from interface com.gigaspaces.sync.DataSyncOperation

getTypeDescriptor

Constructor Detail

BulkDataItem

public BulkDataItem(IEntryHolder entryHolder,
                    ITypeDesc typeDesc,
                    short operation)

Constructs a BulkDataItem out of IEntryHolder and TypeTableEntry.

Parameters:

entryHolder - underlying entry holder

typeDesc - underlying entry type information

operation - one of the qualified BulkItem operations.

BulkDataItem

public BulkDataItem(IEntryHolder entryHolder,
                    ITypeDesc typeDesc,
                    short operation,
                    IDataConverter<IEntryPacket> converter)

Constructs a BulkDataItem out of IEntryHolder and TypeTableEntry.
Given converter is used for internal entry conversion.

Method Detail

getItem

public Object getItem()

Description copied from interface: BulkItem

Return the data item

Specified by:

getItem in interface BulkItem

Returns:

data item

getOperation

public short getOperation()

Description copied from interface: BulkItem

Return the operation to execute

Specified by:

getOperation in interface BulkItem

Returns:

operation type BulkItem.REMOVE/BulkItem.UPDATE/BulkItem.WRITE/BulkItem.PARTIAL_UPDATE

toString

public String toString()

Overrides:

toString in class CacheEntry

getTypeName

public String getTypeName()

Specified by:

getTypeName in interface BulkItem

Returns:

the name of the type/class

getIdPropertyName

public String getIdPropertyName()

Specified by:

getIdPropertyName in interface BulkItem

Returns:

the name of the id property

getIdPropertyValue

public Object getIdPropertyValue()

Specified by:

getIdPropertyValue in interface BulkItem

Returns:

the value of the id property

getSpaceId

public Object getSpaceId()

Specified by:

getSpaceId in interface DataSyncOperation

Returns:

The operation's data Id.

supportsGetSpaceId

public boolean supportsGetSpaceId()

Specified by:

supportsGetSpaceId in interface DataSyncOperation

Returns:

whether this data operation support the DataSyncOperation.getSpaceId() operation.

getItemValues

public Map<String,Object> getItemValues()

Specified by:

getItemValues in interface BulkItem

Returns:

a map of the object properties. The keys are the names of the properties and their values is the object values. In case of a partial update - only the updated values are returned.s

getUid

public String getUid()

Specified by:

getUid in interface DataSyncOperation

Returns:

The operation's data UID.

getDataSyncOperationType

public DataSyncOperationType getDataSyncOperationType()

Specified by:

getDataSyncOperationType in interface DataSyncOperation

Returns:

the operation type.

getDataAsObject

public Object getDataAsObject()

Specified by:

getDataAsObject in interface DataSyncOperation

Returns:

the operation data as object (i.e pojo), this can only be used if DataSyncOperation.supportsDataAsObject() return true, otherwise an exception will be thrown.

getDataAsDocument

public SpaceDocument getDataAsDocument()

Specified by:

getDataAsDocument in interface DataSyncOperation

Returns:

the operation data as space document, this can only be used if DataSyncOperation.supportsDataAsDocument() return true, otherwise an exception will be thrown.

supportsGetTypeDescriptor

public boolean supportsGetTypeDescriptor()

Specified by:

supportsGetTypeDescriptor in interface DataSyncOperation

Returns:

whether this data operation support the DataSyncOperation.getTypeDescriptor() operation.

supportsDataAsObject

public boolean supportsDataAsObject()

Specified by:

supportsDataAsObject in interface DataSyncOperation

Returns:

whether this data operation support the DataSyncOperation.getDataAsObject() operation.

supportsDataAsDocument

public boolean supportsDataAsDocument()

Specified by:

supportsDataAsDocument in interface DataSyncOperation

Returns:

whether this data operation support the DataSyncOperation.getDataAsDocument() operation.