Index

A B C D E F G H I J L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

G

GENERIC - Enum constant in enum class com.caplin.datasource.messaging.MessageType
 
GENERIC_TYPE - Static variable in interface com.caplin.datasource.interfaces.DSData
A Generic Type object type.
GenericMessage - Interface in com.caplin.datasource.messaging.record
Interface for sending Generic messages, adding fields by name and value.
genericMessageUpdated(Subscription, Peer, GenericMessage) - Method in class com.caplin.datasource.subscription.BaseSubscriptionListener
 
genericMessageUpdated(Subscription, Peer, GenericMessage) - Method in interface com.caplin.datasource.subscription.SubscriptionListener
Called when an update to generic message data is received.
get(String) - Method in interface com.caplin.jtm.DataCache
Gets a Message cached within the Transformer core for the specified object name.
get(String, Map<String, String>) - Method in interface com.caplin.jtm.persistence.Persistence
 
get(String, Map<String, String>, long) - Method in interface com.caplin.jtm.persistence.Persistence
 
get(String, Map<String, String>, LinkedHashMap<String, Ordering>) - Method in interface com.caplin.jtm.persistence.Persistence
 
get(String, Map<String, String>, LinkedHashMap<String, Ordering>, long) - Method in interface com.caplin.jtm.persistence.Persistence
Gets entries from the persistence service given the provided selector
getArgs() - Method in class com.caplin.jtm.persistence.QueryParams
 
getBitFlag() - Method in enum class com.caplin.datasource.SubjectError.Flags
 
getBuildDate() - Method in class com.caplin.jtm.TransformerModuleVersion
 
getBuildNumber() - Method in class com.caplin.jtm.TransformerModuleVersion
 
getBuildTime() - Method in class com.caplin.jtm.TransformerModuleVersion
 
getCachedMessageFactory() - Method in interface com.caplin.datasource.publisher.CachingPublisher
Gets the CachedMessageFactory used to create the messages that are published via this Publisher.
getClazz() - Method in enum class com.caplin.jtm.pipeline.PipelineType
Get the class representing this pipeline type
getClearFlag() - Method in interface com.caplin.datasource.messaging.record.RecordType2Message
Gets a value indicating whether all the Type2 data should be cleared.
getClearFlag() - Method in interface com.caplin.datasource.messaging.record.RecordType3Message
Gets a value indicating whether all the Type3 data should be cleared.
getClearFlag() - Method in interface com.caplin.datasource.messaging.record.WrapperMessage
Gets a value indicating whether all the Type2/type3 data should be cleared.
getCode() - Method in interface com.caplin.datasource.interfaces.DSStatus
Gets the code for this status message.
getCode() - Method in enum class com.caplin.datasource.messaging.MessageType
Gets the code that represents the Message's type.
getCode() - Method in enum class com.caplin.datasource.SubjectStatus
Gets the integer code for this status
getColumn() - Method in interface com.caplin.datasource.messaging.page.PageElement
The column (horizontal) coordinate of the start of the updated region.
getContribUser() - Method in interface com.caplin.datasource.messaging.json.JsonChannelMessage
Grabs the string value of the user who has contributed from the Json message metadata
getCopyright() - Method in class com.caplin.jtm.TransformerModuleVersion
 
