Groupdocs API References – com.groupdocs.search

Java: Action

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.search.common.Delegate, com.groupdocs.search.common.MulticastDelegate

public abstract class Action extends MulticastDelegate

Encapsulates a method that has no parameters and does not return a value.

Constructors

Constructor	Description
Action()

Methods

Method	Description
invoke()	The method to be invoked.

Action()

public Action()

invoke()

public abstract void invoke()

The method to be invoked.

Java: Action1

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.search.common.Delegate, com.groupdocs.search.common.MulticastDelegate

public abstract class Action1<T> extends MulticastDelegate

Encapsulates a method that has a single parameter and does not return a value.

Constructors

Constructor	Description
Action1()

Methods

Method	Description
invoke(T arg)	The method to be invoked.

Action1()

public Action1()

invoke(T arg)

public abstract void invoke(T arg)

The method to be invoked.

Parameters:

Parameter	Type	Description
arg	T	The parameter.

Java: Action2

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.search.common.Delegate, com.groupdocs.search.common.MulticastDelegate

public abstract class Action2<T1,T2> extends MulticastDelegate

Encapsulates a method that has two parameters and does not return a value.

Constructors

Constructor	Description
Action2()

Methods

Method	Description
invoke(T1 arg1, T2 arg2)	The method to be invoked.

Action2()

public Action2()

invoke(T1 arg1, T2 arg2)

public abstract void invoke(T1 arg1, T2 arg2)

The method to be invoked.

Parameters:

Parameter	Type	Description
arg1	T1	The first parameter.
arg2	T2	The second parameter.

Java: Document

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public abstract class Document

Represents the base class for documents added to an index from file system, stream, or structure. Contains static methods for creating documents from different types of sources.

Learn more

Indexing from different sources

Methods

Method	Description
getDocumentSourceKind()	Gets the document source kind.
getDocumentKey()	Gets the document key that is used to identify the document within an index.
isLazy()	Gets a value indicating whether the document is loaded as needed or not.
getModificationDate()	Gets the last modification date of the document.
getExtension()	Gets the extension used for this document type.
getAdditionalFields()	Gets the additional fields for the document.
setAdditionalFields(DocumentField[] value)	Sets the additional fields for the document.
getAttributes()	Gets the attributes of the document.
setAttributes(String[] value)	Sets the attributes of the document.
createFromFile(String filePath)	Creates a document from a file.
createFromStream(String documentKey, Date modificationDate, String extension, InputStream stream)	Creates a document from a stream.
createFromStructure(String documentKey, Date modificationDate, DocumentField[] fields)	Creates a document from a structure that is an array of text fields.
createLazy(DocumentSourceKind documentSourceKind, String documentKey, IDocumentLoader documentLoader)	Creates a lazy-loaded document.
toString()	Returns a java.lang.String that represents the current Document .

getDocumentSourceKind()

public abstract DocumentSourceKind getDocumentSourceKind()

Gets the document source kind.

Returns: DocumentSourceKind - The document source kind.

getDocumentKey()

public abstract String getDocumentKey()

Gets the document key that is used to identify the document within an index.

Returns: java.lang.String - The document key that is used to identify the document within an index.

isLazy()

public abstract boolean isLazy()

Gets a value indicating whether the document is loaded as needed or not.

Returns: boolean - A value indicating whether the document is loaded as needed or not.

getModificationDate()

public abstract Date getModificationDate()

Gets the last modification date of the document.

Returns: java.util.Date - The last modification date of the document.

getExtension()

public abstract String getExtension()

Gets the extension used for this document type.

Returns: java.lang.String - The extension used for this document type.

getAdditionalFields()

public DocumentField[] getAdditionalFields()

Gets the additional fields for the document.

Returns: com.groupdocs.search.common.DocumentField[] - The additional fields for the document.

setAdditionalFields(DocumentField[] value)

public void setAdditionalFields(DocumentField[] value)

Sets the additional fields for the document.

Parameters:

Parameter	Type	Description
value	DocumentField[]	The additional fields for the document.

getAttributes()

public String[] getAttributes()

Gets the attributes of the document.

Returns: java.lang.String[] - The attributes of the document.

setAttributes(String[] value)

public void setAttributes(String[] value)

Sets the attributes of the document.

Parameters:

Parameter	Type	Description
value	java.lang.String[]	The attributes of the document.

createFromFile(String filePath)

public static Document createFromFile(String filePath)

Creates a document from a file.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The document file path.

Returns: Document - The created document.

createFromStream(String documentKey, Date modificationDate, String extension, InputStream stream)

public static Document createFromStream(String documentKey, Date modificationDate, String extension, InputStream stream)

Creates a document from a stream.

Parameters:

Parameter	Type	Description
documentKey	java.lang.String	The document key.
modificationDate	java.util.Date	The document modification date.
extension	java.lang.String	The document extension.
stream	java.io.InputStream	The document stream.

Returns: Document - The created document.

createFromStructure(String documentKey, Date modificationDate, DocumentField[] fields)

public static Document createFromStructure(String documentKey, Date modificationDate, DocumentField[] fields)

Creates a document from a structure that is an array of text fields.

Parameters:

Parameter	Type	Description
documentKey	java.lang.String	The document key.
modificationDate	java.util.Date	The document modification date.
fields	DocumentField[]	The document fields.

Returns: Document - The created document.

createLazy(DocumentSourceKind documentSourceKind, String documentKey, IDocumentLoader documentLoader)

public static Document createLazy(DocumentSourceKind documentSourceKind, String documentKey, IDocumentLoader documentLoader)

Creates a lazy-loaded document.

Parameters:

Parameter	Type	Description
documentSourceKind	DocumentSourceKind	The document source kind. This value must match the kind of the loaded document.
documentKey	java.lang.String	The document key. This value must match the key of the loaded document.
documentLoader	IDocumentLoader	The document loader.

Returns: Document - The created document.

toString()

public String toString()

Returns a java.lang.String that represents the current Document .

Returns: java.lang.String - A java.lang.String that represents the current Document .

Java: DocumentFilter

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public abstract class DocumentFilter

Represents the base class for document filters. Contains methods for creation document filter instances.

Learn more

Document filtering during indexing

Constructors

Constructor	Description
DocumentFilter()

Methods

Method	Description
toString()	Returns string representation of a document filter.
createCreationTimeLowerBound(Date lowerBound)	Creates a filter for skipping documents with creation date earlier than the lower bound.
createCreationTimeUpperBound(Date upperBound)	Creates a filter for skipping documents with creation date later than the upper bound.
createCreationTimeRange(Date lowerBound, Date upperBound)	Creates a filter for skipping documents with creation date out of the specified range.
createModificationTimeLowerBound(Date lowerBound)	Creates a filter for skipping documents with modification date earlier than the lower bound.
createModificationTimeUpperBound(Date upperBound)	Creates a filter for skipping documents with modification date later than the upper bound.
createModificationTimeRange(Date lowerBound, Date upperBound)	Creates a filter for skipping documents with modification date out of the specified range.
createFilePathRegularExpression(String pattern)	Creates a filter for skipping documents that are not match a regular expression.
createFilePathRegularExpression(String pattern, int options)	Creates a filter for skipping documents that are not match a regular expression.
createFileLengthLowerBound(long lowerBound)	Creates a filter for skipping documents with the length less than the lower bound.
createFileLengthUpperBound(long upperBound)	Creates a filter for skipping documents with the length greater than the upper bound.
createFileLengthRange(long lowerBound, long upperBound)	Creates a filter for skipping documents out of the specified document length range.
createFileExtension(String[] extensions)	Creates a filter for skipping documents that do not have allowable extension.
createNot(DocumentFilter innerFilter)	Creates a filter that has inverse logic in relation to the specified inner filter.
createAnd(DocumentFilter[] filters)	Creates a logical conjunction of the specified filters.
createOr(DocumentFilter[] filters)	Creates a logical disjunction of the specified filters.

DocumentFilter()

public DocumentFilter()

toString()

public abstract String toString()

Returns string representation of a document filter.

Returns: java.lang.String - String representation of a document filter.

createCreationTimeLowerBound(Date lowerBound)

public static DocumentFilter createCreationTimeLowerBound(Date lowerBound)

Creates a filter for skipping documents with creation date earlier than the lower bound.

Parameters:

Parameter	Type	Description
lowerBound	java.util.Date	The lower bound of the document creation time.

Returns: DocumentFilter - A document filter by document creation time.

createCreationTimeUpperBound(Date upperBound)

public static DocumentFilter createCreationTimeUpperBound(Date upperBound)

Creates a filter for skipping documents with creation date later than the upper bound.

Parameters:

Parameter	Type	Description
upperBound	java.util.Date	The upper bound of the document creation time.

Returns: DocumentFilter - A document filter by document creation time.

createCreationTimeRange(Date lowerBound, Date upperBound)

public static DocumentFilter createCreationTimeRange(Date lowerBound, Date upperBound)

Creates a filter for skipping documents with creation date out of the specified range.

Parameters:

Parameter	Type	Description
lowerBound	java.util.Date	The lower bound of the document creation time.
upperBound	java.util.Date	The upper bound of the document creation time.

Returns: DocumentFilter - A document filter by document creation time.

createModificationTimeLowerBound(Date lowerBound)

public static DocumentFilter createModificationTimeLowerBound(Date lowerBound)

Creates a filter for skipping documents with modification date earlier than the lower bound.

Parameters:

Parameter	Type	Description
lowerBound	java.util.Date	The lower bound of the document modification time.

Returns: DocumentFilter - A document filter by document modification time.

createModificationTimeUpperBound(Date upperBound)

public static DocumentFilter createModificationTimeUpperBound(Date upperBound)

Creates a filter for skipping documents with modification date later than the upper bound.

Parameters:

Parameter	Type	Description
upperBound	java.util.Date	The upper bound of the document modification time.

Returns: DocumentFilter - A document filter by document modification time.

createModificationTimeRange(Date lowerBound, Date upperBound)

public static DocumentFilter createModificationTimeRange(Date lowerBound, Date upperBound)

Creates a filter for skipping documents with modification date out of the specified range.

Parameters:

Parameter	Type	Description
lowerBound	java.util.Date	The lower bound of the document modification time.
upperBound	java.util.Date	The upper bound of the document modification time.

Returns: DocumentFilter - A document filter by document modification time.

createFilePathRegularExpression(String pattern)

public static DocumentFilter createFilePathRegularExpression(String pattern)

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

Parameters:

Parameter	Type	Description
pattern	java.lang.String	The regular expression pattern.

Returns: DocumentFilter - A document filter by file name.

createFilePathRegularExpression(String pattern, int options)

public static DocumentFilter createFilePathRegularExpression(String pattern, int options)

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

Parameters:

