bucket.search.persistence
Class IndexQueueEntry

java.lang.Object
  bucket.search.persistence.IndexQueueEntry

All Implemented Interfaces:

java.lang.Cloneable

public class IndexQueueEntry
extends java.lang.Object
implements java.lang.Cloneable

An entry in the index queue that represents an indexing task that needs to be performed. The currently supported tasks are: a) add b) delete This entry element contains enough information to uniquely identify the searchable object that it works on.

Field Summary

static int	ADD
static int	DELETE
static int	UPDATE

Constructor Summary

IndexQueueEntry()

IndexQueueEntry(int type)

IndexQueueEntry(int type, java.lang.String handle)

IndexQueueEntry(int type, java.lang.String handle, java.util.Date creationDate)

Method Summary

java.lang.Object	clone()
boolean	equals(java.lang.Object o)
java.util.Date	getCreationDate() The date at which this index entry was created.
java.lang.String	getHandle() A readable description of the object represented by this index queue entry.
long	getId() The unique id of this index queue entry in the database.
int	getType() The type of indexing action represented by this index queue entry.
java.lang.String	getTypeAsString()
int	hashCode()
void	setCreationDate(java.util.Date creationDate)
void	setHandle(java.lang.String handle)
void	setId(long id)
void	setType(int type)
java.lang.String	toString() A simple tostring implementation that returns the data contained by this queue entry.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ADD

public static final int ADD

See Also:

Constant Field Values

DELETE

public static final int DELETE

See Also:

Constant Field Values

UPDATE

public static final int UPDATE

See Also:

Constant Field Values

Constructor Detail

IndexQueueEntry

public IndexQueueEntry()

IndexQueueEntry

public IndexQueueEntry(int type)

IndexQueueEntry

public IndexQueueEntry(int type,
                       java.lang.String handle)

IndexQueueEntry

public IndexQueueEntry(int type,
                       java.lang.String handle,
                       java.util.Date creationDate)

Method Detail

getId

public long getId()

The unique id of this index queue entry in the database.

setId

public void setId(long id)

getType

public int getType()

The type of indexing action represented by this index queue entry.

See Also:

ADD, DELETE

setType

public void setType(int type)

getCreationDate

public java.util.Date getCreationDate()

The date at which this index entry was created.

setCreationDate

public void setCreationDate(java.util.Date creationDate)

getHandle

public java.lang.String getHandle()

A readable description of the object represented by this index queue entry. The description will be used to provide meaningful feedback to the user.

setHandle

public void setHandle(java.lang.String handle)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getTypeAsString

public java.lang.String getTypeAsString()

toString

public java.lang.String toString()

A simple tostring implementation that returns the data contained by this queue entry.

Overrides:

toString in class java.lang.Object

Returns:

a debug string.