dtsearch Text Retrieval Engine -- Java API

Transcription

1 dtsearch Text Retrieval Engine -- API Copyright (c) dtsearch Corp. All rights reserved.

2 dtsearch Text Retrieval Engine -- Table of Contents dtsearch Engine API 1 com.dtsearch.engine Package 2 Interfaces 3 DataSource2 Class 3 DataSource2.getDocError Method 4 DataSource2.getDocId Method 4 DataSource2.getDocTypeId Method 4 DataSource2.getDocWordCount Method 4 DataSource2.haveDocBytes Method 4 DataSource2.setDocBytes Method 5 DataSource2.wasDocError Method 5 IIndexStatusHandler Interface 5 IIndexStatusHandler.checkForAbort Method 6 IIndexStatusHandler.onProgressUpdate Method 7 DataSource Interface 7 DataSource.getDocCreatedDate Method 8 DataSource.getDocDisplayName Method 8 DataSource.getDocFields Method 9 DataSource.getDocIsFile Method 9 DataSource.getDocModifiedDate Method 9 DataSource.getDocName Method 9 DataSource.getDocText Method 9 DataSource.getNextDoc Method 10 DataSource.rewind Method 10 Classes 11 ExtractionOptions Class 11 ExtractionOptions.setAllowedExtensions Method 13 ExtractionOptions.setDefaultExtension Method 13 ExtractionOptions.setFilenamePrefix Method 13 ExtractionOptions.setFlags Method 14 ExtractionOptions.setOutputFileListName Method 14 ExtractionOptions.setOutputLocation Method 14 ExtractionOptions.setOutputReference Method 14 ii

3 dtsearch Text Retrieval Engine -- ExtractionOptions.setUnnamedAttachmentLinkText Method 14 FileConverter Class 15 FileConverter.execute Method 17 FileConverter.getDetectedTypeId Method 17 FileConverter.getErrors Method 17 FileConverter.getInputFile Method 17 FileConverter.getOutputFile Method 17 FileConverter.getOutputFormat Method 18 FileConverter.getOutputString Method 18 FileConverter.setAfterHit Method 18 FileConverter.setAlphabetLocation Method 18 FileConverter.setBaseHref Method 19 FileConverter.setBeforeHit Method 19 FileConverter.setDocBytes Method 19 FileConverter.setDocFields Method 19 FileConverter.setDocText Method 19 FileConverter.setExtractionOptions Method 20 FileConverter.setFlags Method 20 FileConverter.setFooter Method 20 FileConverter.setHeader Method 20 FileConverter.setHits Method 20 FileConverter.setHitsByWord Method 21 FileConverter.setInputFile Method 21 FileConverter.setInputItem Method 21 FileConverter.setOutputFile Method 21 FileConverter.setOutputFormat Method 21 FileConverter.setOutputStringMaxSize Method 22 FileConverter.setOutputToString Method 22 FileConverter.setTimeoutSeconds Method 22 IndexJob Class 22 IndexJob.execute Method 25 IndexJob.getErrors Method 25 IndexJob.getIndexInfo Method 25 IndexJob.getStatusIndexingStep Method 25 IndexJob.getStatusPercentDone Method 26 IndexJob.setActionAdd Method 26 IndexJob.setActionCompress Method 27 IndexJob.setActionCreate Method 27 IndexJob.setActionMerge Method 28 IndexJob.setActionRemoveDeleted Method 28 IndexJob.setActionRemoveListed Method 29 iii

4 dtsearch Text Retrieval Engine -- IndexJob.setActionVerify Method 30 IndexJob.setAutoCommitIntervalMB Method 30 IndexJob.setCreateAccentSensitive Method 31 IndexJob.setCreateCaseSensitive Method 31 IndexJob.setCreateRelativePaths Method 31 IndexJob.setDataSourceToIndex Method 31 IndexJob.setEnumerableFields Method 31 IndexJob.setExcludeFilters Method 32 IndexJob.setFoldersToIndex Method 32 IndexJob.setIncludeFilters Method 33 IndexJob.setIndexesToMerge Method 33 IndexJob.setIndexingFlags Method 33 IndexJob.setIndexName Method 33 IndexJob.setIndexPath Method 34 IndexJob.setMaxMemToUseMB Method 34 IndexJob.setStartingDocId Method 34 IndexJob.setStatusHandler Method 34 IndexJob.setStatusHandler2 Method 35 IndexJob.setStoredFields Method 35 IndexJob.setTempFileDir Method 35 IndexJob.setTimeoutSeconds Method 36 IndexJob.setToRemoveListName Method 36 IndexCache Class 36 IndexCache.closeIndex Method 37 IndexCache.getInUseCount Method 38 IndexCache.getMaxCount Method 38 IndexCache.getOpenIndexCount Method 38 IndexCache.IndexCache Constructor 38 IndexCache.setAutoCloseTime Method 38 IndexCache.setAutoReopenTime Method 39 JobErrorInfo Class 39 JobErrorInfo.getArg1 Method 40 JobErrorInfo.getArg2 Method 40 JobErrorInfo.getCode Method 40 JobErrorInfo.getCount Method 40 JobErrorInfo.getMessage Method 41 IndexFileInfo Class 41 IndexFileInfo.bytesRead Field 41 IndexFileInfo.displayName Field 42 IndexFileInfo.docId Field 42 IndexFileInfo.flags Field 42 iv

5 dtsearch Text Retrieval Engine -- IndexFileInfo.fullname Field 42 IndexFileInfo.location Field 42 IndexFileInfo.name Field 42 IndexFileInfo.openFailMessage Field 43 IndexFileInfo.percentDone Field 43 IndexFileInfo.size Field 43 IndexFileInfo.type Field 43 IndexFileInfo.typeId Field 43 IndexFileInfo.wordCount Field 43 Options Class 44 Options.get Method 45 Options.getStemmingRulesFile Method 45 Options.getStoredFieldDelimiterChar Method 46 Options.getTextFlags Method 46 Options.getUnicodeFilterRanges Method 46 Options.save Method 46 Options.setAlphabetFile Method 46 Options.setBinaryFiles Method 46 Options.setBinaryFilterTextChars Method 47 Options.setBooleanConnectors Method 47 Options.setFieldFlags Method 47 Options.setFileTypeTableFile Method 47 Options.setFuzzyChar Method 47 Options.setHomeDir Method 47 Options.setHyphens Method 48 Options.setIndexNumbers Method 48 Options.setLzwEnableCode Method 48 Options.setMacroChar Method 48 Options.setMatchDigitChar Method 48 Options.setMaxStoredFieldSize Method 48 Options.setMaxWordLength Method 49 Options.setMaxWordsToRetrieve Method 49 Options.setNoiseWordFile Method 49 Options.setPhonicChar Method 49 Options.setPrivateDir Method 49 Options.setSegmentationRulesFile Method 50 Options.setStemmingChar Method 50 Options.setStemmingRulesFile Method 50 Options.setStoredFieldDelimiterChar Method 50 Options.setSynonymChar Method 50 Options.setTempFileDir Method 51 Options.setTextFieldsFile Method 51 v