Parameter	Type	Description
pattern	java.lang.String	The regular expression pattern.
options	int	The regular expression options.

Returns: DocumentFilter - A document filter by file name.

createFileLengthLowerBound(long lowerBound)

public static DocumentFilter createFileLengthLowerBound(long lowerBound)

Creates a filter for skipping documents with the length less than the lower bound.

Parameters:

Parameter	Type	Description
lowerBound	long	The lower bound of the document length.

Returns: DocumentFilter - A document filter by document length.

createFileLengthUpperBound(long upperBound)

public static DocumentFilter createFileLengthUpperBound(long upperBound)

Creates a filter for skipping documents with the length greater than the upper bound.

Parameters:

Parameter	Type	Description
upperBound	long	The upper bound of the document length.

Returns: DocumentFilter - A document filter by document length.

createFileLengthRange(long lowerBound, long upperBound)

public static DocumentFilter createFileLengthRange(long lowerBound, long upperBound)

Creates a filter for skipping documents out of the specified document length range.

Parameters:

Parameter	Type	Description
lowerBound	long	The lower bound of the document length.
upperBound	long	The upper bound of the document length.

Returns: DocumentFilter - A document filter by document length.

createFileExtension(String[] extensions)

public static DocumentFilter createFileExtension(String[] extensions)

Creates a filter for skipping documents that do not have allowable extension.

Parameters:

Parameter	Type	Description
extensions	java.lang.String[]	The list of allowable extensions.

Returns: DocumentFilter - A document filter by document extension.

createNot(DocumentFilter innerFilter)

public static DocumentFilter createNot(DocumentFilter innerFilter)

Creates a filter that has inverse logic in relation to the specified inner filter.

Parameters:

Parameter	Type	Description
innerFilter	DocumentFilter	The inner document filter.

Returns: DocumentFilter - An inverted document filter.

createAnd(DocumentFilter[] filters)

public static DocumentFilter createAnd(DocumentFilter[] filters)

Creates a logical conjunction of the specified filters.

Parameters:

Parameter	Type	Description
filters	DocumentFilter[]	The document filters.

Returns: DocumentFilter - A document filter that represents result of conjunction of the specified filters.

createOr(DocumentFilter[] filters)

public static DocumentFilter createOr(DocumentFilter[] filters)

Creates a logical disjunction of the specified filters.

Parameters:

Parameter	Type	Description
filters	DocumentFilter[]	The document filters.

Returns: DocumentFilter - A document filter that represents result of disjunction of the specified filters.

Java: ExtractedData

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public class ExtractedData

Represents data retrieved from a document and prepared for indexing.

Methods

Method	Description
serialize()	Serializes the current instance to a byte array.
deserialize(byte[] array)	Deserializes an instance from a byte array.

serialize()

public final byte[] serialize()

Serializes the current instance to a byte array.

Returns: byte[] - A byte array representing the current instance.

deserialize(byte[] array)

public static ExtractedData deserialize(byte[] array)

Deserializes an instance from a byte array.

Parameters:

Parameter	Type	Description
array	byte[]	A byte array to deserialize from.

Returns: ExtractedData - An instance deserialized from a byte array.

Java: Extractor

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.search.events.EventHubBase

public class Extractor extends EventHubBase

Represents a tool for preliminary data extraction from documents for separating the stage of subsequent fast indexing.

Constructors

Constructor	Description
Extractor()	Initializes a new instance of the Extractor class.

Fields

Field	Description
ErrorOccurred	Occurs when an error happens during an extractor operation.
ImagePreparing	Occurs when an image is going to be prepared for indexing.
PasswordRequired	Occurs when a document requires password for opening.

Methods

Method	Description
getSettings()	Gets the extractor settings.
extract(Document document, ExtractionOptions extractionOptions)	Extracts data from a document.
raiseErrorOccurredPublic(String message, boolean isCritical)
raiseImagePreparingPublic(String documentKey, String[] innerPath, int imageIndex, ImageFrame[] frames, InputStream stream)
raisePasswordRequiredPublic(String filePath)

Extractor()

public Extractor()

Initializes a new instance of the Extractor class.

ErrorOccurred

public final Event<EventHandler<IndexErrorEventArgs>> ErrorOccurred

Occurs when an error happens during an extractor operation.

ImagePreparing

public final Event<EventHandler<ImagePreparingEventArgs>> ImagePreparing

Occurs when an image is going to be prepared for indexing.

PasswordRequired

public final Event<EventHandler<PasswordRequiredEventArgs>> PasswordRequired

Occurs when a document requires password for opening.

getSettings()

public final ExtractorSettings getSettings()

Gets the extractor settings.

Returns: ExtractorSettings - The extractor settings.

extract(Document document, ExtractionOptions extractionOptions)

public final ExtractedData extract(Document document, ExtractionOptions extractionOptions)

Extracts data from a document.

Parameters:

Parameter	Type	Description
document	Document	The document from file system, stream or structure.
extractionOptions	ExtractionOptions	The extraction options.

Returns: ExtractedData - The extracted data of the document.

raiseErrorOccurredPublic(String message, boolean isCritical)

public final void raiseErrorOccurredPublic(String message, boolean isCritical)

Parameters:

Parameter	Type	Description
message	java.lang.String
isCritical	boolean

raiseImagePreparingPublic(String documentKey, String[] innerPath, int imageIndex, ImageFrame[] frames, InputStream stream)

public final void raiseImagePreparingPublic(String documentKey, String[] innerPath, int imageIndex, ImageFrame[] frames, InputStream stream)

Parameters:

Parameter	Type	Description
documentKey	java.lang.String
innerPath	java.lang.String[]
imageIndex	int
frames	ImageFrame[]
stream	java.io.InputStream

raisePasswordRequiredPublic(String filePath)

public final String raisePasswordRequiredPublic(String filePath)

Parameters:

Parameter	Type	Description
filePath	java.lang.String

Returns: java.lang.String

Java: Index

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

All Implemented Interfaces: java.io.Closeable

public class Index implements Closeable

Represents the main class for indexing documents and search through them.

Learn more

The example demonstrates a typical usage of the class.


 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchResult result = index.search(query); // Searching in index

Constructors

Constructor	Description
Index()	Initializes a new instance of the Index class in memory.
Index(IndexSettings settings)	Initializes a new instance of the Index class in memory with particular index settings.
Index(String indexFolder)	Initializes a new instance of the Index class.
Index(String indexFolder, IndexSettings settings)	Initializes a new instance of the Index class.
Index(String indexFolder, boolean overwriteIfExists)	Initializes a new instance of the Index class.
Index(String indexFolder, IndexSettings settings, boolean overwriteIfExists)	Initializes a new instance of the Index class.

Methods

Method	Description
getEvents()	Gets the event hub for subscribing to events.
getIndexInfo()	Gets the basic information on the index.
getRepository()	Gets the index repository object if the index is contained in it.
getIndexSettings()	Gets the index settings.
getDictionaries()	Gets the dictionary repository.
close()	Releases all resources used by the Index .
add(String path)	Performs indexing operation.
add(String path, IndexingOptions options)	Performs indexing operation.
add(String[] paths)	Performs indexing operation.
add(String[] paths, IndexingOptions options)	Performs indexing operation.
add(Document[] documents, IndexingOptions options)	Performs indexing operation.
add(ExtractedData[] data, IndexingOptions options)	Performs indexing operation.
update()	Re-indexes documents that have been changed or deleted since last update.
update(UpdateOptions options)	Re-indexes documents that have been changed or deleted since last update.
getIndexingReports()	Gets the reports on indexing operations.
getSearchReports()	Gets the reports on search operations.
search(String query)	Searches in index.
search(String query, SearchOptions options)	Searches in index.
search(SearchQuery query)	Searches in index.
search(SearchQuery query, SearchOptions options)	Searches in index.
search(SearchImage image, ImageSearchOptions options)	Performs a reverse image search in the index.
searchNext(ChunkSearchToken chunkSearchToken)	Continues the chunk search started with method Search.
searchNext(ChunkSearchToken chunkSearchToken, Cancellation cancellation)	Continues the chunk search started with method Search.
optimize()	Minimizes the number of index segments by merging them one with another.
optimize(MergeOptions options)	Minimizes the number of index segments by merging them one with another.
merge(Index index, MergeOptions options)	Merges the specified index into the current index.
merge(IndexRepository repository, MergeOptions options)	Merges indexes from the specified index repository into the current index.
highlight(FoundDocument document, Highlighter highlighter)	Generates HTML formatted text with highlighted found terms.
highlight(FoundDocument document, Highlighter highlighter, HighlightOptions options)	Generates HTML formatted text with highlighted found terms.
getIndexedDocuments()	Gets an array of all indexed documents.
getIndexedDocumentItems(DocumentInfo documentInfo)	Gets an array of a document items.
getDocumentText(DocumentInfo documentInfo, OutputAdapter adapter)	Generates the text of an indexed document and passes it through an output adapter.
getDocumentText(DocumentInfo documentInfo, OutputAdapter adapter, TextOptions options)	Generates HTML formatted text for indexed document and transfers it through the output adapter.
getIndexedPaths()	Gets an array of indexed paths - documents or folders.
delete(String[] paths, UpdateOptions options)	Deletes indexed files or folders from the index.
delete(UpdateOptions options, String[] documentKeys)	Deletes documents indexed from streams or structures.
notifyIndex(Notification notification)	Passes the specified notification object to the index to perform the notification.
changeAttributes(AttributeChangeBatch batch)	Applies the specified batch of attribute changes to indexed documents without reindexing during the update operation.
getAttributes(String path)	Gets all the attributes associated with the specified indexed document.

Index()

public Index()

Initializes a new instance of the Index class in memory.

The example demonstrates how to create index in memory without saving files to disk.


 Index index = new Index();

Index(IndexSettings settings)

public Index(IndexSettings settings)

Initializes a new instance of the Index class in memory with particular index settings.

Parameters:

Parameter	Type	Description
settings	IndexSettings	The index settings object.

The example demonstrates how to create index in memory without saving files to disk with particular index settings.


 IndexSettings settings = new IndexSettings();
 settings.setIndexType(IndexType.CompactIndex);
 Index index = new Index(settings);
 
