com.goldencode.p2j.persist.orm

Class IndexState

java.lang.Object

com.goldencode.p2j.persist.orm.IndexState

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public final class IndexState
extends java.lang.Object
implements java.io.Externalizable

An object which tracks which indices have been updated for a newly created database record, before it is first flushed to the database.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.BitSet	nonunique Map of non-unique indices which need to be updated
private int	primaryUid UID of primary index, if any (0 if none)
private java.util.BitSet	unique Map of unique indices which need to be updated

Constructor Summary

Constructors

Constructor and Description
IndexState() Default constructor
IndexState(int ulen, int nlen, int primaryUid) Constructor.

Method Summary

Modifier and Type	Method and Description
private java.util.BitSet	bitSetFromUid(int idxUid) Get the bit set upon which to operate, based on the value of the given index UID.
(package private) void	clear(int idxUid) Mark an index as having been updated by clearing its corresponding bit in the appropriate bit set.
(package private) void	clearAll() Clear all bits in both the unique and non-unique index bit sets.
boolean	get(int idxUid) Get the state of the index with the given index UID.
(package private) java.util.BitSet	getBitSet(boolean isUnique) Get the bit set associated with either the unique or non-unique indices.
boolean	getPrimary() Get the index identifier of the primary index, if any.
boolean	isEmpty() Indicate whether there are no indices remaining to be updated.
private int	offsetFromUid(int idxUid) Get the bit offset on which to operate, based on the value of the given index UID.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
void	set(int idxUid, boolean value) Mark an index as needing to be updated.
(package private) void	setAll(int ulen, int nlen) Set all bits in both the unique and non-unique index bit sets.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class java.lang.Object

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

Field Detail

unique

private java.util.BitSet unique

Map of unique indices which need to be updated

nonunique

private java.util.BitSet nonunique

Map of non-unique indices which need to be updated

primaryUid

private int primaryUid

UID of primary index, if any (0 if none)

Constructor Detail

IndexState

public IndexState()

Default constructor

IndexState

public IndexState(int ulen,
                  int nlen,
                  int primaryUid)

Constructor.

Parameters:

ulen - Number of unique indices. May be 0, but not negative.

nlen - Number of non-unique indices. May be 0, but not negative.

primaryUid - Optional UID of the primary index, if any. Must be set to 0 if there is no primary index.

Method Detail

get

public boolean get(int idxUid)

Get the state of the index with the given index UID.

Parameters:

idxUid - UID of the desired index.

Returns:

true if the index has not yet been updated; false if it has been updated.

set

public void set(int idxUid,
                boolean value)

Mark an index as needing to be updated.

Parameters:

idxUid - Identifier of a unique (positive value) or non-unique (negative value) index.

value - new value

clear

void clear(int idxUid)

Mark an index as having been updated by clearing its corresponding bit in the appropriate bit set.

Parameters:

idxUid - Identifier of a unique (positive value) or non-unique (negative value) index.

isEmpty

public boolean isEmpty()

Indicate whether there are no indices remaining to be updated.

Returns:

true if there are no indices left to be updated, else false. true will naturally be reported for a table with no indices.

getPrimary

public boolean getPrimary()

Get the index identifier of the primary index, if any.

Returns:

Primary index UID.

setAll

void setAll(int ulen,
            int nlen)

Set all bits in both the unique and non-unique index bit sets.

Parameters:

ulen - Number of unique indices. May be 0, but not negative.

nlen - Number of non-unique indices. May be 0, but not negative.

clearAll

void clearAll()

Clear all bits in both the unique and non-unique index bit sets.

getBitSet

java.util.BitSet getBitSet(boolean isUnique)

Get the bit set associated with either the unique or non-unique indices.

Parameters:

isUnique - true to get the unique index bit set; false to get the non-unique index bit set.

Returns:

Index bit set as described above.

bitSetFromUid

private java.util.BitSet bitSetFromUid(int idxUid)

Get the bit set upon which to operate, based on the value of the given index UID. A positive UID returns the unique index bit set; a negative UID returns the non-unique index bit set.

Parameters:

idxUid - A positive or negative index UID. A value of 0 is considered invalid.

Returns:

The bit set representing the array of unique or non-unique indices, as described above.

offsetFromUid

private int offsetFromUid(int idxUid)

Get the bit offset on which to operate, based on the value of the given index UID.

Parameters:

idxUid - A positive or negative index UID. A value of 0 is considered invalid.

Returns:

The bit offset associated with the UID.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - Input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.