6 dtsearch Text Retrieval Engine -- Options.setTextFlags Method 51 Options.setTitleSize Method 51 Options.setUnicodeFilterBlockSize Method 51 Options.setUnicodeFilterFlags Method 52 Options.setUnicodeFilterRanges Method 52 Options.setUpdateFiles Method 52 Options.setUserThesaurusFile Method 52 Options.setWeightChar Method 52 Options.setXmlIgnoreTags Method 53 IndexInfo Class 53 IndexInfo.compressedDate Field 54 IndexInfo.createdDate Field 54 IndexInfo.docCount Field 54 IndexInfo.flags Field 54 IndexInfo.fragmentation Field 54 IndexInfo.indexSize Field 55 IndexInfo.lastDocId Field 55 IndexInfo.obsoleteCount Field 55 IndexInfo.percentFull Field 55 IndexInfo.startingDocId Field 55 IndexInfo.structureVersion Field 55 IndexInfo.updatedDate Field 56 IndexInfo.wordCount Field 56 IndexInfo.get Method 56 IndexInfo.IndexInfo Constructor 56 SearchFilter Class 56 SearchFilter.addIndex Method 58 SearchFilter.and Method 58 SearchFilter.andNot Method 58 SearchFilter.clear Method 58 SearchFilter.equals Method 59 SearchFilter.getIndexCount Method 59 SearchFilter.getIndexPath Method 59 SearchFilter.getItems Method 59 SearchFilter.or Method 60 SearchFilter.read Method 60 SearchFilter.readMultiple Method 60 SearchFilter.selectAll Method 60 selectitems Method 61 SearchFilter.selectItems Method (int, int[], boolean) 61 SearchFilter.selectItems Method (int, long, long, boolean) 61 vi

7 dtsearch Text Retrieval Engine -- SearchFilter.selectItemsBySearch Method 61 SearchFilter.selectNone Method 62 SearchFilter.write Method 62 SearchJob Class 62 SearchJob.clear Method 64 SearchJob.execute Method 65 SearchJob.getErrors Method 65 SearchJob.getFileCount Method 65 SearchJob.getHitCount Method 65 SearchJob.getResults Method 65 SearchJob.getResultsAsFilter Method 65 SearchJob.setAutoStopLimit Method 66 SearchJob.setBooleanConditions Method 66 SearchJob.setDirListName Method 66 SearchJob.setDirToSearch Method 66 SearchJob.setExcludeFilters Method 66 SearchJob.setFieldWeights Method 67 SearchJob.setFileConditions Method 67 SearchJob.setFilter Method 67 SearchJob.setFuzziness Method 67 SearchJob.setIncludeFilters Method 68 SearchJob.setIndexCache Method 68 SearchJob.setIndexesToSearch Method 68 SearchJob.setMaxFilesToRetrieve Method 68 SearchJob.setNaturalLanguage Method 69 SearchJob.setPhonicSearching Method 69 SearchJob.setRequest Method 69 SearchJob.setResults Method 69 SearchJob.setSearchFlags Method 69 SearchJob.setStatusHandler Method 70 SearchJob.setStemming Method 70 SearchJob.setSynonyms Method 70 SearchJob.setTimeoutSeconds Method 71 SearchJob.setUnindexedSearchFlags Method 71 SearchJob.setUserSynonyms Method 71 SearchJob.setWantResultsAsFilter Method 72 SearchJob.setWordNetRelated Method 72 SearchJob.setWordNetSynonyms Method 73 IndexProgressInfo Class 74 IndexProgressInfo.binaryCount Field 75 IndexProgressInfo.bytesRead Field 75 vii

8 dtsearch Text Retrieval Engine -- IndexProgressInfo.bytesToIndex Field 75 IndexProgressInfo.currMergePercent Field 75 IndexProgressInfo.docBytesRead Field 75 IndexProgressInfo.docsInIndex Field 75 IndexProgressInfo.docsRead Field 76 IndexProgressInfo.elapsedSeconds Field 76 IndexProgressInfo.encryptedCount Field 76 IndexProgressInfo.estRemainingSeconds Field 76 IndexProgressInfo.file Field 76 IndexProgressInfo.filesChecked Field 76 IndexProgressInfo.filesRead Field 77 IndexProgressInfo.filesToCheck Field 77 IndexProgressInfo.filesToIndex Field 77 IndexProgressInfo.indexPath Field 77 IndexProgressInfo.indexPercentFull Field 77 IndexProgressInfo.openFailures Field 77 IndexProgressInfo.partiallyCorruptCount Field 78 IndexProgressInfo.partiallyEncryptedCount Field 78 IndexProgressInfo.percentDone Field 78 IndexProgressInfo.step Field 78 IndexProgressInfo.updateType Field 78 IndexProgressInfo.wordsInIndex Field 78 SearchReportJob Class 79 SearchReportJob.clear Method 81 SearchReportJob.clearSelections Method 81 SearchReportJob.execute Method 81 SearchReportJob.getErrors Method 81 SearchReportJob.getOutputString Method 81 SearchReportJob.selectAll Method 82 SearchReportJob.selectItems Method 82 SearchReportJob.setAfterHit Method 82 SearchReportJob.setBeforeHit Method 82 SearchReportJob.setContextFooter Method 82 SearchReportJob.setContextHeader Method 82 SearchReportJob.setContextSeparator Method 83 SearchReportJob.setDocBytes Method 83 SearchReportJob.setFileFooter Method 83 SearchReportJob.setFileHeader Method 83 SearchReportJob.setFlags Method 83 SearchReportJob.setFooter Method 83 SearchReportJob.setHeader Method 84 SearchReportJob.setMaxContextBlocks Method 84 viii

9 dtsearch Text Retrieval Engine -- SearchReportJob.setMaxWordsToRead Method 84 SearchReportJob.setOutputFile Method 84 SearchReportJob.setOutputFormat Method 84 SearchReportJob.setOutputStringMaxSize Method 85 SearchReportJob.setOutputToString Method 85 SearchReportJob.setParagraphsOfContext Method 85 SearchReportJob.setResults Method 85 SearchReportJob.setTimeoutSeconds Method 86 SearchReportJob.setWordsOfContext Method 86 SearchReportJob.setWordsOfContextExact Method 86 SearchResults Class 86 SearchResults.stSortAscending Field 88 SearchResults.stSortByDate Field 88 SearchResults.stSortByHits Field 88 SearchResults.stSortByIndex Field 88 SearchResults.stSortByLocation Field 89 SearchResults.stSortByName Field 89 SearchResults.stSortBySize Field 89 SearchResults.stSortByTime Field 89 SearchResults.stSortByTitle Field 89 SearchResults.stSortByType Field 89 SearchResults.stSortByUserField Field 90 SearchResults.stSortCaseInsensitive Field 90 SearchResults.stSortDescending Field 90 SearchResults.stSortNumeric Field 90 SearchResults.addDoc Method 90 SearchResults.empty Method 90 SearchResults.getCount Method 91 SearchResults.getDocCalendar Method 91 SearchResults.getDocDate Method 91 SearchResults.getDocDetailItem Method 91 SearchResults.getDocDetailItems Method 92 SearchResults.getDocDetailMap Method 92 SearchResults.getDocDisplayName Method 93 SearchResults.getDocHitCount Method 93 SearchResults.getDocHits Method 93 SearchResults.getDocId Method 93 SearchResults.getDocName Method 93 SearchResults.getDocSize Method 93 SearchResults.getDocTypeId Method 94 SearchResults.getHitByteOffsets Method 94 SearchResults.getHitBytePageParaOffsets Method 94 ix