``` |

### Index(String indexFolder) {#Index-java.lang.String-}

public Index(String indexFolder)



Initializes a new instance of the  Index  class. Creates a new or opens an existing index on disk.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder path.

The example demonstrates how to create an index on a disk or open an existing index.

String indexFolder = “c:\MyIndex\”; Index index = new Index(indexFolder);


### Index(String indexFolder, IndexSettings settings) {#Index-java.lang.String-com.groupdocs.search.IndexSettings-}

public Index(String indexFolder, IndexSettings settings)



Initializes a new instance of the  Index  class. Creates a new index with particular settings or opens an existing index on disk.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder path. |
| settings | [IndexSettings](../../com.groupdocs.search/indexsettings) | The index settings object.

The example demonstrates how to create an index on a disk with particular index settings.

String indexFolder = “c:\MyIndex\”; IndexSettings settings = new IndexSettings(); settings.setIndexType(IndexType.CompactIndex); Index index = new Index(indexFolder, settings);


### Index(String indexFolder, boolean overwriteIfExists) {#Index-java.lang.String-boolean-}

public Index(String indexFolder, boolean overwriteIfExists)



Initializes a new instance of the  Index  class. Loads an existing index from disk if  overwriteIfExists  is  false ; creates a new index on disk otherwise.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder path. |
| overwriteIfExists | boolean | The flag of overwriting the index folder.

The example demonstrates how to create a new index in a folder that already contains another index.

String indexFolder = “c:\MyIndex\”; Index index = new Index(indexFolder, true);


### Index(String indexFolder, IndexSettings settings, boolean overwriteIfExists) {#Index-java.lang.String-com.groupdocs.search.IndexSettings-boolean-}

public Index(String indexFolder, IndexSettings settings, boolean overwriteIfExists)



Initializes a new instance of the  Index  class. Loads an existing index from disk if  overwriteIfExists  is  false ; creates a new index on disk with particular index settings otherwise.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder path. |
| settings | [IndexSettings](../../com.groupdocs.search/indexsettings) | The index settings object. |
| overwriteIfExists | boolean | The flag of overwriting the index folder.

The example demonstrates how to create an index on a disk with particular index settings.

String indexFolder = “c:\MyIndex\”; IndexSettings settings = new IndexSettings(); settings.setIndexType(IndexType.CompactIndex); Index index = new Index(indexFolder, settings, true);


### getEvents() {#getEvents--}

public final EventHub getEvents()



Gets the event hub for subscribing to events.

**Returns:**
[EventHub](../../com.groupdocs.search.events/eventhub) - The event hub for subscribing to events.
### getIndexInfo() {#getIndexInfo--}

public final IndexInfo getIndexInfo()



Gets the basic information on the index.

**Returns:**
[IndexInfo](../../com.groupdocs.search.common/indexinfo) - The basic information on the index.
### getRepository() {#getRepository--}

public final IndexRepository getRepository()



Gets the index repository object if the index is contained in it.

**Returns:**
[IndexRepository](../../com.groupdocs.search/indexrepository) - The index repository object.
### getIndexSettings() {#getIndexSettings--}

public final IndexSettings getIndexSettings()



Gets the index settings.

**Returns:**
[IndexSettings](../../com.groupdocs.search/indexsettings) - The index settings.
### getDictionaries() {#getDictionaries--}

public final DictionaryRepository getDictionaries()



Gets the dictionary repository.

**Returns:**
[DictionaryRepository](../../com.groupdocs.search.dictionaries/dictionaryrepository) - The dictionary repository.
### close() {#close--}

public final void close()



Releases all resources used by the  Index .

### add(String path) {#add-java.lang.String-}

public final void add(String path)



Performs indexing operation. Adds a file or folder by an absolute or relative path. Documents from all subfolders will be indexed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | The path to a file or folder to be indexed.

The example demonstrates how to add documents to an index.

String indexFolder = “c:\MyIndex\”; String folderPath = “c:\MyDocuments\”; String filePath = “c:\Documents\MyFile.txt”; Index index = new Index(indexFolder); // Creating index in the specified folder index.add(folderPath); // Indexing documents in the specified folder index.add(filePath); // Indexing the specified document


### add(String path, IndexingOptions options) {#add-java.lang.String-com.groupdocs.search.options.IndexingOptions-}

public final void add(String path, IndexingOptions options)



Performs indexing operation. Adds a file or folder by an absolute or relative path. Documents from all subfolders will be indexed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | The path to a file or folder to be indexed. |
| options | [IndexingOptions](../../com.groupdocs.search.options/indexingoptions) | The indexing options.

The example demonstrates how to add documents to an index with particular indexing options.

String indexFolder = “c:\MyIndex\”; String folderPath = “c:\MyDocuments\”; String filePath = “c:\Documents\MyFile.txt”; Index index = new Index(indexFolder); // Creating index in the specified folder IndexingOptions options = new IndexingOptions(); options.setThreads(2); // Setting the number of indexing threads index.add(folderPath, options); // Indexing documents in the specified folder index.add(filePath, options); // Indexing the specified document


### add(String[] paths) {#add-java.lang.String---}

public final void add(String[] paths)



Performs indexing operation. Adds files or folders by an absolute or relative path. Documents from all subfolders will be indexed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| paths | java.lang.String[] | The paths to a files or folders to be indexed.

The example demonstrates how to add documents to an index.

String indexFolder = “c:\MyIndex\”; String folderPath = “c:\MyDocuments\”; String filePath = “c:\Documents\MyFile.txt”; Index index = new Index(indexFolder); // Creating index in the specified folder String[] paths = new String[] { folderPath, filePath }; index.add(paths); // Indexing documents at the specified paths


### add(String[] paths, IndexingOptions options) {#add-java.lang.String---com.groupdocs.search.options.IndexingOptions-}

public final void add(String[] paths, IndexingOptions options)



Performs indexing operation. Adds files or folders by an absolute or relative path. Documents from all subfolders will be indexed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| paths | java.lang.String[] | The paths to a files or folders to be indexed. |
| options | [IndexingOptions](../../com.groupdocs.search.options/indexingoptions) | The indexing options.

The example demonstrates how to add documents to an index with particular indexing options.

String indexFolder = “c:\MyIndex\”; String folderPath = “c:\MyDocuments\”; String filePath = “c:\Documents\MyFile.txt”; Index index = new Index(indexFolder); // Creating index in the specified folder IndexingOptions options = new IndexingOptions(); options.setThreads(2); // Setting the number of indexing threads String[] paths = new String[] { folderPath, filePath }; index.add(paths, options); // Indexing documents at the specified paths


### add(Document[] documents, IndexingOptions options) {#add-com.groupdocs.search.Document---com.groupdocs.search.options.IndexingOptions-}

public final void add(Document[] documents, IndexingOptions options)



Performs indexing operation. Adds documents from file system, stream or structure.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documents | [Document\[\]](../../com.groupdocs.search/document) | The documents from file system, stream or structure. |
| options | [IndexingOptions](../../com.groupdocs.search.options/indexingoptions) | The indexing options. |

### add(ExtractedData[] data, IndexingOptions options) {#add-com.groupdocs.search.ExtractedData---com.groupdocs.search.options.IndexingOptions-}

public final void add(ExtractedData[] data, IndexingOptions options)



Performs indexing operation. Adds the extracted data to the index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | [ExtractedData\[\]](../../com.groupdocs.search/extracteddata) | The extracted data. |
| options | [IndexingOptions](../../com.groupdocs.search.options/indexingoptions) | The indexing options. |

### update() {#update--}

public final void update()



Re-indexes documents that have been changed or deleted since last update. Adds new files that have been added to the indexed folders.

The example demonstrates how to update an index.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; Index index = new Index(indexFolder); // Creating index in the specified folder index.add(documentsFolder); // Indexing documents from the specified folder // Delete documents from the documents folder or modify them or add new documents to the folder index.update(); // Updating the index


### update(UpdateOptions options) {#update-com.groupdocs.search.options.UpdateOptions-}

public final void update(UpdateOptions options)



Re-indexes documents that have been changed or deleted since last update. Adds new files that have been added to the indexed folders.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | [UpdateOptions](../../com.groupdocs.search.options/updateoptions) | The update options.

The example demonstrates how to update an index with particular update options.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; Index index = new Index(indexFolder); // Creating index in the specified folder index.add(documentsFolder); // Indexing documents from the specified folder // Delete documents from the documents folder or modify them or add new documents to the folder UpdateOptions options = new UpdateOptions(); options.setThreads(2); // Setting the number of indexing threads index.update(options); // Updating the index


### getIndexingReports() {#getIndexingReports--}

public final IndexingReport[] getIndexingReports()



Gets the reports on indexing operations.

**Returns:**
com.groupdocs.search.common.IndexingReport[] - The indexing reports.

The example demonstrates how to get indexing reports.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; Index index = new Index(indexFolder); // Creating index in the specified folder index.add(documentsFolder); // Indexing documents from the specified folder IndexingReport[] reports = index.getIndexingReports(); // Getting indexing reports

### getSearchReports() {#getSearchReports--}

public final SearchReport[] getSearchReports()



Gets the reports on search operations.

**Returns:**
com.groupdocs.search.common.SearchReport[] - The search reports.

The example demonstrates how to get search reports.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; String query1 = “Einstein”; String query2 = “Newton”; Index index = new Index(indexFolder); // Creating index in the specified folder index.add(documentsFolder); // Indexing documents from the specified folder SearchResult result1 = index.search(query1); // Searching SearchResult result2 = index.search(query2); SearchResult result3 = index.search(query1 + " & " + query2); SearchReport[] reports = index.getSearchReports(); // Getting search reports

### search(String query) {#search-java.lang.String-}

public final SearchResult search(String query)



Searches in index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | java.lang.String | The search query.

The following example demonstrates how to perform simple search.


The following example demonstrates how to perform Regex search.


The following example demonstrates how to perform faceted search.


**Returns:**
[SearchResult](../../com.groupdocs.search.results/searchresult) - The search result.
### search(String query, SearchOptions options) {#search-java.lang.String-com.groupdocs.search.options.SearchOptions-}

public final SearchResult search(String query, SearchOptions options)



Searches in index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | java.lang.String | The search query. |
| options | [SearchOptions](../../com.groupdocs.search.options/searchoptions) | The search options.

The following example demonstrates how to perform fuzzy search.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; Index index = new Index(indexFolder); // Creating index in the specified folder index.add(documentsFolder); // Indexing documents from the specified folder SearchOptions options = new SearchOptions(); options.getFuzzySearch().setEnabled(true); // Enabling the fuzzy search options.getFuzzySearch().setFuzzyAlgorithm(new TableDiscreteFunction(1)); // Setting the number of possible differences for each word // Double quotes at the beginning and end tells the index that it is phrase search query String query = “"The Pursuit of Happiness"”; SearchResult result = index.search(query, options); // Searching


The following example demonstrates how to perform synonym search.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; Index index = new Index(indexFolder); // Creating index in the specified folder index.add(documentsFolder); // Indexing documents from the specified folder SearchOptions options = new SearchOptions(); options.setUseSynonymSearch(true); // Enabling the synonym search String query = “cry”; SearchResult result = index.search(query, options); // Searching


**Returns:**
[SearchResult](../../com.groupdocs.search.results/searchresult) - The search result.
### search(SearchQuery query) {#search-com.groupdocs.search.SearchQuery-}

public final SearchResult search(SearchQuery query)



Searches in index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | [SearchQuery](../../com.groupdocs.search/searchquery) | The search query.

The following example demonstrates how to perform search using query in object form.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; Index index = new Index(indexFolder); // Creating index in the specified folder index.add(documentsFolder); // Indexing documents from the specified folder // Creating subquery 1 SearchQuery subquery1 = SearchQuery.createWordQuery(“accommodation”); subquery1.setSearchOptions(new SearchOptions()); // Setting search options only for subquery 1 subquery1.getSearchOptions().getFuzzySearch().setEnabled(true); // Enabling the fuzzy search subquery1.getSearchOptions().getFuzzySearch().setFuzzyAlgorithm(new TableDiscreteFunction(3)); // Setting maximum number of differences // Creating subquery 2 SearchQuery subquery2 = SearchQuery.createNumericRangeQuery(1, 1000000); // Creating subquery 3 SearchQuery subquery3 = SearchQuery.createRegexQuery("(.)\1"); // Combining subqueries into one query SearchQuery query = SearchQuery.createPhraseSearchQuery(subquery1, subquery2, subquery3); SearchResult result = index.search(query); // Searching


**Returns:**
[SearchResult](../../com.groupdocs.search.results/searchresult) - The search result.
### search(SearchQuery query, SearchOptions options) {#search-com.groupdocs.search.SearchQuery-com.groupdocs.search.options.SearchOptions-}

public final SearchResult search(SearchQuery query, SearchOptions options)



Searches in index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | [SearchQuery](../../com.groupdocs.search/searchquery) | The search query. |
| options | [SearchOptions](../../com.groupdocs.search.options/searchoptions) | The search options.

The following example demonstrates how to perform search using query in object form.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; Index index = new Index(indexFolder); // Creating index in the specified folder index.add(documentsFolder); // Indexing documents from the specified folder // Creating subquery of date range search SearchQuery subquery1 = SearchQuery.createDateRangeQuery(new Date(2011, 6, 17), new Date(2013, 1, 1)); // Creating subquery of wildcard with number of missed words from 0 to 2 SearchQuery subquery2 = SearchQuery.createWildcardQuery(0, 2); // Creating subquery of simple word SearchQuery subquery3 = SearchQuery.createWordQuery(“birth”); subquery3.setSearchOptions(new SearchOptions()); // Setting search options only for subquery 3 subquery3.getSearchOptions().getFuzzySearch().setEnabled(true); subquery3.getSearchOptions().getFuzzySearch().setFuzzyAlgorithm(new TableDiscreteFunction(1)); // Combining subqueries into one query SearchQuery query = SearchQuery.createPhraseSearchQuery(subquery1, subquery2, subquery3); // Creating search options object with increased capacity of found occurrences SearchOptions options = new SearchOptions(); // Overall search options options.setMaxOccurrenceCountPerTerm(1000000); options.setMaxTotalOccurrenceCount(10000000); SearchResult result = index.search(query, options); // Searching


**Returns:**
[SearchResult](../../com.groupdocs.search.results/searchresult) - The search result.
### search(SearchImage image, ImageSearchOptions options) {#search-com.groupdocs.search.common.SearchImage-com.groupdocs.search.options.ImageSearchOptions-}

public final ImageSearchResult search(SearchImage image, ImageSearchOptions options)



Performs a reverse image search in the index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| image | [SearchImage](../../com.groupdocs.search.common/searchimage) | The image to search. |
| options | [ImageSearchOptions](../../com.groupdocs.search.options/imagesearchoptions) | The image search options. |

**Returns:**
[ImageSearchResult](../../com.groupdocs.search.results/imagesearchresult) - The result of a reverse image search.
### searchNext(ChunkSearchToken chunkSearchToken) {#searchNext-com.groupdocs.search.common.ChunkSearchToken-}

public final SearchResult searchNext(ChunkSearchToken chunkSearchToken)



Continues the chunk search started with method Search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| chunkSearchToken | [ChunkSearchToken](../../com.groupdocs.search.common/chunksearchtoken) | The chunk search token.

The example demonstrates how to perform chunk search.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; String query = “Einstein”; Index index = new Index(indexFolder); // Creating index in the specified folder index.add(documentsFolder); // Indexing documents from the specified folder SearchOptions options = new SearchOptions(); options.setChunkSearch(true); // Enabling chunk search SearchResult result = index.search(query, options); // Starting chunk search System.out.println(“Document count: " + result.getDocumentCount()); System.out.println(“Occurrence count: " + result.getOccurrenceCount()); while (result.getNextChunkSearchToken() != null) { result = index.searchNext(result.getNextChunkSearchToken()); // Continuing chunk search System.out.println(“Document count: " + result.getDocumentCount()); System.out.println(“Occurrence count: " + result.getOccurrenceCount()); }


**Returns:**
[SearchResult](../../com.groupdocs.search.results/searchresult) - The search result.
### searchNext(ChunkSearchToken chunkSearchToken, Cancellation cancellation) {#searchNext-com.groupdocs.search.common.ChunkSearchToken-com.groupdocs.search.common.Cancellation-}

public final SearchResult searchNext(ChunkSearchToken chunkSearchToken, Cancellation cancellation)



Continues the chunk search started with method Search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| chunkSearchToken | [ChunkSearchToken](../../com.groupdocs.search.common/chunksearchtoken) | The chunk search token. |
| cancellation | [Cancellation](../../com.groupdocs.search.common/cancellation) | The cancellation object.

The example demonstrates how to perform search using query in object form.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; String query = “Einstein”; Index index = new Index(indexFolder); // Creating index in the specified folder index.add(documentsFolder); // Indexing documents from the specified folder Cancellation cancellation = new Cancellation(); // This cancellation object aborts all search continuations if canceled SearchOptions options = new SearchOptions(); options.setChunkSearch(true); // Enabling chunk search options.setCancellation(cancellation); SearchResult result = index.search(query, options); // Starting chunk search System.out.println(“Document count: " + result.getDocumentCount()); System.out.println(“Occurrence count: " + result.getOccurrenceCount()); while (result.getNextChunkSearchToken() != null) { result = index.searchNext(result.getNextChunkSearchToken(), cancellation); // Continuing chunk search System.out.println(“Document count: " + result.getDocumentCount()); System.out.println(“Occurrence count: " + result.getOccurrenceCount()); }


**Returns:**
[SearchResult](../../com.groupdocs.search.results/searchresult) - The search result.
### optimize() {#optimize--}

public final void optimize()



Minimizes the number of index segments by merging them one with another. This operation improves search performance.

The example demonstrates how to merge segments of an index.


### optimize(MergeOptions options) {#optimize-com.groupdocs.search.options.MergeOptions-}

public final void optimize(MergeOptions options)



Minimizes the number of index segments by merging them one with another. This operation improves search performance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | [MergeOptions](../../com.groupdocs.search.options/mergeoptions) | The merge options.

The example demonstrates how to merge segments of an index with particular merge options.

String indexFolder = “c:\MyIndex\”; String documentsFolder1 = “c:\MyDocuments1\”; String documentsFolder2 = “c:\MyDocuments2\”; String documentsFolder3 = “c:\MyDocuments3\”; Index index = new Index(indexFolder); // Creating index in the specified folder index.add(documentsFolder1); // Indexing documents from the specified folder index.add(documentsFolder2); // Each call to AddToIndex creates at least one new segment in the index index.add(documentsFolder3); MergeOptions options = new MergeOptions(); options.setAsync(true); // Asynchronous operation options.setCancellation(new Cancellation()); // Creating cancellation object // Merging segments of the index index.optimize(options); // This method will return before the operation is completed options.getCancellation().cancelAfter(10000); // Setting maximum duration of the operation to 10 seconds


### merge(Index index, MergeOptions options) {#merge-com.groupdocs.search.Index-com.groupdocs.search.options.MergeOptions-}

public final void merge(Index index, MergeOptions options)



Merges the specified index into the current index. Note that the other index will not be changed.

If the other index has a previous version, it must be updated before merging with  IndexUpdater .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | [Index](../../com.groupdocs.search/index) | The index to merge into. |
| options | [MergeOptions](../../com.groupdocs.search.options/mergeoptions) | The merge options.

The example demonstrates how to merge an index into the current index.

String indexFolder1 = “c:\MyIndex1\”; String indexFolder2 = “c:\MyIndex2\”; String documentsFolder1 = “c:\MyDocuments1\”; String documentsFolder2 = “c:\MyDocuments2\”; Index index1 = new Index(indexFolder1); // Creating index1 index1.add(documentsFolder1); // Indexing documents Index index2 = new Index(indexFolder2); // Creating index2 index2.add(documentsFolder2); // Indexing documents MergeOptions options = new MergeOptions(); options.setCancellation(new Cancellation()); // Creating cancellation object // Merging index2 into index1. Note that index2 files will not be changed. index1.merge(index2, options);


### merge(IndexRepository repository, MergeOptions options) {#merge-com.groupdocs.search.IndexRepository-com.groupdocs.search.options.MergeOptions-}

public final void merge(IndexRepository repository, MergeOptions options)



Merges indexes from the specified index repository into the current index. Note that indexes in the repository will not be changed.

If other indexes have a previous version, they must be updated before merging with  IndexUpdater .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| repository | [IndexRepository](../../com.groupdocs.search/indexrepository) | The index repository to merge into. |
| options | [MergeOptions](../../com.groupdocs.search.options/mergeoptions) | The merge options.

The example demonstrates how to merge an index repository into the current index.

String indexFolder1 = “c:\MyIndex1\”; String indexFolder2 = “c:\MyIndex2\”; String indexFolder3 = “c:\MyIndex3\”; String documentsFolder1 = “c:\MyDocuments1\”; String documentsFolder2 = “c:\MyDocuments2\”; String documentsFolder3 = “c:\MyDocuments3\”; Index index1 = new Index(indexFolder1); // Creating index1 index1.add(documentsFolder1); // Indexing documents IndexRepository repository = new IndexRepository(); // Creating index repository Index index2 = repository.create(indexFolder2); // Creating index2 index2.add(documentsFolder2); // Indexing documents Index index3 = repository.create(indexFolder3); // Creating index3 index3.add(documentsFolder3); // Indexing documents MergeOptions options = new MergeOptions(); options.setCancellation(new Cancellation()); // Creating cancellation object // Merging all indexes in the index repository into index1. Note that index2 and index3 will not be changed. index1.merge(repository, options);


### highlight(FoundDocument document, Highlighter highlighter) {#highlight-com.groupdocs.search.results.FoundDocument-com.groupdocs.search.highlighters.Highlighter-}

public final void highlight(FoundDocument document, Highlighter highlighter)



Generates HTML formatted text with highlighted found terms.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | [FoundDocument](../../com.groupdocs.search.results/founddocument) | The found document. |
| highlighter | [Highlighter](../../com.groupdocs.search.highlighters/highlighter) | The search result highlighter.

The example demonstrates how to highlight occurrences in HTML formatted text.

String indexFolder = “c:\MyIndex\”; String documentFolder = “c:\MyDocuments\”; // Creating an index Index index = new Index(indexFolder); // Indexing documents from the specified folder index.add(documentFolder); // Search for the word ’eternity' SearchResult result = index.search(“eternity”); // Highlighting occurrences in text if (result.getDocumentCount() > 0) { FoundDocument document = result.getFoundDocument(0); // Getting the first found document OutputAdapter outputAdapter = new FileOutputAdapter(“c:\Highlighted.html”); // Creating an output adapter to the file Highlighter highlighter = new HtmlHighlighter(outputAdapter); // Creating the highlighter object index.highlight(document, highlighter); // Generating HTML formatted text with highlighted occurrences }


### highlight(FoundDocument document, Highlighter highlighter, HighlightOptions options) {#highlight-com.groupdocs.search.results.FoundDocument-com.groupdocs.search.highlighters.Highlighter-com.groupdocs.search.options.HighlightOptions-}

public final void highlight(FoundDocument document, Highlighter highlighter, HighlightOptions options)



Generates HTML formatted text with highlighted found terms.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | [FoundDocument](../../com.groupdocs.search.results/founddocument) | The found document. |
| highlighter | [Highlighter](../../com.groupdocs.search.highlighters/highlighter) | The search result highlighter. |
| options | [HighlightOptions](../../com.groupdocs.search.options/highlightoptions) | The highlight options.

The example demonstrates how to highlight occurrences in HTML formatted text.

String indexFolder = “c:\MyIndex\”; String documentFolder = “c:\MyDocuments\”; // Creating an index Index index = new Index(indexFolder); // Indexing documents from the specified folder index.add(documentFolder); // Search for the word ’eternity' SearchResult result = index.search(“eternity”); // Highlighting occurrences in text if (result.getDocumentCount() > 0) { FoundDocument document = result.getFoundDocument(0); // Getting the first found document OutputAdapter outputAdapter = new FileOutputAdapter(“c:\Highlighted.html”); // Creating an output adapter to the file Highlighter highlighter = new HtmlHighlighter(outputAdapter); // Creating the highlighter object HighlightOptions options = new HighlightOptions(); // Creating the highlight options object options.setTermsBefore(5); options.setTermsAfter(5); options.setTermsTotal(15); index.highlight(document, highlighter, options); // Generating HTML formatted text with highlighted occurrences }


### getIndexedDocuments() {#getIndexedDocuments--}

public final DocumentInfo[] getIndexedDocuments()



Gets an array of all indexed documents.

**Returns:**
com.groupdocs.search.results.DocumentInfo[] - An array of all indexed documents.

The example demonstrates how to get a list of indexed documents from an index.

### getIndexedDocumentItems(DocumentInfo documentInfo) {#getIndexedDocumentItems-com.groupdocs.search.results.DocumentInfo-}

public final DocumentInfo[] getIndexedDocumentItems(DocumentInfo documentInfo)



Gets an array of a document items.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | [DocumentInfo](../../com.groupdocs.search.results/documentinfo) | A document info.

The example demonstrates how to get a list of items of an indexed document from an index.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; // Creating an index in the specified folder Index index = new Index(indexFolder); // Indexing documents from the specified folder index.add(documentsFolder); // Getting list of indexed documents DocumentInfo[] documents = index.getIndexedDocuments(); for (int i = 0; i < documents.length; i++) { DocumentInfo document = documents[i]; System.out.println(document.getFilePath()); DocumentInfo[] items = index.getIndexedDocumentItems(document); // Getting list of document items for (int j = 0; j < items.length; j++) { DocumentInfo item = items[j]; System.out.println("\t” + item.getInnerPath()); } }


**Returns:**
com.groupdocs.search.results.DocumentInfo[] - An array of a document items.
### getDocumentText(DocumentInfo documentInfo, OutputAdapter adapter) {#getDocumentText-com.groupdocs.search.results.DocumentInfo-com.groupdocs.search.common.OutputAdapter-}

public final void getDocumentText(DocumentInfo documentInfo, OutputAdapter adapter)



Generates the text of an indexed document and passes it through an output adapter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | [DocumentInfo](../../com.groupdocs.search.results/documentinfo) | The indexed document info. |
| adapter | [OutputAdapter](../../com.groupdocs.search.common/outputadapter) | The output adapter.

The example demonstrates how to get the text of an indexed document from an index.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; // Creating an index in the specified folder Index index = new Index(indexFolder); // Indexing documents from the specified folder index.add(documentsFolder); // Getting list of indexed documents DocumentInfo[] documents = index.getIndexedDocuments(); // Getting a document text if (documents.length > 0) { FileOutputAdapter outputAdapter = new FileOutputAdapter(“C:\Text.html”); index.getDocumentText(documents[0], outputAdapter); }


### getDocumentText(DocumentInfo documentInfo, OutputAdapter adapter, TextOptions options) {#getDocumentText-com.groupdocs.search.results.DocumentInfo-com.groupdocs.search.common.OutputAdapter-com.groupdocs.search.options.TextOptions-}

public final void getDocumentText(DocumentInfo documentInfo, OutputAdapter adapter, TextOptions options)



Generates HTML formatted text for indexed document and transfers it through the output adapter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | [DocumentInfo](../../com.groupdocs.search.results/documentinfo) | The indexed document info. |
| adapter | [OutputAdapter](../../com.groupdocs.search.common/outputadapter) | The output adapter. |
| options | [TextOptions](../../com.groupdocs.search.options/textoptions) | The text retrieving options. |

### getIndexedPaths() {#getIndexedPaths--}

public final String[] getIndexedPaths()



Gets an array of indexed paths - documents or folders.

**Returns:**
java.lang.String[] - An array of indexed paths.
### delete(String[] paths, UpdateOptions options) {#delete-java.lang.String---com.groupdocs.search.options.UpdateOptions-}

public final DeleteResult delete(String[] paths, UpdateOptions options)



Deletes indexed files or folders from the index. Then updates the index without deleted paths. Note that an individual document cannot be deleted from the index if it was added to the index as part of a folder.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| paths | java.lang.String[] | The paths to files or folders to delete. |
| options | [UpdateOptions](../../com.groupdocs.search.options/updateoptions) | The update options.

The example demonstrates how to delete indexed paths from an index.

String indexFolder = “c:\MyIndex\”; String documentsFolder1 = “c:\MyDocuments\”; String documentsFolder2 = “c:\MyDocuments2\”; // Creating an index in the specified folder Index index = new Index(indexFolder); // Indexing documents from the specified folders index.add(documentsFolder1); index.add(documentsFolder2); // Getting indexed paths from the index String[] indexedPaths1 = index.getIndexedPaths(); // Writing indexed paths to the console System.out.println(“Indexed paths:”); for (String path : indexedPaths1) { System.out.println("\t” + path); } // Deleting index path from the index DeleteResult deleteResult = index.delete(new String[] { documentsFolder1 }, new UpdateOptions()); // Getting indexed paths after deletion String[] indexedPaths2 = index.getIndexedPaths(); System.out.println("\nDeleted paths: " + deleteResult.getSuccessCount()); System.out.println("\nIndexed paths:”); for (String path : indexedPaths2) { System.out.println("\t” + path); }


**Returns:**
[DeleteResult](../../com.groupdocs.search.results/deleteresult) - An object describing the result of deleting files or folders from the index.
### delete(UpdateOptions options, String[] documentKeys) {#delete-com.groupdocs.search.options.UpdateOptions-java.lang.String---}

public final DeleteResult delete(UpdateOptions options, String[] documentKeys)



Deletes documents indexed from streams or structures. Then updates the index without deleted documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | [UpdateOptions](../../com.groupdocs.search.options/updateoptions) | The update options. |
| documentKeys | java.lang.String[] | The keys of documents added from streams or structures. |

**Returns:**
[DeleteResult](../../com.groupdocs.search.results/deleteresult) - An object describing the result of deleting documents from the index.
### notifyIndex(Notification notification) {#notifyIndex-com.groupdocs.search.Notification-}

public final boolean notifyIndex(Notification notification)



Passes the specified notification object to the index to perform the notification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| notification | [Notification](../../com.groupdocs.search/notification) | The notification object. |

**Returns:**
boolean - Returns  true  if the notification was successfully performed; otherwise  false .
### changeAttributes(AttributeChangeBatch batch) {#changeAttributes-com.groupdocs.search.common.AttributeChangeBatch-}

public final void changeAttributes(AttributeChangeBatch batch)



Applies the specified batch of attribute changes to indexed documents without reindexing during the update operation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| batch | [AttributeChangeBatch](../../com.groupdocs.search.common/attributechangebatch) | The attribute change batch. |

### getAttributes(String path) {#getAttributes-java.lang.String-}

public final String[] getAttributes(String path)



Gets all the attributes associated with the specified indexed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | The document path. |

**Returns:**
java.lang.String[] - Attributes associated with the document.

Java: IndexRepository

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

All Implemented Interfaces: java.io.Closeable

public class IndexRepository implements Closeable

Represents a container for combining multiple indexes and performing common operations on them.

Learn more

Search index repository

The example demonstrates a typical usage of the class.


 String indexFolder1 = "c:\\MyIndex\\";
 String indexFolder2 = "c:\\MyIndex\\";
 String query = "Einstein";
 IndexRepository repository = new IndexRepository();
 repository.addToRepository(indexFolder1); // Loading an existing index
 repository.addToRepository(indexFolder2); // Loading another existing index
 SearchResult result = repository.search(query); // Searching in indexes of the repository

Constructors

Constructor	Description
IndexRepository()	Initializes a new instance of the IndexRepository class.

Methods

Method	Description
getEvents()	Gets the event hub for subscribing to events.
getIndexes()	Gets the indexes contained in this IndexRepository .
close()	Releases all resources used by the IndexRepository .
create()	Creates a new index in memory.
create(IndexSettings settings)	Creates a new index in memory.
create(String indexFolder)	Creates a new index on disk.
create(String indexFolder, IndexSettings settings)	Creates a new index on disk.
addToRepository(Index index)	Adds an index to the index repository.
addToRepository(String indexFolder)	Opens and adds an index to the index repository.
update()	Updates all indexes in the repository.
update(UpdateOptions options)	Updates all indexes in the repository.
search(String query)	Searches in all indexes of the repository.
search(String query, SearchOptions options)	Searches in all indexes of the repository.
search(SearchQuery query)	Searches in all indexes of the repository.
search(SearchQuery query, SearchOptions options)	Searches in all indexes of the repository.

IndexRepository()

public IndexRepository()

Initializes a new instance of the IndexRepository class.

getEvents()

public final EventHub getEvents()

Gets the event hub for subscribing to events.

Returns: EventHub - The event hub for subscribing to events.

getIndexes()

public final Index[] getIndexes()

Gets the indexes contained in this IndexRepository .

Returns: com.groupdocs.search.Index[] - The indexes.

close()

public final void close()

Releases all resources used by the IndexRepository .

create()

public final Index create()

Creates a new index in memory.

Returns: Index - The created index.

The example demonstrates how to create an index in memory through the index repository.


 IndexRepository indexRepository = new IndexRepository();
 Index index = indexRepository.create();

create(IndexSettings settings)

public final Index create(IndexSettings settings)

Creates a new index in memory.

Parameters:

Parameter	Type	Description
settings	IndexSettings	The index settings.

The example demonstrates how to create an index in memory through the index repository.


 IndexRepository indexRepository = new IndexRepository();
 IndexSettings settings = new IndexSettings();
 settings.setUseStopWords(false); // Disabling use of stop words during indexing
 Index index = indexRepository.create(settings);
 
``` |

