com.ibm.websphere.objectgrid.plugins.io.datadescriptor
Interface DataDescriptor

All Superinterfaces:

Initializable

All Known Subinterfaces:

KeyDataDescriptor, ValueDataDescriptor

public interface DataDescriptor
extends Initializable

Identifies accessible attributes that the DataSerializer.DataAttributeInflatable can retrieve. KeyDataSerializer implementations expose a KeyDataDescriptor and ValueDataSerializer implementations expose a ValueDataDescriptor.

Since:

7.1.1

Field Summary

static String

DEFAULT_PATHSEPARATOR The default path separator to use when not overridden with the setPathSeparator(String) method.

Method Summary

Map<String,Attribute>	getAttributes() Retrieve all Attributes defined for this DataDescriptor.
String	getPathSeparator() Returns the string to use to use for attribute navigation for embedded attributes.er.f
void	setAttributes(Map<String,Attribute> attributes) Set the Map of attribute names to the Attribute definition.
void	setPathSeparator(String pathSeparator) The string to use to use for attribute navigation for embedded attributes.

Methods inherited from interface com.ibm.websphere.objectgrid.plugins.Initializable

initialize, isInitialized

Field Detail

DEFAULT_PATHSEPARATOR

static final String DEFAULT_PATHSEPARATOR

The default path separator to use when not overridden with the setPathSeparator(String) method.

See Also:

Constant Field Values

Method Detail

getPathSeparator

String getPathSeparator()

Returns the string to use to use for attribute navigation for embedded attributes.er.f

Returns:

the path separator string. The default is DEFAULT_PATHSEPARATOR

setPathSeparator

void setPathSeparator(String pathSeparator)

The string to use to use for attribute navigation for embedded attributes. The string must not include a valid attribute name that the DataDescriptor exposes, nor the underscore "_" character.

Parameters:

pathSeparator - the path separator string.

Throws:

IllegalStateException - if the descriptor has been initialized.

getAttributes

Map<String,Attribute> getAttributes()

Retrieve all Attributes defined for this DataDescriptor.

Returns:

a Map of attribute names to the Attribute definition. The attribute map will be read-only if the descriptor has been initialized.

setAttributes

void setAttributes(Map<String,Attribute> attributes)

Set the Map of attribute names to the Attribute definition. An attribute defines what elements are exposed to the DataSerializer.DataAttributeInflatable interface. Elements can be nested using the AttributeType.EMBEDDED attributes.

Parameters:

attributes - the Map of attribute names to the Attribute definition.

Throws:

IllegalStateException - if the descriptor has been initialized.