org.openmobileis.database.fastobjectdb
Class FODBIndexDescriptor

java.lang.Object
  extended byorg.openmobileis.database.fastobjectdb.FODBIndexDescriptor
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
FODBIntIndexDescriptor, FODBLongIndexDescriptor, FODBStringIndexDescriptor

public abstract class FODBIndexDescriptor
extends java.lang.Object
implements java.io.Externalizable

Use to describe collection index properties. FODB create index by using the FODBIndexDescriptor provided. Name : define the collection to attach the index memberName : define the field or method of the collection object that has to be indexed type : define the index type : UNIQUE or MULTIPLE order : define the order of the Btree index. By default use 15 for collection of Thousand object. For greater collection increase the order.

See Also:
Serialized Form

Field Summary
static int MULTIPLE
           
static int UNIQUE
           
 
Constructor Summary
FODBIndexDescriptor()
           
FODBIndexDescriptor(java.lang.String newName, int indexType, java.lang.String newMemberName, int btreeorder)
           
 
Method Summary
 java.lang.String getMemberName()
           
 java.lang.String getName()
           
 int getOrder()
           
 int getType()
           
 boolean isMultiple()
           
 boolean isUnique()
           
 void readExternal(java.io.ObjectInput in)
           
 void setMemberName(java.lang.String memberName)
           
 void setType(int type)
           
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UNIQUE

public static final int UNIQUE
See Also:
Constant Field Values

MULTIPLE

public static final int MULTIPLE
See Also:
Constant Field Values
Constructor Detail

FODBIndexDescriptor

public FODBIndexDescriptor()

FODBIndexDescriptor

public FODBIndexDescriptor(java.lang.String newName,
                           int indexType,
                           java.lang.String newMemberName,
                           int btreeorder)
Method Detail

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException

getName

public java.lang.String getName()

getMemberName

public java.lang.String getMemberName()

setMemberName

public void setMemberName(java.lang.String memberName)

getType

public int getType()

setType

public void setType(int type)

isUnique

public boolean isUnique()

isMultiple

public boolean isMultiple()

getOrder

public int getOrder()


Copyright 2006 OpenMobileIS. All Rights Reserved.