**Returns:**
[Index](../../com.groupdocs.search/index) - The created index.
### create(String indexFolder) {#create-java.lang.String-}

public final Index create(String indexFolder)



Creates a new index on disk. The index folder will be cleaned before the index creation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder.

The example demonstrates how to create an index on disk through the index repository.

String indexFolder = “c:\MyIndex\”; IndexRepository indexRepository = new IndexRepository(); Index index = indexRepository.create(indexFolder);


**Returns:**
[Index](../../com.groupdocs.search/index) - The created index.
### create(String indexFolder, IndexSettings settings) {#create-java.lang.String-com.groupdocs.search.IndexSettings-}

public final Index create(String indexFolder, IndexSettings settings)



Creates a new index on disk. The index folder will be cleaned before the index creation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder. |
| settings | [IndexSettings](../../com.groupdocs.search/indexsettings) | The index settings.

The example demonstrates how to create an index on disk through the index repository.

String indexFolder = “c:\MyIndex\”; IndexRepository indexRepository = new IndexRepository(); IndexSettings settings = new IndexSettings(); settings.setUseStopWords(false); // Disabling use of stop words during indexing Index index = indexRepository.create(indexFolder, settings);


**Returns:**
[Index](../../com.groupdocs.search/index) - The created index.
### addToRepository(Index index) {#addToRepository-com.groupdocs.search.Index-}