10 dtsearch Text Retrieval Engine -- SearchResults.getNthDoc Method 94 SearchResults.getRequest Method 95 SearchResults.getTotalFileCount Method 95 SearchResults.getTotalHitCount Method 95 SearchResults.makePdfWebHighlightFile Method 95 SearchResults.newSearchReportJob Method 95 SearchResults.serializeAsXml Method 96 SearchResults.serializeFromXml Method 96 SearchResults.serializeItemAsXml Method 96 SearchResults.setSortKey Method 96 sort Method 96 SearchResults.sort Method (int) 96 SearchResults.sort Method (int, String) 97 SearchResults.urlDecodeItem Method 97 SearchResults.urlEncodeItem Method 97 Server Class 97 Server.addToLog Method 98 Server.convertPath Method 98 Server.getBuildNumber Method 99 Server.getInitMessage Method 99 Server.getMajorVersion Method 99 Server.getMinorVersion Method 99 Server.initialize Method 99 Server.setDebugLogging Method 99 Server.setDebugLogName Method 100 Server.setHomeDir Method 100 Server.setLzwEnableCode Method 100 Server.setPrivateDir Method 100 Server.shutdown Method 100 ListIndexFlags Class 100 ListIndexFlags.dtsListIndexFields Field 101 ListIndexFlags.dtsListIndexFiles Field 101 ListIndexFlags.dtsListIndexIncludeCount Field 101 ListIndexFlags.dtsListIndexIncludeDocCount Field 102 ListIndexFlags.dtsListIndexIncludeDocId Field 102 ListIndexFlags.dtsListIndexIncludeDocInfoAsXml Field 102 ListIndexFlags.dtsListIndexIncludeField Field 102 ListIndexFlags.dtsListIndexReturnString Field 102 ListIndexFlags.dtsListIndexSkipNoiseWords Field 102 ListIndexFlags.dtsListIndexWords Field 103 ListIndexFlags.dtsListTabDelimit Field 103 x

11 dtsearch Text Retrieval Engine -- WordListBuilder Class 103 WordListBuilder.closeIndex Method 104 WordListBuilder.getCount Method 104 WordListBuilder.getLastError Method 104 WordListBuilder.getNthWord Method 105 WordListBuilder.getNthWordCount Method 105 WordListBuilder.getNthWordDocCount Method 105 WordListBuilder.listFields Method 105 WordListBuilder.listFieldValues Method 105 WordListBuilder.listMatchingWords Method 106 WordListBuilder.listWords Method 107 WordListBuilder.openIndex Method 107 WordListBuilder.setFilter Method 107 WordListBuilder.setFlags Method 107 WordListBuilder.sort Method 107 ListIndexJob Class 108 ListIndexJob.execute Method 108 ListIndexJob.getErrors Method 108 ListIndexJob.getIndexPath Method 109 ListIndexJob.getOutputFile Method 109 ListIndexJob.getOutputString Method 109 ListIndexJob.getOutputStringMaxSize Method 109 ListIndexJob.getToMatch Method 109 ListIndexJob.setFlags Method 109 ListIndexJob.setFuzziness Method 110 ListIndexJob.setIndexPath Method 110 ListIndexJob.setOutputFile Method 110 ListIndexJob.setOutputStringMaxSize Method 110 ListIndexJob.setOutputToString Method 110 ListIndexJob.setTimeoutSeconds Method 110 ListIndexJob.setToMatch Method 111 Constants 112 AbortValue Class 112 AbortValue.Cancel Field 113 AbortValue.CancelImmediately Field 113 AbortValue.Continue Field 113 BinaryFilesSettings Class 113 BinaryFilesSettings.dtsoFilterBinary Field 114 BinaryFilesSettings.dtsoFilterBinaryUnicode Field 114 xi

12 dtsearch Text Retrieval Engine -- BinaryFilesSettings.dtsoIndexBinary Field 114 BinaryFilesSettings.dtsoIndexBinaryNoContent Field 114 BinaryFilesSettings.dtsoIndexSkipBinary Field 115 ConvertFlags Class 115 ConvertFlags.dtsConvertAutoUpdateSearch Field 116 ConvertFlags.dtsConvertExtractOnly Field 116 ConvertFlags.dtsConvertGetFromCache Field 116 ConvertFlags.dtsConvertIncludeBOM Field 117 ConvertFlags.dtsConvertInlineContainer Field 117 ConvertFlags.dtsConvertInputIsHtml Field 117 ConvertFlags.dtsConvertInputIsNotHtml Field 117 ConvertFlags.dtsConvertJustDetectType Field 117 ConvertFlags.dtsConvertMultiHighlight Field 117 ConvertFlags.dtsConvertRemoveScripts Field 118 ConvertFlags.dtsConvertSkipHiddenHits Field 118 ConvertFlags.dtsConvertUseStyles Field 118 ConvertFlags.dtsConvertXmlToXml Field 118 ConvertPathFlags Class 118 ConvertPathFlags.dtsCpMakeLocal Field 119 ConvertPathFlags.dtsCpMakeUNC Field 119 ConvertPathFlags.dtsCpMakeVirtual Field 119 ConvertPathFlags.dtsCpReadFromRegistry Field 119 ConvertPathFlags.dtsCpRefreshMappings Field 120 ConvertPathFlags.dtsCpStoreInRegistry Field 120 DebugLogFlags Class 120 DebugLogFlags.dtsCrashLog Field 120 DebugLogFlags.dtsLogAppend Field 121 DebugLogFlags.dtsLogCommit Field 121 DebugLogFlags.dtsLogTime Field 121 DebugLogFlags.dtsLogTruncate Field 121 ErrorCodes Class 121 ErrorCodes.dtsAskDiskFullOverride Field 123 ErrorCodes.dtsErAccCachedDoc Field 123 ErrorCodes.dtsErAccDirectory Field 123 ErrorCodes.dtsErAccessDenied Field 123 ErrorCodes.dtsErAccFile Field 124 ErrorCodes.dtsErAccIndex Field 124 ErrorCodes.dtsErApiError Field 124 ErrorCodes.dtsErBadRequest Field 124 ErrorCodes.dtsErBlankFilename Field 124 ErrorCodes.dtsErCommitFailed Field 124 xii

