Package org.ctan.site.services.search.base

Class IndexingSession

java.lang.Object

org.ctan.site.services.search.base.IndexingBase

org.ctan.site.services.search.base.IndexingSession

All Implemented Interfaces:

Closeable, AutoCloseable

public class IndexingSession
extends IndexingBase
implements Closeable

The class IndexingSession contains the session which combines various update operations on the search indices.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndexingSession.IndexArgs	The class IndexArgs contains the transport object for passing in indexing arguments.

Constructor Summary

Constructors

Constructor	Description
IndexingSession(@NonNull File indexBase)	This is the constructor for IndexingSession.

Method Summary

Modifier and Type	Method	Description
void	close()
void	remove(@NotNull IndexType indexType, @NotNull String indexPath, @NotNull String locale)	The method remove provides means to remove an item from the search index.
void	updateIndex(@NotNull String path, @NotNull IndexingSession.IndexArgs args)	The method updateIndex provides means to update the search index.

Methods inherited from class org.ctan.site.services.search.base.IndexingBase

checkIndexDirectory, directory, indexPath, open, open

Methods inherited from class java.lang.Object

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

Constructor Details

IndexingSession

public IndexingSession(@NonNull
 @NonNull File indexBase)
                throws FileNotFoundException

This is the constructor for IndexingSession.

Parameters:

indexBase - the base directory

Throws:

FileNotFoundException - in case of an improper directory

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

See Also:

• Closeable.close()

remove

public void remove(@NotNull
 @NotNull IndexType indexType,
 @NotNull
 @NotNull String indexPath,
 @NotNull
 @NotNull String locale)
            throws IOException

The method remove provides means to remove an item from the search index.

Parameters:

indexType - the index type

indexPath - the key for identifying the indexed item

locale - the locale

Throws:

IOException - in case of an I/O error

updateIndex

public void updateIndex(@NotNull
 @NotNull String path,
 @NotNull
 @NotNull IndexingSession.IndexArgs args)
                 throws IOException

The method updateIndex provides means to update the search index.

Parameters:

path - the URL of the item

args - the arguments

Throws:

IOException - in case of an I/O error