com.tibco.as.space

Class IndexDef

java.lang.Object

com.tibco.as.space.IndexDef

public abstract class IndexDef
extends java.lang.Object

Representation of the Index Definition

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexDef.IndexType

Constructor Summary

Constructors

Constructor and Description
IndexDef()

Method Summary

Modifier and Type	Method and Description
static IndexDef	create(java.lang.String indexName)
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()
abstract java.lang.String	getName() Returns the name of the index
abstract IndexDef	setFieldNames(java.lang.String... fieldNames) List of the names of the fields that make up the index
abstract IndexDef	setIndexType(IndexDef.IndexType indexType)
abstract IndexDef	setName(java.lang.String name) Sets the index name

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexDef

public IndexDef()

Method Detail

create

public static IndexDef create(java.lang.String indexName)

setName

public abstract IndexDef setName(java.lang.String name)

Sets the index name

Parameters:

name - The name of the index

getName

public abstract java.lang.String getName()

Returns the name of the index

Returns:

The name of the index

setIndexType

public abstract IndexDef setIndexType(IndexDef.IndexType indexType)

getIndexType

public abstract IndexDef.IndexType getIndexType()

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 IndexDef 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