13 dtsearch Text Retrieval Engine -- ErrorCodes.dtsErConflictingDocIdRanges Field 125 ErrorCodes.dtsErConnectFailed Field 125 ErrorCodes.dtsErCreateFailed Field 125 ErrorCodes.dtsErDataSourceException Field 125 ErrorCodes.dtsErDiskFull Field 125 ErrorCodes.dtsErFileCorrupt Field 125 ErrorCodes.dtsErFileEmpty Field 126 ErrorCodes.dtsErFileEncrypted Field 126 ErrorCodes.dtsErFileNotFound Field 126 ErrorCodes.dtsErIndexFull Field 126 ErrorCodes.dtsErIndexingError Field 126 ErrorCodes.dtsErInvalidHandle Field 126 ErrorCodes.dtsErIxCorrupt Field 127 ErrorCodes.dtsErIxInterrupted Field 127 ErrorCodes.dtsErIxWrongVersion Field 127 ErrorCodes.dtsErLowMemory Field 127 ErrorCodes.dtsErMaxWords Field 127 ErrorCodes.dtsErNoFilesRetrieved Field 127 ErrorCodes.dtsErOK Field 128 ErrorCodes.dtsErOpenTemp Field 128 ErrorCodes.dtsErOutOfMemory Field 128 ErrorCodes.dtsErPdfLzwNotLicensed Field 128 ErrorCodes.dtsErRequestTooLong Field 128 ErrorCodes.dtsErSearchLimitReached Field 128 ErrorCodes.dtsErSearchRequestEmpty Field 129 ErrorCodes.dtsErTimeout Field 129 ErrorCodes.dtsErUnknownException Field 129 ErrorCodes.dtsErWorkDirFail Field 129 ErrorCodes.dtsErWrFile Field 129 ErrorCodes.dtsInfNoFilesToIndex Field 129 ExtractionOptionsFlags Class 130 ExtractionOptionsFlags.dtsExoDoNotConvertAttachments Field 130 ExtractionOptionsFlags.dtsExoExtractAttachments Field 131 ExtractionOptionsFlags.dtsExoExtractImages Field 131 ExtractionOptionsFlags.dtsExoLimitExtensions Field 131 ExtractionOptionsFlags.dtsExoMarkAsInternetZone Field 131 ExtractionOptionsFlags.dtsExoUseSimpleFilenames Field 131 FieldFlags Class 132 FieldFlags.dtsoFfHtmlNoHeaderFields Field 134 FieldFlags.dtsoFfHtmlShowComments Field 134 FieldFlags.dtsoFfHtmlShowHiddenContent Field 134 xiii

14 dtsearch Text Retrieval Engine -- FieldFlags.dtsoFfHtmlShowImgSrc Field 134 FieldFlags.dtsoFfHtmlShowLinks Field 134 FieldFlags.dtsoFfHtmlShowMetatags Field 134 FieldFlags.dtsoFfHtmlShowNoframesContent Field 135 FieldFlags.dtsoFfHtmlShowScripts Field 135 FieldFlags.dtsoFfHtmlShowStylesheets Field 135 FieldFlags.dtsoFfHtmlSkipImageAlt Field 135 FieldFlags.dtsoFfHtmlSkipInputValues Field 135 FieldFlags.dtsoFfIncludeDocumentPropertiesCaption Field 135 FieldFlags.dtsoFfIncludeFileTypeField Field 136 FieldFlags.dtsoFfIncludeFileTypeIdField Field 136 FieldFlags.dtsoFfIndexArchiveFileLists Field 136 FieldFlags.dtsoFfOfficeSkipHiddenContent Field 136 FieldFlags.dtsoFfPdfShowLinks Field 137 FieldFlags.dtsoFfPdfSkipAttachments Field 137 FieldFlags.dtsoFfShowImageProperties Field 137 FieldFlags.dtsoFfShowNtfsProperties Field 137 FieldFlags.dtsoFfSkipDataSourceFields Field 137 FieldFlags.dtsoFfSkipDocumentProperties Field 138 FieldFlags.dtsoFfSkip Headers Field 138 FieldFlags.dtsoFfSkip Properties Field 138 FieldFlags.dtsoFfSkipFilenameField Field 138 FieldFlags.dtsoFfSkipFilenameFieldPath Field 138 FieldFlags.dtsoFfXmlHideFieldNames Field 139 FieldFlags.dtsoFfXmlSkipAttributes Field 139 FileInfoFlags Class 139 FileInfoFlags.fiBinary Field 140 FileInfoFlags.fiContainer Field 140 FileInfoFlags.fiCorrupt Field 140 FileInfoFlags.fiDocumentOK Field 140 FileInfoFlags.fiEmpty Field 140 FileInfoFlags.fiEncrypted Field 140 FileInfoFlags.fiFilteredBinary Field 141 FileInfoFlags.fiImageOnly Field 141 FileInfoFlags.fiOpenFailed Field 141 FileInfoFlags.fiOutOfMemory Field 141 FileInfoFlags.fiPartiallyCorrupt Field 141 FileInfoFlags.fiPartiallyEncrypted Field 141 IndexingFlags Class 142 IndexingFlags.dtsAlwaysAdd Field 142 IndexingFlags.dtsCheckDiskSpace Field 142 xiv

15 dtsearch Text Retrieval Engine -- IndexingFlags.dtsIndexCacheOriginalFile Field 143 IndexingFlags.dtsIndexCacheText Field 143 IndexingFlags.dtsIndexCacheTextWithoutFields Field 143 IndexingFlags.dtsIndexCreateAccentSensitive Field 143 IndexingFlags.dtsIndexCreateCaseSensitive Field 143 IndexingFlags.dtsIndexCreateRelativePaths Field 144 IndexingFlags.dtsIndexCreateVersion6 Field 144 IndexingFlags.dtsIndexKeepExistingDocIds Field 144 MessageCode Class 144 MessageCode.dtsnAutoCommitBegin Field 146 MessageCode.dtsnAutoCommitDone Field 146 MessageCode.dtsnCheckForAbort Field 146 MessageCode.dtsnFirstSearchStatusMessage Field 147 MessageCode.dtsnIndexAdded Field 147 MessageCode.dtsnIndexBegin Field 147 MessageCode.dtsnIndexCheckingFiles Field 147 MessageCode.dtsnIndexCompressProgress Field 147 MessageCode.dtsnIndexCreate Field 147 MessageCode.dtsnIndexDeletedFileRemoved Field 148 MessageCode.dtsnIndexDone Field 148 MessageCode.dtsnIndexFileBinary Field 148 MessageCode.dtsnIndexFileDone Field 148 MessageCode.dtsnIndexFileEncrypted Field 148 MessageCode.dtsnIndexFileOpenFail Field 148 MessageCode.dtsnIndexFilePartiallyCorrupt Field 149 MessageCode.dtsnIndexFilePartiallyEncrypted Field 149 MessageCode.dtsnIndexFileProgress Field 149 MessageCode.dtsnIndexFolderInaccessible Field 149 MessageCode.dtsnIndexListedFileNotRemoved Field 149 MessageCode.dtsnIndexListedFileRemoved Field 149 MessageCode.dtsnIndexMergeJobProgress Field 150 MessageCode.dtsnIndexMergeProgress Field 150 MessageCode.dtsnIndexStartingFile Field 150 MessageCode.dtsnIndexStartingUpdate Field 150 MessageCode.dtsnIndexStoringWords Field 150 MessageCode.dtsnIndexToAddUpdate Field 150 MessageCode.dtsnIndexVerifyProgress Field 151 MessageCode.dtsnJobClose Field 151 MessageCode.dtsnSearchBegin Field 151 MessageCode.dtsnSearchDone Field 151 MessageCode.dtsnSearchFileCorrupt Field 151 MessageCode.dtsnSearchFileEncrypted Field 151 xv

