com.groupdocs.search.events

Class FileIndexingEventArgs

java.lang.Object

com.groupdocs.search.events.EventArgs

com.groupdocs.search.events.BaseIndexEventArgs

com.groupdocs.search.events.FileIndexingEventArgs

public class FileIndexingEventArgs
extends BaseIndexEventArgs

Represents arguments for the event of a document indexing start.

Learn more

• Search index events

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileIndexingEventArgs(com.aspose.ms.System.Guid indexId, String indexFolder, IndexStatus status, Document document) Initializes a new instance of the FileIndexingEventArgs class.

Method Summary

Modifier and Type	Method and Description
protected static FileIndexingEventArgs	create(com.aspose.ms.System.Guid indexId, String indexFolder, IndexStatus status, Document document)
DocumentField[]	getAdditionalFields() Gets the additional fields for the document.
String[]	getAttributes() Gets the attributes of the document.
IFieldExtractor	getCustomExtractor() Gets the custom text extractor.
Document	getDocument() Gets the document.
String	getDocumentFullPath() Gets the document full path.
String	getDocumentKey() Gets the document key.
String	getEncoding() Gets the encoding of the document.
boolean	getSkipIndexing() Gets a value indicating that indexing of the document should be skipped.
void	setAdditionalFields(DocumentField[] value) Sets the additional fields for the document.
void	setAttributes(String[] value) Set the attributes of the document.
void	setCustomExtractor(IFieldExtractor value) Sets the custom text extractor.
void	setEncoding(String value) Sets the encoding of the document.
void	setSkipIndexing(boolean value) Sets a value indicating that indexing of the document should be skipped.

Methods inherited from class com.groupdocs.search.events.BaseIndexEventArgs

create, getIndexFolder, getIndexId, getStatus, getTime

Methods inherited from class java.lang.Object

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

Constructor Detail

FileIndexingEventArgs

protected FileIndexingEventArgs(com.aspose.ms.System.Guid indexId,
                                String indexFolder,
                                IndexStatus status,
                                Document document)

Initializes a new instance of the FileIndexingEventArgs class.

Parameters:

indexId - The index ID.

indexFolder - The index folder.

status - The status.

document - The adding document.

Method Detail

create

protected static FileIndexingEventArgs create(com.aspose.ms.System.Guid indexId,
                                              String indexFolder,
                                              IndexStatus status,
                                              Document document)

getAdditionalFields

public final DocumentField[] getAdditionalFields()

Gets the additional fields for the document.

Returns:

The additional fields for the document.

getAttributes

public final String[] getAttributes()

Gets the attributes of the document.

Returns:

The attributes of the document.

getCustomExtractor

public final IFieldExtractor getCustomExtractor()

Gets the custom text extractor.

Returns:

The custom text extractor.

getDocument

public final Document getDocument()

Gets the document.

Returns:

The document.

getDocumentFullPath

public final String getDocumentFullPath()

Gets the document full path.

Returns:

The document full path.

getDocumentKey

public final String getDocumentKey()

Gets the document key.

Returns:

The document key.

getEncoding

public final String getEncoding()

Gets the encoding of the document.

Returns:

The encoding of the document.

getSkipIndexing

public final boolean getSkipIndexing()

Gets a value indicating that indexing of the document should be skipped.

Returns:

A value indicating that indexing of the document should be skipped.

setAdditionalFields

public final void setAdditionalFields(DocumentField[] value)

Sets the additional fields for the document.

Parameters:

value - The additional fields for the document.

setAttributes

public final void setAttributes(String[] value)

Set the attributes of the document.

Parameters:

value - The attributes of the document.

setCustomExtractor

public final void setCustomExtractor(IFieldExtractor value)

Sets the custom text extractor.

Parameters:

value - The custom text extractor.

setEncoding

public final void setEncoding(String value)

Sets the encoding of the document.

Parameters:

value - The encoding of the document.

setSkipIndexing

public final void setSkipIndexing(boolean value)

Sets a value indicating that indexing of the document should be skipped.

Parameters:

value - A value indicating that indexing of the document should be skipped.