public final void addToRepository(Index index)



Adds an index to the index repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | [Index](../../com.groupdocs.search/index) | The index to add.

The example demonstrates how to add an index to the index repository.

Index index = new Index(); IndexRepository indexRepository = new IndexRepository(); indexRepository.addToRepository(index);


### addToRepository(String indexFolder) {#addToRepository-java.lang.String-}

public final void addToRepository(String indexFolder)



Opens and adds an index to the index repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder.

The example demonstrates how to add an index to the index repository.

String indexFolder = “c:\MyIndex\”; IndexRepository indexRepository = new IndexRepository(); indexRepository.addToRepository(indexFolder);


### update() {#update--}

public final void update()



Updates all indexes in the repository.

The example demonstrates how to update indexes in the repository.


### update(UpdateOptions options) {#update-com.groupdocs.search.options.UpdateOptions-}

public final void update(UpdateOptions options)



Updates all indexes in the repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | [UpdateOptions](../../com.groupdocs.search.options/updateoptions) | The update options.

The example demonstrates how to update indexes in the repository.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; IndexRepository repository = new IndexRepository(); Index index = repository.create(indexFolder); // Creating index index.add(documentsFolder); // Indexing documents // Delete documents from the documents folder or modify them or add new documents to the folder UpdateOptions options = new UpdateOptions(); options.setThreads(2); // Setting the number of indexing threads repository.update(options);


