Interface TransformerRecord
-
- All Superinterfaces:
DSData
,DSPacket
,DSRecord
,DSSerializable
,java.lang.Iterable<DSField>
,TransformerData
,TransformerFlags
- All Known Implementing Classes:
TransformerRecordImpl
public interface TransformerRecord extends TransformerData, DSRecord
Represents an update for a particular record object. An update may be received by a Transformer module if it has subscribed to some data using either the
Subscriber.addSubscriptionListener(String, SubscriptionListener)
or theSubscriber.addSubscriptionListener(ObjectType, SubscriptionListener)
methods. If the object's type is a record, then the update can be cast to a TransformerRecord. Alternatively, the Transformer module can create an update using one of theDSFactory.createTransformerRecord(java.lang.String)
methods, and can send the update to the Transformer core for processing.The option to create instances of a TransformerRecord is vital for any Transformer module that wants to act as a
DataProvider
, or to process an update for one DataSource object, and publish the results of the processing on a different DataSource object.As soon as the update is sent, its memory is freed by the Transformer core. Any further attempts to use the object will result in IllegalStateExceptions being thrown. If the update needs to be sent, then further changes made to the object, the
DSFactory.createTransformerRecord(TransformerRecord)
method should be used to create a copy of the object before the update is sent.- See Also:
DSFactory
-
-
Field Summary
-
Fields inherited from interface com.caplin.datasrc.interfaces.DSData
CONTAINER_TYPE, F_AUTH_UPDATE, F_AUTHGLOBAL, F_CHANGEDFIELDS, F_CLEAR_PERMISSIONS, F_CLEAR_TYPE2, F_CLEAR_TYPE3, F_CREATEOBJECT, F_CREATEPARENT, F_DELETE_PERMISSION, F_FILTER_TYPE2, F_FILTER_TYPE3, F_IMAGE, F_NONACTIVE, GENERIC_TYPE, NEWS_TYPE, PAGE_TYPE, PERMISSION_TYPE, RECORD_TYPE, STORY_TYPE, TYPE2_RECORD_TYPE, TYPE3_RECORD_TYPE, UNKNOWN_TYPE
-
Fields inherited from interface com.caplin.datasrc.interfaces.DSRecord
DS_FIELDS_SEPARATOR, F_NOCACHE
-
Fields inherited from interface com.caplin.transformer.module.TransformerFlags
MAINTAIN_TIMESTAMP, NO_FLAGS, NO_PERSISTENCE, PUBLISH_TO_PEERS, SILENT_SEND, STORE_IN_CACHE
-
-
Method Summary
-
Methods inherited from interface com.caplin.datasrc.interfaces.DSData
addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addData, addData, addData, addData, addData, addData, addData, addData, clearFields, count, elements, getFieldByFieldNumber, getFieldByFieldNumber, getFlags, getKeys, getSubject, getType, getValues, iterator, removeField, setFlags, setSubject, setType, updateData, updateData
-
Methods inherited from interface com.caplin.datasrc.interfaces.DSPacket
send, sendDirect, sendToPeer
-
Methods inherited from interface com.caplin.datasrc.interfaces.DSRecord
addBinaryRecordData, addBinaryRecordData, addBinaryRecordData, addBinaryRecordData, addBinaryRecordData, addBinaryRecordData, addBinaryRecordData, addBinaryRecordData, addDataSeparator, addRecordData, addRecordData, addRecordData, addRecordData, addRecordData, addRecordData, addRecordData, getFieldByName, getFieldByName, updateRecordData, updateRecordData
-
Methods inherited from interface com.caplin.datasrc.interfaces.DSSerializable
toBytes
-
Methods inherited from interface com.caplin.transformer.module.datasrc.TransformerData
getDSDataPointer, getObjectType, getSequenceNumber, merge, send, setType
-
-