wt.index
Class IndexerHelper

java.lang.Object
  wt.index.IndexerHelper

All Implemented Interfaces:

Externalizable, Serializable

public class IndexerHelper

extends Object

implements Externalizable

The IndexerHelper class provides a means to manipulate the set of indexers contained in a Indexable object.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Constructor Summary

IndexerHelper()

Method Summary

static boolean	addIndexer(Indexable obj, String indexer) Adds an indexer to the indexer list associated with the Indexable object.
static void	addIndexers(Indexable obj, IndexerSet indexers) Adds the indexers contained in an IndexerSet object to the indexer set of an Indexable object.
static boolean	contains(Indexable obj, String indexer) Determines if an indexer belongs to an indexable object.
static IndexerSet	getIndexers(Indexable obj) Returns the IndexerSet associated with an Indexable object.
static Enumeration	indexers(Indexable obj) Returns the list of objects associated with the object.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(IndexerHelper thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
static boolean	removeIndexer(Indexable obj, String indexer) Removes a given indexer from the indexer list associated with the object.
static void	setIndexers(Indexable obj, IndexerSet indexers) Associates an indexer list with an Indexable object.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

IndexerHelper

public IndexerHelper()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(IndexerHelper thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

contains

public static boolean contains(Indexable obj,
                               String indexer)

Determines if an indexer belongs to an indexable object.

Supported API: false

Parameters:

obj -

indexer -

Returns:

boolean

indexers

public static Enumeration indexers(Indexable obj)

Returns the list of objects associated with the object.

Supported API: false

Parameters:

obj -

Returns:

Enumeration

removeIndexer

public static boolean removeIndexer(Indexable obj,
                                    String indexer)

Removes a given indexer from the indexer list associated with the object.

Supported API: false

Parameters:

obj -

indexer -

Returns:

boolean

addIndexer

public static boolean addIndexer(Indexable obj,
                                 String indexer)

Adds an indexer to the indexer list associated with the Indexable object.

Supported API: false

Parameters:

obj -

indexer -

Returns:

boolean

setIndexers

public static void setIndexers(Indexable obj,
                               IndexerSet indexers)
                        throws WTException

Associates an indexer list with an Indexable object.

Supported API: false

Parameters:

obj -

indexers -

Throws:

WTException

addIndexers

public static void addIndexers(Indexable obj,
                               IndexerSet indexers)
                        throws WTException

Adds the indexers contained in an IndexerSet object to the indexer set of an Indexable object.

Supported API: false

Parameters:

obj -

indexers -

Throws:

WTException

getIndexers

public static IndexerSet getIndexers(Indexable obj)

Returns the IndexerSet associated with an Indexable object.

Supported API: false

Parameters:

obj -

Returns:

IndexerSet