org.sixdml.dbmanagement
Class SixdmlIndexType

java.lang.Object
  |
  +--org.sixdml.dbmanagement.SixdmlIndexType

public final class SixdmlIndexType

extends Object

 Class is used by SixdmlIndex to represent types of indexes. 
 

Field Summary

static SixdmlIndexType	STRUCTURE_INDEX Represents a structure index.
static SixdmlIndexType	TEXT_INDEX Represents a text index.
private String	type This is the name of the index type.
static SixdmlIndexType	VALUE_INDEX Represents a value index.

Constructor Summary

private	SixdmlIndexType() Constructor private, so cannot be instantiated by other objects.
private	SixdmlIndexType(String type) Constructor private, so cannot be instantiated by other objects.

Method Summary

static SixdmlIndexType	createIndexType(String indexType) Factory method creates instances of this class.
String	toString() Returns the type of the index as a string.

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_INDEX

public static SixdmlIndexType VALUE_INDEX

Represents a value index.

TEXT_INDEX

public static SixdmlIndexType TEXT_INDEX

Represents a text index.

STRUCTURE_INDEX

public static SixdmlIndexType STRUCTURE_INDEX

Represents a structure index.

type

private String type

This is the name of the index type.

Constructor Detail

SixdmlIndexType

private SixdmlIndexType()

Constructor private, so cannot be instantiated by other objects.

SixdmlIndexType

private SixdmlIndexType(String type)

Constructor private, so cannot be instantiated by other objects.

Parameters:

type - the type of index.

Method Detail

toString

public String toString()

Returns the type of the index as a string.

Overrides:

toString in class Object

Returns:

the type of the index as a string.

createIndexType

public static SixdmlIndexType createIndexType(String indexType)
                                       throws UnsupportedIndexTypeException

Factory method creates instances of this class.

Parameters:

indexType - the type of index to create.

Returns:

a SixdmlIndexType instance

Throws:

UnsupportedIndexTypeException - if the index type is unknown.