com.scaleoutsoftware.soss.client.da

Interface StateServerKeyAdapter

public interface StateServerKeyAdapter

An adapter accepted by the StateServerKey.StateServerKey(StateServerKeyAdapter) constructor to supply the information needed to create a new StateServerKey instance when other constructors are inappropriate.

Method Summary

Modifier and Type	Method and Description
int	getAppId() The translated application ID in which the generated StateServerKey will live.
java.lang.String	getAppName() The name of the application namespace in which the generated StateServerKey will live.
java.lang.String	getDisplayString() The string to be used when the generated key is displayed via StateServerKey.toString().
java.io.InputStream	getKeyByteStream() Returns an InputStream from which the bytes corresponding to the StateServerKey are read.
int	getRegisteredAccessorFactoryId() The ID of the factory registered for creating an appropriate DataAccessor subclass when this key is presented to DataAccessor.createDataAccessor(com.scaleoutsoftware.soss.client.da.StateServerKey, boolean).
boolean	hasKeyString() Checks if the key has a keystring associated with it
boolean	isChunkObject() Checks if the key is for MapReduce/ConcurrentMap chunk object.
boolean	useKeyHashing() Checks if the key should be hashed do determine the partition, or the partition is explicitly defined in the key.

Method Detail

getAppName

java.lang.String getAppName()

The name of the application namespace in which the generated StateServerKey will live. If this method returns null, the value returned from getAppId() will be used instead.

Returns:

the name of the application namespace in which the generated StateServerKey will live.

getAppId

int getAppId()

The translated application ID in which the generated StateServerKey will live.

This value is the result of translating an application name to an ID via StateServerKey.appNameToId(String, boolean).

This method is consulted by StateServerKey.StateServerKey(StateServerKeyAdapter) only if getAppName() returns null.

Returns:

the translated application ID in which the generated StateServerKey will live.

getKeyByteStream

java.io.InputStream getKeyByteStream()

Returns an InputStream from which the bytes corresponding to the StateServerKey are read.

Returns:

the stream from which the bytes in the key are read.

getDisplayString

java.lang.String getDisplayString()

The string to be used when the generated key is displayed via StateServerKey.toString(). If this method returns null, StateServerKey.toString() will display the contents of the key as a sequence of hex bytes.

Returns:

the string to be used when the generated key is displayed via StateServerKey.toString()

getRegisteredAccessorFactoryId

int getRegisteredAccessorFactoryId()

The ID of the factory registered for creating an appropriate DataAccessor subclass when this key is presented to DataAccessor.createDataAccessor(com.scaleoutsoftware.soss.client.da.StateServerKey, boolean).

This facility is not currently implemented. StateServerKeyAdapter implementors should return 0.

Returns:

currently, 0.

hasKeyString

boolean hasKeyString()

Checks if the key has a keystring associated with it

Returns:

hasKeyString boolean

useKeyHashing

boolean useKeyHashing()

Checks if the key should be hashed do determine the partition, or the partition is explicitly defined in the key.

Returns:

true if the key is hashed.

isChunkObject

boolean isChunkObject()

Checks if the key is for MapReduce/ConcurrentMap chunk object.

Returns:

true if the object is the chunk object