FileIndexingEventArgs
Inheritance: java.lang.Object, com.groupdocs.search.events.EventArgs, com.groupdocs.search.events.BaseIndexEventArgs
public class FileIndexingEventArgs extends BaseIndexEventArgs
Represents arguments for the event of a document indexing start.
Learn more
Methods
| Method | Description |
|---|---|
| getDocument() | Gets the document. |
| getDocumentFullPath() | Gets the document full path. |
| getDocumentKey() | Gets the document key. |
| getSkipIndexing() | Gets a value indicating that indexing of the document should be skipped. |
| setSkipIndexing(boolean value) | Sets a value indicating that indexing of the document should be skipped. |
| getEncoding() | Gets the encoding of the document. |
| setEncoding(String value) | Sets the encoding of the document. |
| getCustomExtractor() | Gets the custom text extractor. |
| setCustomExtractor(IFieldExtractor value) | Sets the custom text extractor. |
| 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) | Set the attributes of the document. |
getDocument()
public final Document getDocument()
Gets the document.
Returns: Document - The document.
getDocumentFullPath()
public final String getDocumentFullPath()
Gets the document full path.
Returns: java.lang.String - The document full path.
getDocumentKey()
public final String getDocumentKey()
Gets the document key.
Returns: java.lang.String - The document key.
getSkipIndexing()
public final boolean getSkipIndexing()
Gets a value indicating that indexing of the document should be skipped.
Returns: boolean - A value indicating that indexing of the document should be skipped.
setSkipIndexing(boolean value)
public final void setSkipIndexing(boolean value)
Sets a value indicating that indexing of the document should be skipped.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A value indicating that indexing of the document should be skipped. |
getEncoding()
public final String getEncoding()
Gets the encoding of the document.
Returns: java.lang.String - The encoding of the document.
setEncoding(String value)
public final void setEncoding(String value)
Sets the encoding of the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The encoding of the document. |
getCustomExtractor()
public final IFieldExtractor getCustomExtractor()
Gets the custom text extractor.
Returns: IFieldExtractor - The custom text extractor.
setCustomExtractor(IFieldExtractor value)
public final void setCustomExtractor(IFieldExtractor value)
Sets the custom text extractor.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IFieldExtractor | The custom text extractor. |
getAdditionalFields()
public final 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 final 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 final String[] getAttributes()
Gets the attributes of the document.
Returns: java.lang.String[] - The attributes of the document.
setAttributes(String[] value)
public final void setAttributes(String[] value)
Set the attributes of the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String[] | The attributes of the document. |