com.tibco.as.space

Class KeyDef

java.lang.Object

com.tibco.as.space.KeyDef

public abstract class KeyDef
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
KeyDef()

Method Summary

Modifier and Type	Method and Description
static KeyDef	create()
abstract java.util.Collection<java.lang.String>	getFieldNames() Returns a collection of field names that make up the index in the order provided
abstract IndexDef.IndexType	getIndexType() Returns index type
abstract KeyDef	setFieldNames(java.lang.String... fieldNames) List of the names of the fields that make up the index
abstract KeyDef	setIndexType(IndexDef.IndexType indexType) Set index type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyDef

public KeyDef()

Method Detail

create

public static KeyDef create()

setIndexType

public abstract KeyDef setIndexType(IndexDef.IndexType indexType)

Set index type

Parameters:

indexType - Index type to be used

Returns:

KeyDef key index definition

getIndexType

public abstract IndexDef.IndexType getIndexType()

Returns index type

Returns:

IndexType index type used

getFieldNames

public abstract java.util.Collection<java.lang.String> getFieldNames()

Returns a collection of field names that make up the index in the order provided

Returns:

collection of field names that make up the index in the order provided

setFieldNames

public abstract KeyDef setFieldNames(java.lang.String... fieldNames)

List of the names of the fields that make up the index

Parameters:

fieldNames - List of the names of the fields that make up the index