16 dtsearch Text Retrieval Engine -- MessageCode.dtsnSearchFound Field 152 MessageCode.dtsnSearchUpdateTime Field 152 MessageCode.dtsnSearchWhere Field 152 OutputFormats Class 152 OutputFormats.it_Ansi Field 153 OutputFormats.it_ContentAsXml Field 153 OutputFormats.it_HTML Field 153 OutputFormats.it_RTF Field 153 OutputFormats.it_UnformattedHTML Field 153 OutputFormats.it_UTF8 Field 154 OutputFormats.it_XML Field 154 OutputFormats.itAnsi Field 154 OutputFormats.itContentAsXml Field 154 OutputFormats.itHTML Field 154 OutputFormats.itRTF Field 154 OutputFormats.itUnformattedHTML Field 155 OutputFormats.itUTF8 Field 155 OutputFormats.itXML Field 155 ReportFlags Class 155 ReportFlags.dtsReportByParagraph Field 156 ReportFlags.dtsReportByWord Field 156 ReportFlags.dtsReportByWordExact Field 156 ReportFlags.dtsReportGetFromCache Field 156 ReportFlags.dtsReportIncludeAll Field 156 ReportFlags.dtsReportIncludeFileStart Field 157 ReportFlags.dtsReportLimitContiguousContext Field 157 ReportFlags.dtsReportStoreInResults Field 157 ReportFlags.dtsReportWholeFile Field 157 SearchFlags Class 157 SearchFlags.dtsSearchApplyLanguageAnalyzer Field 159 SearchFlags.dtsSearchAutoTermWeight Field 159 SearchFlags.dtsSearchDelayDocInfo Field 159 SearchFlags.dtsSearchExternalSynonyms Field 159 SearchFlags.dtsSearchFastSearchFilterOnly Field 160 SearchFlags.dtsSearchFuzzy Field 160 SearchFlags.dtsSearchLanguageAnalyzerSynonyms Field 160 SearchFlags.dtsSearchNatural Field 160 SearchFlags.dtsSearchPhonic Field 160 SearchFlags.dtsSearchPositionalScoring Field 160 SearchFlags.dtsSearchSelectMostRecent Field 161 SearchFlags.dtsSearchStemming Field 161 xvi

17 dtsearch Text Retrieval Engine -- SearchFlags.dtsSearchSynonyms Field 161 SearchFlags.dtsSearchTypeAllWords Field 161 SearchFlags.dtsSearchTypeAnyWords Field 161 SearchFlags.dtsSearchUserSynonyms Field 162 SearchFlags.dtsSearchWantHitDetails Field 162 SearchFlags.dtsSearchWantHitsArray Field 162 SearchFlags.dtsSearchWantHitsByWord Field 162 SearchFlags.dtsSearchWantHitsByWordOrdinals Field 162 SearchFlags.dtsSearchWordNetRelated Field 163 SearchFlags.dtsSearchWordNetSynonyms Field 163 SortFlags Class 163 SortFlags.dtsSortAscending Field 164 SortFlags.dtsSortByDate Field 164 SortFlags.dtsSortByDocCount Field 164 SortFlags.dtsSortByField Field 165 SortFlags.dtsSortByFullName Field 165 SortFlags.dtsSortByHitCount Field 165 SortFlags.dtsSortByHits Field 165 SortFlags.dtsSortByIndex Field 165 SortFlags.dtsSortByLocation Field 165 SortFlags.dtsSortByName Field 166 SortFlags.dtsSortByRelevanceScore Field 166 SortFlags.dtsSortBySize Field 166 SortFlags.dtsSortBySortKey Field 166 SortFlags.dtsSortByTime Field 166 SortFlags.dtsSortByTitle Field 166 SortFlags.dtsSortByType Field 167 SortFlags.dtsSortByUserField Field 167 SortFlags.dtsSortByWord Field 167 SortFlags.dtsSortCaseInsensitive Field 167 SortFlags.dtsSortCleanText Field 167 SortFlags.dtsSortDescending Field 167 SortFlags.dtsSortFloatNumeric Field 168 SortFlags.dtsSortHtmlUseTitleAsName Field 168 SortFlags.dtsSortNumeric Field 168 SortFlags.dtsSortPdfUseTitleAsName Field 168 TextFlags Class 168 TextFlags.dtsoTfAutoBreakCJK Field 169 TextFlags.dtsoTfDatabasesAsText Field 169 TextFlags.dtsoTfRecognizeDates Field 170 TextFlags.dtsoTfRecognizeDatesPresumeDMY Field 170 xvii

18 dtsearch Text Retrieval Engine -- TextFlags.dtsoTfRecognizeDatesPresumeYMD Field 170 TextFlags.dtsoTfSkipNumericValues Field 170 TextFlags.dtsoTfSkipXFirstAndLast Field 170 TextFlags.dtsoTfXmlAsText Field 170 TypeId Class 171 TypeId.it_Ami Field 175 TypeId.it_Ansi Field 175 TypeId.it_Ascii Field 175 TypeId.it_ASF Field 175 TypeId.it_AVI Field 176 TypeId.it_Binary Field 176 TypeId.it_BMP Field 176 TypeId.it_CAB Field 176 TypeId.it_Cals Field 176 TypeId.it_CompoundDoc Field 176 TypeId.it_ContentAsXml Field 177 TypeId.it_CSV Field 177 TypeId.it_CsvAsDocument Field 177 TypeId.it_CsvAsReport Field 177 TypeId.it_DatabaseRecord Field 177 TypeId.it_DatabaseRecord2 Field 177 TypeId.it_DBF Field 178 TypeId.it_DocFile Field 178 TypeId.it_dtSearchIndex Field 178 TypeId.it_DWF Field 178 TypeId.it_DWG Field 178 TypeId.it_DXF Field 178 TypeId.it_ElfExecutable Field 179 TypeId.it_EMF Field 179 TypeId.it_EML Field 179 TypeId.it_EncryptedHtml Field 179 TypeId.it_EudoraMessage Field 179 TypeId.it_Excel12 Field 179 TypeId.it_Excel12xlsb Field 180 TypeId.it_Excel2 Field 180 TypeId.it_Excel2003Xml Field 180 TypeId.it_Excel3 Field 180 TypeId.it_Excel4 Field 180 TypeId.it_Excel5 Field 180 TypeId.it_Excel97 Field 181 TypeId.it_FilteredBinary Field 181 TypeId.it_FilteredBinaryUnicode Field 181 xviii

19 dtsearch Text Retrieval Engine -- TypeId.it_FilteredBinaryUnicodeStream Field 181 TypeId.it_FlashSWF Field 181 TypeId.it_GIF Field 181 TypeId.it_Gzip Field 182 TypeId.it_HTML Field 182 TypeId.it_HtmlHelp Field 182 TypeId.it_HyperText Field 182 TypeId.it_ICalendar Field 182 TypeId.it_Ichitaro Field 182 TypeId.it_Ichitaro5 Field 183 TypeId.it_IFilter Field 183 TypeId.it_iWork2009 Field 183 TypeId.it_iWork2009Keynote Field 183 TypeId.it_iWork2009Numbers Field 183 TypeId.it_iWork2009Pages Field 183 TypeId.it_JPEG Field 184 TypeId.it_JpegXR Field 184 TypeId.it_Lotus123 Field 184 TypeId.it_M4A Field 184 TypeId.it_MBoxArchive Field 184 TypeId.it_MBoxArchive2 Field 184 TypeId.it_MDI Field 185 TypeId.it_Media Field 185 TypeId.it_MicrosoftAccess Field 185 TypeId.it_MicrosoftAccess2 Field 185 TypeId.it_MicrosoftAccessAsDocument Field 185 TypeId.it_MicrosoftOfficeThemeData Field 185 TypeId.it_MicrosoftPublisher Field 186 TypeId.it_MicrosoftWord Field 186 TypeId.it_MIDI Field 186 TypeId.it_MifFile Field 186 TypeId.it_MimeContainer Field 186 TypeId.it_MimeMessage Field 186 TypeId.it_MP3 Field 187 TypeId.it_MP4 Field 187 TypeId.it_MPG Field 187 TypeId.it_MS_Word Field 187 TypeId.it_MS_Works Field 187 TypeId.it_MsWorksWps4 Field 187 TypeId.it_MsWorksWps6 Field 188 TypeId.it_Multimate Field 188 TypeId.it_NoContent Field 188 xix