### search(String query) {#search-java.lang.String-}

public final SearchResult search(String query)



Searches in all indexes of the repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | java.lang.String | The search query.

The example demonstrates how to perform search in index repository.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; String query = “Einstein”; IndexRepository repository = new IndexRepository(); Index index = repository.create(indexFolder); // Creating index index.add(documentsFolder); // Indexing documents SearchResult result = repository.search(query); // Searching


**Returns:**
[SearchResult](../../com.groupdocs.search.results/searchresult) - The search result.
### search(String query, SearchOptions options) {#search-java.lang.String-com.groupdocs.search.options.SearchOptions-}

public final SearchResult search(String query, SearchOptions options)



Searches in all indexes of the repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | java.lang.String | The search query. |
| options | [SearchOptions](../../com.groupdocs.search.options/searchoptions) | The search options.

The example demonstrates how to perform search in index repository.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; String query = “Einstein”; IndexRepository repository = new IndexRepository(); Index index = repository.create(indexFolder); // Creating index index.add(documentsFolder); // Indexing documents SearchOptions options = new SearchOptions(); options.setUseCaseSensitiveSearch(true); // Setting flag of case sensitive search SearchResult result = repository.search(query, options); // Searching


**Returns:**
[SearchResult](../../com.groupdocs.search.results/searchresult) - The search result.
### search(SearchQuery query) {#search-com.groupdocs.search.SearchQuery-}

public final SearchResult search(SearchQuery query)



Searches in all indexes of the repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | [SearchQuery](../../com.groupdocs.search/searchquery) | The search query.

The example demonstrates how to perform search in index repository.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; IndexRepository repository = new IndexRepository(); Index index = repository.create(indexFolder); // Creating index index.add(documentsFolder); // Indexing documents SearchQuery query = SearchQuery.createWordQuery(“Einstein”); // Creating search query in object form SearchResult result = repository.search(query); // Searching


**Returns:**
[SearchResult](../../com.groupdocs.search.results/searchresult) - The search result.
### search(SearchQuery query, SearchOptions options) {#search-com.groupdocs.search.SearchQuery-com.groupdocs.search.options.SearchOptions-}

public final SearchResult search(SearchQuery query, SearchOptions options)



Searches in all indexes of the repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | [SearchQuery](../../com.groupdocs.search/searchquery) | The search query. |
| options | [SearchOptions](../../com.groupdocs.search.options/searchoptions) | The search options.

The example demonstrates how to perform search in index repository.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; IndexRepository repository = new IndexRepository(); Index index = repository.create(indexFolder); // Creating index index.add(documentsFolder); // Indexing documents SearchOptions options = new SearchOptions(); options.setUseCaseSensitiveSearch(true); // Setting flag of case sensitive search SearchQuery query = SearchQuery.createWordQuery(“Einstein”); // Creating search query in object form SearchResult result = repository.search(query, options); // Searching


**Returns:**
[SearchResult](../../com.groupdocs.search.results/searchresult) - The search result.

Java: IndexSettings

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public class IndexSettings

Represents the index settings that allow to customize the indexing operations.

Learn more

Search index settings

The example demonstrates a typical usage of the class.


 String indexFolder = "c:\\MyIndex\\";
 IndexSettings settings = new IndexSettings();
 settings.setIndexType(IndexType.CompactIndex); // Setting the index type
 Index index = new Index(indexFolder, settings); // Creating an index

Constructors

Constructor	Description
IndexSettings()	Initializes a new instance of the IndexSettings class.

Methods

Method	Description
getInMemoryIndex()	Gets a value indicating whether the index is stored in memory or on disk.
getUseStopWords()	Gets a value indicating whether to use stop words or not.
setUseStopWords(boolean value)	Sets a value indicating whether to use stop words or not.
getMaxIndexingReportCount()	Gets the maximum number of indexing reports.
setMaxIndexingReportCount(int value)	Sets the maximum number of indexing reports.
getMaxSearchReportCount()	Gets the maximum number of search reports.
setMaxSearchReportCount(int value)	Sets the maximum number of search reports.
getUseCharacterReplacements()	Gets a value indicating whether to use character replacements or not.
setUseCharacterReplacements(boolean value)	Sets a value indicating whether to use character replacements or not.
getDocumentFilter()	Gets a document filter.
setDocumentFilter(DocumentFilter value)	Sets a document filter.
getTextStorageSettings()	Gets the text storage settings.
setTextStorageSettings(TextStorageSettings value)	Sets the text storage settings.
getIndexType()	Gets the index type.
setIndexType(IndexType value)	Sets the index type.
getSearchThreads()	Gets the number of threads used for the search.
setSearchThreads(NumberOfThreads value)	Sets the number of threads used for the search.
getCustomExtractors()	Gets the custom extractor collection.
getLogger()	Gets a logger that is used for logging events and errors in the index.
setLogger(ILogger value)	Sets a logger that is used for logging events and errors in the index.

IndexSettings()

public IndexSettings()

Initializes a new instance of the IndexSettings class.

getInMemoryIndex()

public final boolean getInMemoryIndex()

Gets a value indicating whether the index is stored in memory or on disk.

Returns: boolean - A value indicating whether the index is stored in memory or on disk.

getUseStopWords()

public final boolean getUseStopWords()

Gets a value indicating whether to use stop words or not. The default value is true .

Returns: boolean - A value indicating whether to use stop words or not.

setUseStopWords(boolean value)

public final void setUseStopWords(boolean value)

Sets a value indicating whether to use stop words or not. The default value is true .

Parameters:

Parameter	Type	Description
value	boolean	A value indicating whether to use stop words or not.

getMaxIndexingReportCount()

public final int getMaxIndexingReportCount()

Gets the maximum number of indexing reports. The default value is 5 .

Returns: int - The maximum number of indexing reports.

setMaxIndexingReportCount(int value)

public final void setMaxIndexingReportCount(int value)

Sets the maximum number of indexing reports. The default value is 5 .

Parameters:

Parameter	Type	Description
value	int	The maximum number of indexing reports.

getMaxSearchReportCount()

public final int getMaxSearchReportCount()

Gets the maximum number of search reports. The default value is 10 .

Returns: int - The maximum number of search reports.

setMaxSearchReportCount(int value)

public final void setMaxSearchReportCount(int value)

Sets the maximum number of search reports. The default value is 10 .

Parameters:

Parameter	Type	Description
value	int	The maximum number of search reports.

getUseCharacterReplacements()

public final boolean getUseCharacterReplacements()

Gets a value indicating whether to use character replacements or not. The default value is false .

Returns: boolean - A value indicating whether to use character replacements or not.

setUseCharacterReplacements(boolean value)

public final void setUseCharacterReplacements(boolean value)

Sets a value indicating whether to use character replacements or not. The default value is false .

Parameters:

Parameter	Type	Description
value	boolean	A value indicating whether to use character replacements or not.

getDocumentFilter()

