FieldFlags Class

Control indexing of meta-data associated with documents

File

File: FieldFlags.java

Syntax

Java

public class FieldFlags;

Fields

Field	Description
dtsoFfGenerateMd5Hash	Generate an MD5 hash for each document indexed and append it as a field named MD5Hash. Generation of MD5 hashes is time-consuming so this will make indexing slower.
dtsoFfGenerateSha256Hash	Generate an Sha256 hash for each document indexed and append it as a field named Sha256Hash. Generation of hashes is time-consuming so this will make indexing slower.
dtsoFfHtmlIndexHeadersAsFields	Automatically generate HtmlH1, HtmlH2, etc. fields for content inside H1, H2, etc. tags, and an HtmlTitle field for content inside HTML Title tags. This replaces dtsoFfHtmlNoHeaderFields. Beginning with version 7.88, these rarely-used fields are disabled by default, so dtsoFfHtmlIndexHeadersAsFields must be set to enable them.
dtsoFfHtmlNoHeaderFields	Suppress generation of HtmlTitle, HtmlH1, etc. fields (Obsolete -- see dtsoFfHtmlIndexHeadersAsFields) These fields are now disabled by default. Set dtsoFfHtmlIndexHeadersAsFields to enable them.
dtsoFfHtmlShowComments	Make HTML Comments searchable
dtsoFfHtmlShowHiddenContent	All of the dtsoFfHtmlShow* flags
dtsoFfHtmlShowImgSrc	Make HTML IMG src= attribute searchable
dtsoFfHtmlShowLinks	Make HTML links searchable
dtsoFfHtmlShowMetatags	Make HTML meta tags searchable and visible, appended to the body of the HTML file
dtsoFfHtmlShowNoframesContent	Make content inside NOFRAMES tags searchable and visible, appended to the body of the HTML file
dtsoFfHtmlShowScripts	Make HTML Scripts searchable
dtsoFfHtmlShowStylesheets	Make HTML style sheets searchable
dtsoFfHtmlSkipImageAlt	Skip HTML IMG tag "alt" attributes,
dtsoFfHtmlSkipInputValues	Skip HTML INPUT tag "value" attributes
dtsoFfIncludeDocumentPropertiesCaption	Include a caption "Document Properties" on the table of document properties in Word, Excel, and PowerPoint 2003 documents
dtsoFfIncludeFileTypeField	Add file type field indicating the file format of the document (ex: "Microsoft Word")
dtsoFfIncludeFileTypeIdField	Add numeric type id field with the type id indicating the file format of the document
dtsoFfIndexArchiveFileLists	Index the names of files in ZIP and RAR archives
dtsoFfNormalizeEmailAddresses	Normalize email addresses in email header fields, removing extra spacing and quotation marks and moving comments to the end of the name or address portion.
dtsoFfOfficeSkipHiddenContent	Skip non-text streams in Office documents
dtsoFfPdfShowLinks	Make links in PDF files searchable
dtsoFfPdfSkipAttachments	Skip attachments in PDF files. If a PDF file has attachments, those attachments can be in any file format, so Adobe Reader cannot be used to highlight hits because it can only highlight hits in PDF data. Therefore, a PDF file with attachments must be hit-highlighted through file conversion like other document formats. Skipping PDF attachments enables PDF files with attachments to be hit-highlighted using Adobe Reader.
dtsoFfShowImageProperties	Display properties of image files embedded in documents
dtsoFfShowNtfsProperties	Make NTFS file properties searchable
dtsoFfSkipDataSourceFields	Suppress fields passed through the DataSource API through DataSource.DocFields or FileConverter.InputFields.
dtsoFfSkipDocumentProperties	Do not index or search document summary fields
dtsoFfSkipEmailHeaders	Suppress display of headers in emails.
dtsoFfSkipEmailProperties	Suppress display of email properties (subject, sender, recipient, etc.)
dtsoFfSkipFilenameField	Do not generate a field named Filename containing the name of the file.
dtsoFfSkipFilenameFieldPath	Include only the filename (not the path) in the Filename field generated at the end of each document.
dtsoFfXmlHideFieldNames	In XML, make field names not searchable
dtsoFfXmlSkipAttributes	Do not index attributes in XML files

Remarks

FieldFlags provide options to control the indexing of meta-data associated with documents. When highlighting hits, it is important to make sure that FieldFlags has the same options that were used when a document was indexed. Otherwise, hit highlighting may be incorrect due to differences in the words found in each document.

By default, dtSearch will index fields in documents such as the Summary Information fields in Word files and META tags in HTML files. FieldFlags can be used to suppress some or all of this metadata.

dtSearch will also add a "Filename" field to the end of each document, with the full path and filename of the document, so words in the document name will be searchable like other text. To suppress this completely, use dtsoFfSkipFilenameField. To include only the name of the document (not the path), use dtsoSkipFilenameFieldPath.

The dtsoFfHtmlShow* flags can be used to make normally hidden HTML elements, such as styles or links, visible and searchable. For each category of element that is enabled, a section will be added to the end of the HTML file listing the items in that category. For example, if dtsoFfHtmlShowComments is set, then each HTML file will have a list of the embedded comments after the body of the HTML.

API

C++: dtsOptions.fieldFlags

Java: Options.setFieldFlags()

.NET: Options.FieldFlags

COM: Options.FieldFlags

Class Hierarchy

com.dtsearch.engine.FieldFlags