20 dtsearch Text Retrieval Engine -- TypeId.it_NonTextData Field 188 TypeId.it_OleDataMso Field 188 TypeId.it_OneNote2003 Field 188 TypeId.it_OneNote2007 Field 189 TypeId.it_OneNote2010 Field 189 TypeId.it_OneNoteOnline Field 189 TypeId.it_OpenOfficeDocument Field 189 TypeId.it_OutlookExpressMessage Field 189 TypeId.it_OutlookExpressMessageStore Field 189 TypeId.it_OutlookExpressMessageStore2 Field 190 TypeId.it_OutlookMsgAsContainer Field 190 TypeId.it_OutlookMsgFile Field 190 TypeId.it_OutlookPst Field 190 TypeId.it_PDF Field 190 TypeId.it_PdfWithAttachments Field 190 TypeId.it_PfsProfessionalWrite Field 191 TypeId.it_PhotoshopImage Field 191 TypeId.it_PNG Field 191 TypeId.it_PowerPoint Field 191 TypeId.it_PowerPoint12 Field 191 TypeId.it_PowerPoint3 Field 191 TypeId.it_PowerPoint4 Field 192 TypeId.it_PowerPoint95 Field 192 TypeId.it_Properties Field 192 TypeId.it_QuattroPro Field 192 TypeId.it_QuattroPro8 Field 192 TypeId.it_QuickTime Field 192 TypeId.it_RAR Field 193 TypeId.it_RTF Field 193 TypeId.it_SASF Field 193 TypeId.it_SegmentedText Field 193 TypeId.it_SingleByteText Field 193 TypeId.it_SolidWorks Field 193 TypeId.it_TAR Field 194 TypeId.it_TIFF Field 194 TypeId.it_TNEF Field 194 TypeId.it_TreepadHjtFile Field 194 TypeId.it_TrueTypeFont Field 194 TypeId.it_UnformattedHTML Field 194 TypeId.it_Unicode Field 195 TypeId.it_Unigraphics Field 195 TypeId.it_Unigraphics2 Field 195 xx

21 dtsearch Text Retrieval Engine -- TypeId.it_Utf8 Field 195 TypeId.it_Visio Field 195 TypeId.it_Visio2013 Field 195 TypeId.it_VisioXml Field 196 TypeId.it_WAV Field 196 TypeId.it_WindowsExecutable Field 196 TypeId.it_WinWrite Field 196 TypeId.it_WMF Field 196 TypeId.it_Word12 Field 196 TypeId.it_Word2003Xml Field 197 TypeId.it_WordForDos Field 197 TypeId.it_WordForWin Field 197 TypeId.it_WordForWin6 Field 197 TypeId.it_WordForWin97 Field 197 TypeId.it_WordForWindows1 Field 197 TypeId.it_WordForWindows2 Field 198 TypeId.it_WordList Field 198 TypeId.it_WordPerfect42 Field 198 TypeId.it_WordPerfect5 Field 198 TypeId.it_WordPerfect6 Field 198 TypeId.it_WordPerfectEmbedded Field 198 TypeId.it_WordStar Field 199 TypeId.it_WS_2000 Field 199 TypeId.it_WS_5 Field 199 TypeId.it_XBase Field 199 TypeId.it_XBaseAsDocument Field 199 TypeId.it_XfaForm Field 199 TypeId.it_XML Field 200 TypeId.it_XPS Field 200 TypeId.it_XyWrite Field 200 TypeId.it_ZIP Field 200 TypeId.it_ZIP_zlib Field 200 UnicodeFilterFlags Class 200 UnicodeFilterFlags.dtsoUfAutoWordBreakByCase Field 201 UnicodeFilterFlags.dtsoUfAutoWordBreakByLength Field 201 UnicodeFilterFlags.dtsoUfAutoWordBreakOnDigit Field 202 UnicodeFilterFlags.dtsoUfAutoWordBreakOverlapWords Field 202 UnicodeFilterFlags.dtsoUfExtractAsHtml Field 202 UnicodeFilterFlags.dtsoUfFilterAllDocs Field 202 UnicodeFilterFlags.dtsoUfFilterFailedDocs Field 202 UnicodeFilterFlags.dtsoUfOverlapBlocks Field 203 xxi

22 dtsearch Text Retrieval Engine -- WordListBuilderFlags Class 203 WordListBuilderFlags.dtsWordListEnableFieldValuesCache Field 203 Index a xxii

23 1 dtsearch Text Retrieval Engine -- 1 dtsearch Engine API API The interface to the dtsearch Engine is based on the Native Interface (JNI). Therefore, both the classes and a platform-specific binary executable are needed to use it. The classes are in examples\java\classes\dtsearchengine.jar, which must be on the CLASSPATH. Adding the dtsearch Engine examples/java/classes folder to the CLASSPATH, or copying its contents to a folder on the CLASSPATH, will make these classes available in. 1 version or later is required. For general information on using the dtsearch Engine API, see the Overviews section in dtsearchapiref.chm. Windows platform (32-bit) Under 32-bit Windows, the dtsearch API requires dtsjava.dll, which in turn uses the dtsearch Engine DLL, dten600.dll. These two DLLs are installed in the dtsearch Engine bin folder. Both must be located in a folder that is listed in the PATH environment variable so the run-time can find them. Windows platform (64-bit) Under 64-bit Windows, the dtsearch API requires dtsjava.dll, which in turn uses the dtsearch Engine DLL, dtengine64.dll. These two DLLs are installed in the dtsearch Engine bin64 folder. Both must be located in a folder that is listed in the PATH environment variable so the run-time can find them. Note: Both the 32-bit and the 64-bit dtsjava.dll have the same name. The version you use must match the version you are using, so under 64-bit you should use the 64-bit version of dtsjava.dll. To ensure that the correct version is used with the version you have, set the system PATH so the correct dtsearch folder (bin64 or bin) comes first. For example, to use the 64-bit version, set up your system path with C:\Program Files\dtSearch Developer\bin64 ahead of C:\Program Files\dtSearch Developer\bin. Linux platform Under Linux, the binary executable is libdtsearch.so, which must be accessed through a symbolic link named libdtsjava.so. libdtsjava.so must be in a folder that is on the LD_LIBRARY_PATH, or you will get an "Unsatisfied Link" exception when you try to use the dtsearch Engine classes in. You can also copy the dtsearch.so files to your /usr/local/lib folder, or use ldconfig to make them accessible on your system. Samples A sample application is provided in examples\java\jdemo. To run the jdemo sample, execute the following command-line from the dtsearch Engine examples\java\classes folder: [Windows] java -cp dtsearchengine.jar;jdemo.jar jdemo.application [Linux -- use colon (:) instead of semicolon (;)] java -cp dtsearchengine.jar:jdemo.jar jdemo.application A second sample application, dsource, demonstrates use of the DataSource interface to add fields to documents being indexed. 1

24 2 dtsearch Text Retrieval Engine -- 2 com.dtsearch.engine Package 2 2