getDataCache() - Method in interface com.caplin.jtm.TransformerAccessor
Returns an object that allows the Transformer module to access the data cached within the Transformer's core.
getDeleteEntryFlag() - Method in interface com.caplin.datasource.messaging.record.RecordType2Message
Gets a value indicating whether this Type2 index should be deleted.
getDeletePermissionKey() - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage
Gets a value indicating whether this permission message specifies that the permission key should be deleted from the Liberator's cache.
getElementPosition() - Method in interface com.caplin.datasource.messaging.container.ContainerOperation
If this is an insert operation, this method returns the position in the container where the element is to be inserted (the first position is position 0).
getElementSubject() - Method in interface com.caplin.datasource.messaging.container.ContainerOperation
Gets the subject of the element that this operation relates to.
getError() - Method in interface com.caplin.datasource.SubjectErrorEvent
Gets the SubjectError relating to the SubjectErrorEvent.
getErrorCode() - Method in exception com.caplin.jtm.exceptions.DataCachePutException
Gets the error code that the Transformer returned to indicate what the problem was.
getErrorCode() - Method in exception com.caplin.jtm.net.udp.UDPCommandRemovalException
Gets the error code that was returned from the UDPAccessor to indicate what the problem was.
getField(String) - Method in interface com.caplin.datasource.messaging.news.NewsMessage
Gets a custom field from a news message
getField(String) - Method in interface com.caplin.datasource.messaging.page.PageMessage
Gets the value of the specified field.
getField(String) - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage
Gets a specified field within this permission message.
getField(String) - Method in interface com.caplin.datasource.messaging.record.RecordMessage
Gets the value of the specified field.
getField(String, int) - Method in interface com.caplin.jtm.DataCache
Gets the latest value from the Transformer core for the specified object name and field number.
getField(String, String) - Method in interface com.caplin.jtm.DataCache
Gets the latest value from the Transformer core for the specified object and field names.
getFieldByFieldNumber(int) - Method in interface com.caplin.datasource.interfaces.DSData
Gets the first occurrence of the field with the specified field number.
getFieldByFieldNumber(int, int) - Method in interface com.caplin.datasource.interfaces.DSData
Gets the specified occurrence of the field with the specified field number.
getFieldByName(String) - Method in interface com.caplin.datasource.fields.FieldManager
Given the field's name, returns a structure containing both the field's name and number.
getFieldByName(String) - Method in interface com.caplin.datasource.interfaces.DSRecord
Gets the first occurrence of the field with the specified field name.
getFieldByName(String, int) - Method in interface com.caplin.datasource.interfaces.DSRecord
Gets the specified occurrence of the field with the specified field name.
getFieldByNumber(int) - Method in interface com.caplin.datasource.fields.FieldManager
Given the field's number, returns a structure containing both the field's name and number.
getFieldInfo() - Method in interface com.caplin.datasource.interfaces.DSField
Get the field information for this field, if available.
getFieldManager() - Method in interface com.caplin.jtm.TransformerAccessor
Gets the datasource field manager
getFields() - Method in interface com.caplin.datasource.fields.FieldManager
Returns a list of the available fields.
getFields() - Method in interface com.caplin.datasource.messaging.page.PageMessage
Gets the fields within this PageMessage, in the order of which the fields were sent.
getFields() - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage
Gets the fields within this permission message.
getFields() - Method in interface com.caplin.datasource.messaging.record.RecordMessage
Gets the fields within this RecordMessage, in the order of which the fields were sent.
getFlagCode() - Method in enum class com.caplin.datasource.publisher.PublishFlag
 
getFlags() - Method in interface com.caplin.datasource.interfaces.DSData
Gets the flags that are going to be sent with this packet.
getFlags() - Method in interface com.caplin.datasource.interfaces.DSField
Get the flags set on this field.
getFlags() - Method in interface com.caplin.datasource.interfaces.DSStatus
Gets the flags for this status message.
getGlobal() - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage
Gets a value indicating whether this PermissionMessage is a global permission message.
getGlobalPublisher() - Method in interface com.caplin.jtm.TransformerAccessor
Gets the global Publisher.
getHeadline() - Method in interface com.caplin.datasource.messaging.news.NewsMessage
Gets the headline of the news message.
getHeight() - Method in interface com.caplin.datasource.messaging.page.PageMessage
Gets the height of the page, in text rows.
getIndex() - Method in interface com.caplin.datasource.Peer
Gets the index of this peer.
getInstance() - Static method in class com.caplin.jtm.TransformerModuleVersion
 
getJson() - Method in interface com.caplin.datasource.messaging.json.JsonMessage
Deprecated.
Use getJsonObject instead of this method, string format no-longer supported.
getJsonAsType(Class<T>) - Method in interface com.caplin.datasource.messaging.json.JsonChannelMessage
Returns the object JSON deserialized into a class of type which is passed in as jsonType
getJsonObject() - Method in interface com.caplin.datasource.messaging.json.JsonMessage
Gets the JSON object
getKeys() - Method in interface com.caplin.datasource.interfaces.DSData
Deprecated.
use elements() or iterator().
getLabel() - Method in interface com.caplin.datasource.Peer
Gets the label of this peer.
getLastUpdateTime(String) - Method in interface com.caplin.jtm.DataCache
Gets the time the last update was received by the Transformer core for the specified object name.
getLimit() - Method in class com.caplin.jtm.persistence.QueryParams
 
