Mobios v0.91

mobios.type
Class IndexObject

java.lang.Object
  extended by mobios.type.IndexObject
All Implemented Interfaces:
Externalizable, Serializable, Comparable<IndexObject>
Direct Known Subclasses:
DoubleVector, Fragment, Image

public abstract class IndexObject
extends Object
implements Externalizable, Comparable<IndexObject>

Author:
Willard
See Also:
Serialized Form

Constructor Summary
IndexObject()
           
IndexObject(int rowID)
           
 
Method Summary
abstract  int compareTo(IndexObject oThat)
           
abstract  IndexObject[] expand()
          This method is necessary to implement bucketing, so that similar objects are only stored once in the database.
 int getRowID()
           
 void readExternal(ObjectInput in)
           
 void setRowID(int rowID)
           
 void setRowIDLength(int length)
           
abstract  int size()
           
abstract  String toString()
          all implementing classes are required to override toString
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IndexObject

public IndexObject()

IndexObject

public IndexObject(int rowID)
Method Detail

setRowID

public void setRowID(int rowID)

getRowID

public int getRowID()

setRowIDLength

public void setRowIDLength(int length)

toString

public abstract String toString()
all implementing classes are required to override toString

Overrides:
toString in class Object

size

public abstract int size()
Returns:
the size of the object

expand

public abstract IndexObject[] expand()
This method is necessary to implement bucketing, so that similar objects are only stored once in the database. If you do not want to implement bucketing for your object, you can just return an array of length one containing this object.

Returns:
an array of IndexObjects

compareTo

public abstract int compareTo(IndexObject oThat)
Specified by:
compareTo in interface Comparable<IndexObject>
Parameters:
oThat -
Returns:

writeExternal

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

readExternal

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

Mobios v0.91

(C) 2002 - 2006 The MoBIoS Group