public final DocumentFilter getDocumentFilter()

Gets a document filter. The DocumentFilter works on the inclusion logic. Use the DocumentFilter class for creation a document filter instance. The default value is null , which means that all added documents are indexed.

Returns: DocumentFilter - The document filter.

The example demonstrates how to set the document filter.


 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating a filter that skips documents with extensions '.doc', '.docx', '.rtf'
 IndexSettings settings = new IndexSettings();
 DocumentFilter fileExtensionFilter = DocumentFilter.createFileExtension(".doc", ".docx", ".rtf"); // Creating file extension filter
 DocumentFilter invertedFilter = DocumentFilter.createNot(fileExtensionFilter); // Inverting file extension filter
 settings.setDocumentFilter(invertedFilter);
 // Creating an index in the specified folder
 Index index = new Index(indexFolder, settings);
 // Indexing documents
 index.add(documentsFolder);
 // Searching
 SearchResult result = index.search("Einstein");

setDocumentFilter(DocumentFilter value)

public final void setDocumentFilter(DocumentFilter value)

Sets a document filter. The DocumentFilter works on the inclusion logic. Use the GroupDocs.Search.Options.DocumentFilter class for creation of a document filter instances. The default value is null , which means that all added documents are indexed.

Parameters:

Parameter	Type	Description
value	DocumentFilter	The document filter.

The example demonstrates how to set the document filter.


 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating a filter that skips documents with extensions '.doc', '.docx', '.rtf'
 IndexSettings settings = new IndexSettings();
 DocumentFilter fileExtensionFilter = DocumentFilter.createFileExtension(".doc", ".docx", ".rtf"); // Creating file extension filter
 DocumentFilter invertedFilter = DocumentFilter.createNot(fileExtensionFilter); // Inverting file extension filter
 settings.setDocumentFilter(invertedFilter);
 // Creating an index in the specified folder
 Index index = new Index(indexFolder, settings);
 // Indexing documents
 index.add(documentsFolder);
 // Searching
 SearchResult result = index.search("Einstein");
 
