UimaVmMessage (UIMA-AS: uima-as 2.3.1 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.concurrent.ConcurrentHashMap<String,Object>
  - - org.apache.uima.aae.spi.transport.vm.UimaVmMessage

All Implemented Interfaces:

Serializable, ConcurrentMap<String,Object>, Map<String,Object>, UimaMessage
```
public class UimaVmMessage
extends ConcurrentHashMap<String,Object>
implements UimaMessage
```
Wrapper for the Uima message. This wrapper is used for internal messaging between collocated Uima AS service.

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

UimaVmMessage()

Constructors
Constructor and Description
`UimaVmMessage()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBooleanProperty(String aPropertyKey, boolean value)`
`void`	`addIntProperty(String aPropertyKey, int value)`
`void`	`addLongProperty(String aPropertyKey, long value)`
`void`	`addObjectProperty(String aPropertyKey, Object value)`
`void`	`addStringCargo(String aCargo)`
`void`	`addStringProperty(String aPropertyKey, String value)`
`boolean`	`containsProperty(String propertyKey)`
`boolean`	`getBooleanProperty(String aPropertyKey)`
`int`	`getIntProperty(String propertyKey)`
`long`	`getLongProperty(String propertyKey)`
`Object`	`getObjectProperty(String aPropertyKey)`
`String`	`getStringCargo()`
`String`	`getStringProperty(String propertyKey)`
`MessageContext`	`toMessageContext(String anEndpointName)`
`String`	`toString()`

Methods inherited from class java.util.concurrent.ConcurrentHashMap
clear, contains, containsKey, containsValue, elements, entrySet, get, isEmpty, keys, keySet, put, putAll, putIfAbsent, remove, remove, replace, replace, size, values

Methods inherited from class java.util.AbstractMap
clone, equals, hashCode

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
equals, hashCode

Constructor Detail
- UimaVmMessage
```
public UimaVmMessage()
```

Method Detail

addIntProperty

public void addIntProperty(String aPropertyKey,
                  int value)

Specified by:: addIntProperty in interface UimaMessage

addLongProperty

public void addLongProperty(String aPropertyKey,
                   long value)

Specified by:: addLongProperty in interface UimaMessage

addStringProperty

public void addStringProperty(String aPropertyKey,
                     String value)

Specified by:: addStringProperty in interface UimaMessage

containsProperty
```
public boolean containsProperty(String propertyKey)
```
Specified by:

containsProperty in interface UimaMessage

getIntProperty
```
public int getIntProperty(String propertyKey)
```
Specified by:

getIntProperty in interface UimaMessage

getStringProperty
```
public String getStringProperty(String propertyKey)
```
Specified by:

getStringProperty in interface UimaMessage

addStringCargo
```
public void addStringCargo(String aCargo)
```
Specified by:

addStringCargo in interface UimaMessage

getStringCargo
```
public String getStringCargo()
```
Specified by:

getStringCargo in interface UimaMessage

toMessageContext

public MessageContext toMessageContext(String anEndpointName)
                                throws AsynchAEException

Specified by:: toMessageContext in interface UimaMessage
Throws:: AsynchAEException

getLongProperty
```
public long getLongProperty(String propertyKey)
```
Specified by:

getLongProperty in interface UimaMessage

addBooleanProperty

public void addBooleanProperty(String aPropertyKey,
                      boolean value)

Specified by:: addBooleanProperty in interface UimaMessage

getBooleanProperty
```
public boolean getBooleanProperty(String aPropertyKey)
```
Specified by:

getBooleanProperty in interface UimaMessage

toString
```
public String toString()
```
Overrides:

toString in class AbstractMap<String,Object>

addObjectProperty

public void addObjectProperty(String aPropertyKey,
                     Object value)

Specified by:: addObjectProperty in interface UimaMessage

getObjectProperty
```
public Object getObjectProperty(String aPropertyKey)
```
Specified by:

getObjectProperty in interface UimaMessage

Class UimaVmMessage

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.util.concurrent.ConcurrentHashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

UimaVmMessage

Method Detail

addIntProperty

addLongProperty

addStringProperty

containsProperty

getIntProperty

getStringProperty

addStringCargo

getStringCargo

toMessageContext

getLongProperty

addBooleanProperty

getBooleanProperty

toString

addObjectProperty

getObjectProperty