getLogDirectory() - Method in interface com.caplin.jtm.TransformerAccessor
Gets the logging directory configured for the Transformer
getLogger() - Method in interface com.caplin.jtm.TransformerAccessor
Returns the Logger that should be used with this module
getLoggingId() - Method in interface com.caplin.datasource.Peer
 
getMapping() - Method in interface com.caplin.datasource.messaging.mapping.MappingMessage
Gets the mapped-to subject for the message.
getMessage() - Method in interface com.caplin.datasource.interfaces.DSStatus
Gets the message for this status message.
getMessage() - Method in interface com.caplin.datasource.StatusEvent
Gets the subject status message.
getMessageFactory() - Method in interface com.caplin.datasource.publisher.Publisher
Gets the MessageFactory used to create the messages that are published via this Publisher.
getMessageQueueSize() - Method in interface com.caplin.datasource.Peer
Gets the current number of queued messages on the peer.
getMessages() - Method in interface com.caplin.datasource.messaging.record.WrapperMessage
Returns the list of messages in the order they were added.
getMessageType() - Method in interface com.caplin.datasource.messaging.Message
Gets the type for this message.
getName() - Method in interface com.caplin.datasource.fields.FieldInfo
 
getName() - Method in class com.caplin.datasource.fields.FieldInfoImpl
 
getName() - Method in interface com.caplin.datasource.messaging.Field
Gets the field name.
getName() - Method in interface com.caplin.datasource.Peer
Gets the name of this peer.
getName() - Method in class com.caplin.jtm.TransformerModuleVersion
 
getNamespace() - Method in interface com.caplin.datasource.subscription.BroadcastSubscription
Gets the namespace for this subscription.
getNativeType() - Method in enum class com.caplin.jtm.pipeline.PipelineType
Get the index of the type in the native pipeline type enumeration
getNewsDateTime() - Method in interface com.caplin.datasource.messaging.news.NewsMessage
Gets the date and time that the headline was created.
getNumber() - Method in interface com.caplin.datasource.fields.FieldInfo
 
getNumber() - Method in class com.caplin.datasource.fields.FieldInfoImpl
 
getNumber() - Method in interface com.caplin.datasource.messaging.Field
Gets the field number.
getObjectNames(String) - Method in interface com.caplin.jtm.DataCache
Gets an array of object names that were found in the Transformer core cache that match the specified object name pattern.
getObjectType(String) - Method in interface com.caplin.jtm.DataCache
Gets the type code for the object with the specified name from the Transformer core cache.
getOperations() - Method in interface com.caplin.datasource.messaging.container.ContainerMessage
Gets a list of container operations.
getOrderingAsEncodedArray() - Method in class com.caplin.jtm.persistence.QueryParams
 
getPageType() - Method in interface com.caplin.datasource.messaging.page.PageMessage
Gets the type of the page.
getPeer() - Method in interface com.caplin.datasource.channel.Channel
Gets the peer that opened the channel.
getPeer() - Method in interface com.caplin.datasource.PeerStatusEvent
Gets the Peer that has changed state.
getPeer() - Method in interface com.caplin.datasource.publisher.DiscardEvent
Gets the Peer that is discarding the subject.
getPeer() - Method in interface com.caplin.datasource.publisher.RequestEvent
Gets the Peer that is requesting the subject.
getPeerStatus() - Method in interface com.caplin.datasource.Peer
Gets the status that the peer has changed state to.
getPeerStatus() - Method in interface com.caplin.datasource.PeerStatusEvent
Gets the status that the peer has changed state to.
getPermission() - Method in interface com.caplin.datasource.messaging.news.NewsMessage
Gets a permission string relating to this news message.
getPermission(String, String) - Method in interface com.caplin.jtm.DataCache
Gets the permission data cached within the Transformer core for the specified object name and key.
getPermissionKey() - Method in interface com.caplin.datasource.messaging.permission.PermissionMessage
Gets the permission key.
getPermissionKeys(String) - Method in interface com.caplin.jtm.DataCache
Gets a list of permission keys that are available from the Transformer core cache for the specified object name.
getPersistence() - Method in interface com.caplin.jtm.TransformerAccessor
 