``` |

### getTextStorageSettings() {#getTextStorageSettings--}

public final TextStorageSettings getTextStorageSettings()



Gets the text storage settings. The default value is  null , which means that document texts are not stored.

**Returns:**
[TextStorageSettings](../../com.groupdocs.search.options/textstoragesettings) - The text storage settings.

The example demonstrates how to set the text storage settings.

String indexFolder = “c:\MyIndex\”; String documentsFolder = “c:\MyDocuments\”; // Creating index settings instance IndexSettings settings = new IndexSettings(); settings.setTextStorageSettings(new TextStorageSettings(Compression.High)); // Setting high compression level for the index text storage // Creating an index in the specified folder Index index = new Index(indexFolder, settings); // Indexing documents index.add(documentsFolder); // Searching SearchResult result = index.search(“Einstein”);

### setTextStorageSettings(TextStorageSettings value) {#setTextStorageSettings-com.groupdocs.search.options.TextStorageSettings-}

public final void setTextStorageSettings(TextStorageSettings value)



Sets the text storage settings. The default value is  null , which means that document texts are not stored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [TextStorageSettings](../../com.groupdocs.search.options/textstoragesettings) | The text storage settings.

The example demonstrates how to set the text storage settings.


### getIndexType() {#getIndexType--}

public final IndexType getIndexType()



Gets the index type. The default value is  GroupDocs.Search.Options.IndexType.NormalIndex .

**Returns:**
[IndexType](../../com.groupdocs.search.options/indextype) - The index type.
### setIndexType(IndexType value) {#setIndexType-com.groupdocs.search.options.IndexType-}

public final void setIndexType(IndexType value)



Sets the index type. The default value is  GroupDocs.Search.Options.IndexType.NormalIndex .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [IndexType](../../com.groupdocs.search.options/indextype) | The index type. |

### getSearchThreads() {#getSearchThreads--}

public final NumberOfThreads getSearchThreads()



Gets the number of threads used for the search. The default value is  GroupDocs.Search.Options.NumberOfThreads.Default , which means that the search will be performed using the number of threads equal to the number of processor cores.

**Returns:**
[NumberOfThreads](../../com.groupdocs.search.options/numberofthreads) - The number of threads used for the search.
### setSearchThreads(NumberOfThreads value) {#setSearchThreads-com.groupdocs.search.options.NumberOfThreads-}

public final void setSearchThreads(NumberOfThreads value)



Sets the number of threads used for the search. The default value is  GroupDocs.Search.Options.NumberOfThreads.Default , which means that the search will be performed using the number of threads equal to the number of processor cores.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [NumberOfThreads](../../com.groupdocs.search.options/numberofthreads) | The number of threads used for the search. |

### getCustomExtractors() {#getCustomExtractors--}

public final CustomExtractorCollection getCustomExtractors()



Gets the custom extractor collection. The full example of implementing a custom extractor is presented in documentation for  GroupDocs.Search.Common.IFieldExtractor  interface.

**Returns:**
[CustomExtractorCollection](../../com.groupdocs.search.common/customextractorcollection) - The custom extractor collection.
### getLogger() {#getLogger--}

public final ILogger getLogger()



Gets a logger that is used for logging events and errors in the index. Note that the logger is not saved and must be created and assigned each time the index is created or loaded.

**Returns:**
[ILogger](../../com.groupdocs.search.common/ilogger) - A logger that is used for logging events and errors in the index.
### setLogger(ILogger value) {#setLogger-com.groupdocs.search.common.ILogger-}

public final void setLogger(ILogger value)



Sets a logger that is used for logging events and errors in the index. Note that the logger is not saved and must be created and assigned each time the index is created or loaded.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [ILogger](../../com.groupdocs.search.common/ilogger) | A logger that is used for logging events and errors in the index. |

Java: IndexUpdater

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public class IndexUpdater

Represents an index updater. This class performs reindexing documents in an index of an old version.

Learn more

Update index

The example demonstrates a typical usage of the class.


 String sourceIndexFolder = "c:\\MyOldIndex\\";
 String targetIndexFolder = "c:\\MyNewIndex\\";
 IndexUpdater updater = new IndexUpdater();
 if (updater.canUpdateVersion(sourceIndexFolder)) {
     int result = updater.updateVersion(sourceIndexFolder, targetIndexFolder);
 }

Constructors

Constructor	Description
IndexUpdater()	Initializes a new instance of the IndexUpdater class.

Methods

Method	Description
isLatestVersion(String indexPath)	Checks whether the specified directory contains an index of the latest version.
canUpdateVersion(String indexPath)	Checks whether an index in the specified directory can be updated to the latest version.
updateVersion(String indexPath, String newIndexPath)	Performs reindexing documents in an index of an old version.

IndexUpdater()

public IndexUpdater()

Initializes a new instance of the IndexUpdater class.

isLatestVersion(String indexPath)

public final boolean isLatestVersion(String indexPath)

Checks whether the specified directory contains an index of the latest version.

Parameters:

Parameter	Type	Description
indexPath	java.lang.String	The index directory path.

Returns: boolean - true if the specified directory contains an index of the latest version; otherwise false .

canUpdateVersion(String indexPath)

public final boolean canUpdateVersion(String indexPath)

Checks whether an index in the specified directory can be updated to the latest version.

Parameters:

Parameter	Type	Description
indexPath	java.lang.String	The index directory path.

Returns: boolean - true if an index in the specified directory can be updated to the latest version; otherwise false .

updateVersion(String indexPath, String newIndexPath)

public final VersionUpdateResult updateVersion(String indexPath, String newIndexPath)

Performs reindexing documents in an index of an old version. The updated index will be placed in the newIndexPath directory. The index in the indexPath directory will not be changed.

Parameters:

Parameter	Type	Description
indexPath	java.lang.String	The index directory path.
newIndexPath	java.lang.String	The directory for the updated index.

Returns: VersionUpdateResult - The result of the index version update operation.

Java: LicenseRestrictionException

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.aspose.ms.System.ApplicationException

public class LicenseRestrictionException extends System.ApplicationException

The exception that is thrown when a license restriction is triggered.

Constructors

Constructor	Description
LicenseRestrictionException(String message)	Initializes a new instance of the LicenseRestrictionException class.

LicenseRestrictionException(String message)

public LicenseRestrictionException(String message)

Initializes a new instance of the LicenseRestrictionException class.

Parameters:

Parameter	Type	Description
message	java.lang.String	The exception message.

Java: Notification

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public abstract class Notification

The base class for all notifications to the index. This class also contains methods for creating notification objects.

Learn more

Document renaming

Constructors

Constructor	Description
Notification()

Methods

Method	Description
createRenameNotification(String oldPath, String newPath)	Creates a notification object to rename an indexed document that has been renamed and does not need to be reindexed.

Notification()

public Notification()

createRenameNotification(String oldPath, String newPath)

public static Notification createRenameNotification(String oldPath, String newPath)

Creates a notification object to rename an indexed document that has been renamed and does not need to be reindexed. The renamed document will not be reindexed during the next update operation, even if its contents have been changed.

Parameters:

Parameter	Type	Description
oldPath	java.lang.String	The old path to the indexed document.
newPath	java.lang.String	The new path to the indexed document.

Returns: Notification - A new rename notification object.

Java: PleaseReportException

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException

public class PleaseReportException extends RuntimeException

Represents the exception that is thrown when an error occurred in the library.

Constructors

Constructor	Description
PleaseReportException(String message)	Initializes a new instance of the PleaseReportException class.
PleaseReportException()	Initializes a new instance of the PleaseReportException class.

PleaseReportException(String message)

public PleaseReportException(String message)

Initializes a new instance of the PleaseReportException class.

Parameters:

Parameter	Type	Description
message	java.lang.String	The message.

PleaseReportException()

public PleaseReportException()

Initializes a new instance of the PleaseReportException class.

Java: SearchDocumentFilter

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public class SearchDocumentFilter

Contains methods for creating search document filters.

Learn more

Constructors

Constructor	Description
SearchDocumentFilter()

Methods

Method	Description
createFilePathRegularExpression(String pattern)	Creates a filter for skipping documents that are not match a regular expression.
createFilePathRegularExpression(String pattern, int options)	Creates a filter for skipping documents that are not match a regular expression.
createFileExtension(String[] extensions)	Creates a filter for skipping documents that are not in the specified list of possible extensions.
createNot(ISearchDocumentFilter innerFilter)	Creates a filter that has inverse logic in relation to the specified inner filter.
createAnd(ISearchDocumentFilter[] filters)	Creates a logical conjunction of the specified filters.
createOr(ISearchDocumentFilter[] filters)	Creates a logical disjunction of the specified filters.
createAttribute(String[] attributes)	Creates a filter for skipping documents that do not have any value from the specified list of allowable attributes.

SearchDocumentFilter()

public SearchDocumentFilter()

createFilePathRegularExpression(String pattern)

public static ISearchDocumentFilter createFilePathRegularExpression(String pattern)

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

Parameters:

Parameter	Type	Description
pattern	java.lang.String	The regular expression pattern.

Returns: ISearchDocumentFilter - A search document filter by file name.

createFilePathRegularExpression(String pattern, int options)

public static ISearchDocumentFilter createFilePathRegularExpression(String pattern, int options)

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

Parameters:

Parameter	Type	Description
pattern	java.lang.String	The regular expression pattern.
options	int	The regular expression options.

Returns: ISearchDocumentFilter - A search document filter by file name.

createFileExtension(String[] extensions)

public static ISearchDocumentFilter createFileExtension(String[] extensions)

Creates a filter for skipping documents that are not in the specified list of possible extensions.

Parameters:

Parameter	Type	Description
extensions	java.lang.String[]	The list of possible extensions.

Returns: ISearchDocumentFilter - A search document filter by document extension.

createNot(ISearchDocumentFilter innerFilter)

public static ISearchDocumentFilter createNot(ISearchDocumentFilter innerFilter)

Creates a filter that has inverse logic in relation to the specified inner filter.

Parameters:

Parameter	Type	Description
innerFilter	ISearchDocumentFilter	The inner search document filter.

Returns: ISearchDocumentFilter - An inverted search document filter.

createAnd(ISearchDocumentFilter[] filters)

public static ISearchDocumentFilter createAnd(ISearchDocumentFilter[] filters)

Creates a logical conjunction of the specified filters.

Parameters:

Parameter	Type	Description
filters	ISearchDocumentFilter[]	The search document filters.

Returns: ISearchDocumentFilter - A search document filter that represents result of conjunction of the specified filters.

createOr(ISearchDocumentFilter[] filters)

public static ISearchDocumentFilter createOr(ISearchDocumentFilter[] filters)

Creates a logical disjunction of the specified filters.

Parameters:

Parameter	Type	Description
filters	ISearchDocumentFilter[]	The search document filters.

Returns: ISearchDocumentFilter - A search document filter that represents result of disjunction of the specified filters.

createAttribute(String[] attributes)

public static ISearchDocumentFilter createAttribute(String[] attributes)

Creates a filter for skipping documents that do not have any value from the specified list of allowable attributes.

Parameters:

Parameter	Type	Description
attributes	java.lang.String[]	The list of allowable attributes.

Returns: ISearchDocumentFilter - A search document filter by document attribute.

Java: SearchQuery

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public abstract class SearchQuery

Represents a search query in object form.

Learn more

The example demonstrates a typical usage of the class.


 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 
 // Creating subquery of date range search
 SearchQuery subquery1 = SearchQuery.createDateRangeQuery(new Date(2011, 6, 17), new Date(2013, 1, 1));
 
 // Creating subquery of wildcard with number of missed words from 0 to 2
 SearchQuery subquery2 = SearchQuery.createWildcardQuery(0, 2);
 
 // Creating subquery of simple word
 SearchQuery subquery3 = SearchQuery.createWordQuery("birth");
 subquery3.setSearchOptions(new SearchOptions()); // Setting search options only for subquery 3
 subquery3.getSearchOptions().getFuzzySearch().setEnabled(true);
 subquery3.getSearchOptions().getFuzzySearch().setFuzzyAlgorithm(new TableDiscreteFunction(1));
 
 // Combining subqueries into one query
 SearchQuery query = SearchQuery.createPhraseSearchQuery(subquery1, subquery2, subquery3);
 
 // Creating search options object with increased capacity of found occurrences
 SearchOptions options = new SearchOptions(); // Overall search options
 options.setMaxOccurrenceCountPerTerm(1000000);
 options.setMaxTotalOccurrenceCount(10000000);
 
 SearchResult result = index.search(query, options); // Searching

Methods

Method	Description
getFieldName()	Gets the field name.
getChildCount()	Gets the number of child queries.
getFirstChild()	Gets the first child query.
getSecondChild()	Gets the second child query.
getChild(int index)	Gets a child query by an index.
getSearchOptions()	Gets or sets the search options of this seach query.
setSearchOptions(SearchOptions value)	Gets or sets the search options of this seach query.
toString()	Returns a System.String that represents the current SearchQuery instance.
createWordQuery(String term)	Creates a simple word query.
createWordPatternQuery(WordPattern pattern)	Creates a word pattern query.
createRegexQuery(String pattern)	Creates a regular expression query.
createRegexQuery(String pattern, int options)	Creates a regular expression query.
createNumericRangeQuery(long start, long end)	Creates a numeric range query.
createDateRangeQuery(Date start, Date end)	Creates a date range query.
createPhraseSearchQuery(SearchQuery[] queries)	Creates a phrase search query.
createFieldQuery(String fieldName, SearchQuery query)	Adds a field to the specified query.
createNotQuery(SearchQuery query)	Creates an inverted query that will find the rest documents in an index against ones which will be found for the original query.
createAndQuery(SearchQuery leftQuery, SearchQuery rightQuery)	Creates a combined query that will find only documents which will be found for each original query.
createOrQuery(SearchQuery leftQuery, SearchQuery rightQuery)	Creates a combined query that will find all the documents which will be found at least for one of the original queries.
createWildcardQuery(int count)	Creates a wildcard for the phrase search.
createWildcardQuery(int minCount, int maxCount)	Creates a wildcard for the phrase search.

getFieldName()

public String getFieldName()

Gets the field name.

Returns: java.lang.String - The field name.

getChildCount()

public int getChildCount()

Gets the number of child queries.

Returns: int - The number of child queries.

getFirstChild()

public SearchQuery getFirstChild()

Gets the first child query.

Returns: SearchQuery - The first child query.

getSecondChild()

public SearchQuery getSecondChild()

Gets the second child query.

Returns: SearchQuery - The second child query.

getChild(int index)

public abstract SearchQuery getChild(int index)

Gets a child query by an index.

Parameters:

Parameter	Type	Description
index	int	The index.

Returns: SearchQuery - A child query corresponding the specified index.

getSearchOptions()

public final SearchOptions getSearchOptions()

Gets or sets the search options of this seach query.

Returns: SearchOptions - The search options.

setSearchOptions(SearchOptions value)

public final void setSearchOptions(SearchOptions value)

Gets or sets the search options of this seach query.

Parameters:

Parameter	Type	Description
value	SearchOptions	The search options.

toString()

public abstract String toString()

Returns a System.String that represents the current SearchQuery instance.

Returns: java.lang.String - A System.String that represents the current SearchQuery instance.

createWordQuery(String term)

public static SearchQuery createWordQuery(String term)

Creates a simple word query.

Parameters:

Parameter	Type	Description
term	java.lang.String	The term to search for.

Returns: SearchQuery - A simple word query.

createWordPatternQuery(WordPattern pattern)

public static SearchQuery createWordPatternQuery(WordPattern pattern)

Creates a word pattern query.

Parameters:

Parameter	Type	Description
pattern	WordPattern	The word pattern.

Returns: SearchQuery - A word pattern query.

createRegexQuery(String pattern)

public static SearchQuery createRegexQuery(String pattern)

Creates a regular expression query.

Parameters:

Parameter	Type	Description
pattern	java.lang.String	The regular expression pattern to match.

Returns: SearchQuery - A regular expression query.

createRegexQuery(String pattern, int options)

public static SearchQuery createRegexQuery(String pattern, int options)

Creates a regular expression query.

Parameters:

Parameter	Type	Description
pattern	java.lang.String	The regular expression pattern to match.
options	int	A bitwise combination of the enumeration values that modify the regular expression. This value must contain RegexOptions.IgnoreCase flag.

Returns: SearchQuery - A regular expression query.

createNumericRangeQuery(long start, long end)

public static SearchQuery createNumericRangeQuery(long start, long end)

Creates a numeric range query.

Parameters:

Parameter	Type	Description
start	long	The start value of a range.
end	long	The end value of a range.

Returns: SearchQuery - A numeric range query.

createDateRangeQuery(Date start, Date end)

public static SearchQuery createDateRangeQuery(Date start, Date end)

Creates a date range query.

Parameters:

Parameter	Type	Description
start	java.util.Date	The start value of a range.
end	java.util.Date	The end value of a range.

Returns: SearchQuery - A date range query.

createPhraseSearchQuery(SearchQuery[] queries)

public static SearchQuery createPhraseSearchQuery(SearchQuery[] queries)

Creates a phrase search query.

Parameters:

Parameter	Type	Description
queries	SearchQuery[]	The child queries.

Returns: SearchQuery - A phrase search query.

createFieldQuery(String fieldName, SearchQuery query)

public static SearchQuery createFieldQuery(String fieldName, SearchQuery query)

Adds a field to the specified query.

Parameters:

Parameter	Type	Description
fieldName	java.lang.String	The field name to search in.
query	SearchQuery	The query to add the field.

Returns: SearchQuery - A query with the field to search in.

createNotQuery(SearchQuery query)

public static SearchQuery createNotQuery(SearchQuery query)

Creates an inverted query that will find the rest documents in an index against ones which will be found for the original query.

Parameters:

Parameter	Type	Description
query	SearchQuery	The query to invert.

Returns: SearchQuery - A combined NOT query.

createAndQuery(SearchQuery leftQuery, SearchQuery rightQuery)

public static SearchQuery createAndQuery(SearchQuery leftQuery, SearchQuery rightQuery)

Creates a combined query that will find only documents which will be found for each original query.

Parameters:

Parameter	Type	Description
leftQuery	SearchQuery	The left child query.
rightQuery	SearchQuery	The right child query.

Returns: SearchQuery - A combined AND query.

createOrQuery(SearchQuery leftQuery, SearchQuery rightQuery)

public static SearchQuery createOrQuery(SearchQuery leftQuery, SearchQuery rightQuery)

Creates a combined query that will find all the documents which will be found at least for one of the original queries.

Parameters:

Parameter	Type	Description
leftQuery	SearchQuery	The left child query.
rightQuery	SearchQuery	The right child query.

Returns: SearchQuery - A combined OR query.

createWildcardQuery(int count)

public static SearchQuery createWildcardQuery(int count)

Creates a wildcard for the phrase search.

Parameters:

Parameter	Type	Description
count	int	The number of words in the wildcard.

Returns: SearchQuery - A wildcard for the phrase search.

createWildcardQuery(int minCount, int maxCount)

public static SearchQuery createWildcardQuery(int minCount, int maxCount)

Creates a wildcard for the phrase search.

Parameters:

Parameter	Type	Description
minCount	int	The minimum number of words in the wildcard.
maxCount	int	The maximum number of words in the wildcard.

Returns: SearchQuery - A wildcard for the phrase search.