25 3.1 DataSource2 Class dtsearch Text Retrieval Engine -- 3 Interfaces The following table lists interfaces in this documentation. Classes Class DataSource2 ( see page 3) DataSource2 provides a way for data source indexing applications to obtain information about each document that is indexed, and provides better support for indexing binary data than DataSource ( see page 7). Interfaces Interface IIndexStatusHandler ( see page 5) IIndexStatusHandler provides an interface to obtain detailed information on the progress of an index update. DataSource ( see page 7) Interface for the datasourcetoindex member of IndexJob ( see page 22), for indexing non-file data sources such as databases. 3.1 DataSource2 Class File DataSource2 provides a way for data source indexing applications to obtain information about each document that is indexed, and provides better support for indexing binary data than DataSource ( see page 7). DataSource2.java 3 public abstract class DataSource2 implements com.dtsearch.engine.datasource; Methods Method getdocerror ( see page 4) getdocid ( see page 4) getdoctypeid ( see page 4) getdocwordcount ( see page 4) havedocbytes ( see page 4) setdocbytes ( see page 5) wasdocerror ( see page 5) Each time getnextdoc() is called, wasdocerror ( see page 5) will return true if there was an error processing the previous document, such as a file parsing error, and getdocerror() will return the error message. Each time getnextdoc() is called, getdocid() will return the doc id of the last document indexed. Each time getnextdoc() is called, getdoctypeid() will return an integer identifying the file type of the last document indexed Each time getnextdoc() is called, getdocwordcount() will return the number of words in the last document indexed Use setdocbytes to provide an array of bytes for dtsearch to use as the binary contents of this document. Each time getnextdoc() is called, wasdocerror() will return true if there was an error processing the previous document, such as a file parsing error, and getdocerror ( see page 4)() will return the error message. Remarks If an IndexJob.dataSourceToIndex is based on DataSource2 instead of DataSource ( see page 7), then on each call to getnextdoc, the application can call getwordcount, getdocid ( see page 4), and gettypeid to obtain information on the previously-indexed document. 3

26 3.1 DataSource2 Class dtsearch Text Retrieval Engine -- DataSource2.setDocBytes Method Additionally, the data source can return binary data (such as document files) using setdocbytes ( see page 5)() without the need to create a temporary file. Class Hierarchy DataSource2.getDocError Method Each time getnextdoc() is called, wasdocerror ( see page 5) will return true if there was an error processing the previous document, such as a file parsing error, and getdocerror() will return the error message. public String getdocerror(); DataSource2.getDocId Method Each time getnextdoc() is called, getdocid() will return the doc id of the last document indexed. public int getdocid(); A doc id can be used to identify a document in a SearchFilter ( see page 56) DataSource2.getDocTypeId Method Each time getnextdoc() is called, getdoctypeid() will return an integer identifying the file type of the last document indexed public int getdoctypeid(); DataSource2.getDocWordCount Method Each time getnextdoc() is called, getdocwordcount() will return the number of words in the last document indexed public int getdocwordcount(); DataSource2.haveDocBytes Method public boolean havedocbytes(); Returns true to tell dtsearch that the documents will be returned through setdocbytes ( see page 5) instead of as disk files. 4

27 3.2 IIndexStatusHandler Interface dtsearch Text Retrieval Engine DataSource2.setDocBytes Method Use setdocbytes to provide an array of bytes for dtsearch to use as the binary contents of this document. public void setdocbytes(byte[] data); To tell dtsearch to check for an array of bytes, the data source must return true from havedocbytes ( see page 4)(). The calling program should call setdocbytes to provide the binary contents of a file to be indexed before returning from getnextdoc(). While getdoctext() can only return a stream of plain text, setdocbytes can return any type of binary data, such as the contents of a Word document or a PDF file DataSource2.wasDocError Method Each time getnextdoc() is called, wasdocerror() will return true if there was an error processing the previous document, such as a file parsing error, and getdocerror ( see page 4)() will return the error message. public boolean wasdocerror(); 3.2 IIndexStatusHandler Interface 3 IIndexStatusHandler provides an interface to obtain detailed information on the progress of an index update. File IIndexStatusHandler.java public interface IIndexStatusHandler; Methods Method checkforabort ( see page 6) onprogressupdate ( see page 7) Called during IndexJob ( see page 22) execution to give the calling process a chance to cancel the update. Called during an index update to provide details on the status of the indexer. Remarks IIndexStatusHandler is designed for situations where it is important to have complete information, such as logging the names of documents indexed and how each file was indexed. Each time IIndexStatusHandler.onProgressUpdate ( see page 7) is called, the IndexProgressInfo.updateType will indicate the reason for the notification. The updatetype is a MessageCode ( see page 144) value that indicates when, for example, a file was successfully indexed (dtsnindexfiledone) or could not be indexed due to an error (dtsnindexfileopenfail, dtsnindexfileencrypted). To use IIndexStatusHandler, (1) Create an object that implements the IIndexStatusHandler interface, and 5