getPipelineRegistrar() - Method in interface com.caplin.jtm.TransformerAccessor
Returns an object that allows the Transformer module to register methods for availability in pipelines
getRow() - Method in interface com.caplin.datasource.messaging.page.PageElement
The row (vertical) cooordinate of the start of the updated region.
getServiceStatusForCode(int) - Static method in enum class com.caplin.datasource.SubjectStatus
Gets the ServiceStatus for the specified code.
getStatus() - Method in interface com.caplin.datasource.StatusEvent
Gets the status of the subject.
getStatus(String) - Method in interface com.caplin.jtm.DataCache
Gets the current status for the object with the specified name from the Transformer core cache.
getStoryReference() - Method in interface com.caplin.datasource.messaging.news.NewsMessage
Gets a reference that identifies the story associated with the headline.
getSubject() - Method in interface com.caplin.datasource.channel.Channel
Gets the subject of this channel.
getSubject() - Method in interface com.caplin.datasource.channel.JsonChannel
Returns the subject name to which the channel relates.
getSubject() - Method in interface com.caplin.datasource.interfaces.DSData
Gets this object's subject.
getSubject() - Method in interface com.caplin.datasource.interfaces.DSNoData
Deprecated.
Gets this object's subject.
getSubject() - Method in interface com.caplin.datasource.interfaces.DSStatus
Gets this object's subject.
getSubject() - Method in interface com.caplin.datasource.messaging.mapping.MappingMessage
 
getSubject() - Method in interface com.caplin.datasource.messaging.Message
Gets the subject of this message.
getSubject() - Method in interface com.caplin.datasource.publisher.DiscardEvent
Gets the subject that is being discarded.
getSubject() - Method in interface com.caplin.datasource.publisher.RequestEvent
Gets the subject that is being requested.
getSubject() - Method in interface com.caplin.datasource.SubjectErrorEvent
Gets the subject of the subscription relating to the SubjectErrorEvent.
getSubject() - Method in interface com.caplin.datasource.SubjectStatusEvent
Gets the subject that this SubjectStatusEvent relates to.
getSubject() - Method in interface com.caplin.datasource.subscription.ActiveSubscription
Gets the subject for this subscription.
getSubscriptionListener() - Method in interface com.caplin.datasource.subscription.Subscription
Gets the subscription listener for this subscription.
getTags() - Method in interface com.caplin.datasource.messaging.news.NewsMessage
Gets a reference to the set of keywords or terms that describe the news item.
getText() - Method in interface com.caplin.datasource.messaging.page.PageElement
Gets the updated text for the region of the Page.
getText() - Method in interface com.caplin.datasource.messaging.story.StoryMessage
Gets the text of the news story.
getType() - Method in interface com.caplin.datasource.interfaces.DSData
Gets this object's type.
getType() - Method in interface com.caplin.datasource.messaging.container.ContainerOperation
Gets the type of the container operation, which can be an add, remove, insert or remove with prefix.
getType2(String, String) - Method in interface com.caplin.jtm.DataCache
Gets the type 2 data cached within the Transformer core for the specified object name and type 2 index.
getType2Index() - Method in interface com.caplin.datasource.messaging.record.RecordType2Message
Retrieves the Type2 index value.
getType2IndexField() - Method in interface com.caplin.datasource.messaging.record.RecordType2Message
Retrieves the fieldname that is used for the Type2 index.
getType2Indices(String) - Method in interface com.caplin.jtm.DataCache
Gets a list of type 2 indices that are available from the Transformer core cache for the specified object name.
getType3Field(String, int) - Method in interface com.caplin.jtm.DataCache
Gets an array of values for the specified object name and type 3 field number.
getType3Field(String, String) - Method in interface com.caplin.jtm.DataCache
Gets an array of values for the specified object name and type 3 field name.
getUDPAccessor() - Method in interface com.caplin.jtm.TransformerAccessor
Returns an object that allows the Transformer module to access the Transformer core's UDP command interface.
getUpdatedElements() - Method in interface com.caplin.datasource.messaging.page.PageMessage
Gets a read-only list of the updated page elements.
getValue() - Method in interface com.caplin.datasource.interfaces.DSField
Gets the value for the field.
getValue() - Method in interface com.caplin.datasource.messaging.Field
Gets the field value.
getValues() - Method in interface com.caplin.datasource.interfaces.DSData
Deprecated.
use elements() or iterator().
getVersion() - Method in class com.caplin.jtm.TransformerModuleVersion
 
getWidth() - Method in interface com.caplin.datasource.messaging.page.PageMessage
Gets the width of the page, in text columns.
A B C D E F G H I J L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form