28 3.2 IIndexStatusHandler Interface dtsearch Text Retrieval Engine -- IIndexStatusHandler.checkForAbort (2) Attach it to an IndexJob ( see page 22) prior to calling execute using setstatushandler2(). Example: */ /* Demonstrates use of the IIndexStatusHandler API to monitor an IndexJob in package misc; import java.util.*; import com.dtsearch.engine.*; public class IndexStatusHandlerDemo { // private class MyIndexStatusHandler implements IIndexStatusHandler { public void onprogressupdate(indexprogressinfo prog) { if (prog.updatetype == MessageCode.dtsnIndexFileDone) System.out.println("File: " + prog.file.name + " id=" + prog.file.docid + " type=" + prog.file.type + " \n"); else if (prog.updatetype == MessageCode.dtsnIndexFileEncrypted) System.out.println("Encrypted: " + prog.file.name); else if (prog.updatetype == MessageCode.dtsnIndexFileOpenFail) System.out.println("Corrupt: " + prog.file.name + " " + prog.file.openfailmessage); } public int checkforabort() { return AbortValue.Continue; } }; public static void main(string[] args) { if (args.length == 0) { System.out.println("Usage: java IndexStatusHandler IndexPath DocPath\n"); } else { IndexStatusHandlerDemo demo = new IndexStatusHandlerDemo(args[0], args[1]); demo.run(); } } 3 } Class Hierarchy private IndexJob indexjob; private MyIndexStatusHandler statushandler; public IndexStatusHandlerDemo(String path, String toindex) { indexjob = new IndexJob(); statushandler = new MyIndexStatusHandler(); indexjob.setindexpath(path); indexjob.setfolderstoindex(toindex); indexjob.setactioncreate(true); indexjob.setactionadd(true); indexjob.setstatushandler2(statushandler); } void run() { indexjob.execute(); System.out.println("Indexing complete"); } IIndexStatusHandler.checkForAbort Method Called during IndexJob ( see page 22) execution to give the calling process a chance to cancel the update. 6

29 3.3 DataSource Interface dtsearch Text Retrieval Engine -- int checkforabort(); Returns Return AbortValue.Continue to continue the IndexJob ( see page 22), AbortValue.Cancel to stop the IndexJob ( see page 22) and save information indexed so far, and AbortValue.CancelImmediately to cancel the index update without saving any changes IIndexStatusHandler.onProgressUpdate Method Called during an index update to provide details on the status of the indexer. void onprogressupdate(com.dtsearch.engine.indexprogressinfo info); 3.3 DataSource Interface File Interface for the datasourcetoindex member of IndexJob ( see page 22), for indexing non-file data sources such as databases. DataSource.java public interface DataSource; Methods 3 Method Remarks getdoccreateddate ( see page 8) The date that the document was originally created. getdocdisplayname ( see page 8) The DocDisplayName is a user-friendly version of the filename, which the dtsearch end-user product displays in search results. getdocfields ( see page 9) getdocisfile ( see page 9) In DocFields, supply any fielded data you want the dtsearch Engine to index. If True, DocName will be interpreted as the name of a file to be indexed, and dtsearch will index the contents of the file along with any data provided in DocText and DocFields. getdocmodifieddate ( see page 9) The date that the document was last modified. getdocname ( see page 9) getdoctext ( see page 9) getnextdoc ( see page 10) rewind ( see page 10) The DocName is the name of the document, as you want it to appear in search results. In DocText, supply the text you want the dtsearch Engine to index. Get the next document from the data source. Initialize the data source so that the next GetNextDoc call will return the first document. An IndexJob ( see page 22) provides two ways specify the text you want to index: by files (the toadd* properties) and by data source (the DataSourceToIndex property). Most commonly, the text exists in disk files, in which case you would specify the files to be indexed using folder names and include and exclude filters. In some situations, however, the text to be indexed may not be readily available as disk files. The text may exist as rows in a remote SQL database or in Microsoft Exchange message stores. You could copy the text from the database to local disk files and index the local disk files, but the dtsearch Engine provides a more direct and efficient solution. To supply this text to the dtsearch indexing engine, you create 7

30 3.3 DataSource Interface dtsearch Text Retrieval Engine -- DataSource.getDocDisplayName Method an object that accesses the text and then attach the object to an IndexJob ( see page 22) using setdatasourcetoindex. A data source is an object that implements the methods in the DataSource or DataSource2 ( see page 3) interfaces (DataSource2 ( see page 3) provides some extended capabilities). Indexing The dtsearch Engine will call the getnextdoc ( see page 10) method of your DataSource implementation to obtain documents to index. On each call, dtsearch will use the properties supplied (getdocname ( see page 9), getdocmodifieddate ( see page 9), getdocfields ( see page 9)) to set up a document object to index. To index BLOB data in fields, use setdocbytes in the DataSource2 ( see page 3) interface. Field Names By default, field names are searchable along with field text. For example, if DocFields contains SampleField<TAB>Some Text, then you can find the document in a search either for "SampleField contains Text" or just "SampleField". To prevent a field name from being searchable, add * (asterisk) in front, like this: *SampleField<TAB>Some Text When a field name begins with *, only the text of the field is searchable, but not the name. Therefore, you can find the document in a search for "SampleField contains Text" but not by searching for just "SampleField". The * is not considered part of the field name for purposes of searching or designating stored fields. When a field name begins with **, the field is considered a "hidden stored" field. The contents of a hidden stored field are not searchable at all, and are automatically stored in the index as document properties when the document is indexed. Field names can include nesting. Example: Meta/Subject<TAB> This is the subject<tab>meta/author<tab> This is the author In this example, you could search across both fields by searching for "Meta contains (something)", or you could search for "Author contains (something)", or you could search for "Meta/Author contains (something)" to distinguish this "author" field from any other "author" fields that might be present in the document. 3 Related articles Database and Field Searching Class Hierarchy DataSource.getDocCreatedDate Method The date that the document was originally created. java.util.calendar getdoccreateddate(); DataSource.getDocDisplayName Method The DocDisplayName is a user-friendly version of the filename, which the dtsearch end-user product displays in search results. String getdocdisplayname(); 8

31 3.3 DataSource Interface dtsearch Text Retrieval Engine -- DataSource.getDocText Method If blank, the DocName will be used DataSource.getDocFields Method In DocFields, supply any fielded data you want the dtsearch Engine to index. String getdocfields(); DocFields consists of a series of pairs of field names and values, with tab characters (chr$(9)) between them DataSource.getDocIsFile Method If True, DocName will be interpreted as the name of a file to be indexed, and dtsearch will index the contents of the file along with any data provided in DocText and DocFields. boolean getdocisfile(); The DocModifiedDate will still be used as the modification date of the document DataSource.getDocModifiedDate Method The date that the document was last modified. java.util.calendar getdocmodifieddate(); DataSource.getDocName Method The DocName is the name of the document, as you want it to appear in search results. String getdocname(); This can be any legal Win32 filename DataSource.getDocText Method In DocText, supply the text you want the dtsearch Engine to index. 9

32 3.3 DataSource Interface dtsearch Text Retrieval Engine -- DataSource.rewind Method String getdoctext(); This must be plain text that dtsearch can index directly. If you need to index text that is in a document, you can use a FileConverter ( see page 15) to convert the document data to plain text DataSource.getNextDoc Method Get the next document from the data source. boolean getnextdoc(); The document information is stored in the properties. GetNextDoc returns true if it succeeds, false if there are no more documents DataSource.rewind Method Initialize the data source so that the next GetNextDoc call will return the first document. boolean rewind(); Returns true if it succeeds, or false if there are no documents to index. 3 10

33 4.1 ExtractionOptions Class dtsearch Text Retrieval Engine -- 4 Classes The following table lists classes in this documentation. Classes Class ExtractionOptions ( see page 11) FileConverter ( see page 15) IndexJob ( see page 22) IndexCache ( see page 36) JobErrorInfo ( see page 39) IndexFileInfo ( see page 41) Options ( see page 44) IndexInfo ( see page 53) SearchFilter ( see page 56) SearchJob ( see page 62) IndexProgressInfo ( see page 74) SearchReportJob ( see page 79) SearchResults ( see page 86) Server ( see page 97) ListIndexFlags ( see page 100) WordListBuilder ( see page 103) ListIndexJob ( see page 108) ExtractionOptions (attached to a FileConvertJob) specifies how embedded images and attachments should be handled. FileConverter converts files to HTML, RTF, or text, optionally marking hits with caller-supplied tags. The IndexJob object handles creation and updating of dtsearch indexes. An index cache keeps a pool of indexes open for faster searching After an indexing, searching, or file conversion job is executed, an IndexJob ( see page 22), SearchJob ( see page 62), or FileConverter ( see page 15) will provide a JobErrorInfo object in its Errors property. IndexFileInfo is passed with an IndexProgressInfo ( see page 74) during an index update and provides detailed information about the file being indexed. The Options object enables you to specify how the dtsearch engine will process text being indexed or searched. Get information about the current state of an index. The SearchFilter object provides a way to designate which documents can be returned by a search. The SearchJob object performs searches with or without an index. IndexProgressInfo is passed in the IIndexStatusHandler ( see page 5) interface in the onprogressupdate call and provides detailed information on the status of an IndexJob ( see page 22). Use a SearchReportJob to generate a search report from some or all of the items listed in a SearchResults ( see page 86) object. The SearchResults object provides access to the results of an in-memory search. The Server object provides access to global information and settings for the dtsearch Engine, such as the version, build number, and debug logging. Flags used in dtslistindexjob (C++) and ListIndexJob ( see page 108) (.NET, ) WordListBuilder provides a way to list words, field names, or field values in an index List words, fields, or filenames in an index to a file or to a memory buffer ExtractionOptions Class ExtractionOptions (attached to a FileConvertJob) specifies how embedded images and attachments should be handled. File ExtractionOptions.java public class ExtractionOptions; 11